Skip to main content

List AWS Connections​

Returns a list of AWS Connections

Query Parameters
  • limit int64

    Limits the size of the response on each page to the specified number of items.

  • start string

    Sets the page token used to browse the collection. Leave this parameter empty to get the first page. Other pages can be traversed using HATEOAS links.

  • filter string

    Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the operations that can be performed on the field:

    FieldFilter ConditionDescription
    account_native_id$begins_with, $inA prefix of the account ID to search for or the list of account IDs to return. {"account_native_id":{"$begins_with":"23345"}} {"account_native_id":{"$in":["111111111111", "222222222222"]}}
    aws_region$inLists the connections in the given regions. {"aws_region":{"$in":"["us-west-2"]"}}
    account_alias$containsA substring within the account alias (if available) to search for. {"account_alias":{"$contains":"foo"}}
    connection_type$eqA connection type to search for. Supported types are: ['discover', 'protect']. {"connection_type":{"$eq":"protect"}}
    connection_status$eq, $inThe status of the connection to the environment. Possible values include "connecting", "connected", "unlinked". For example, ?filter={"connection_status":{"$eq":"connected"}} ?filter={"connection_status":{"$in":["unlinked","connected"]}}
    organizational_unit_id$inLists the connections in the specified organizational units. {"organizational_unit_id":{"$in":["ca849d10-7ea1-4869-b2d0-46c42b5f2bea", "27b9ee09-c59c-466f-b2c4-223e9h8df7c8"]}}
    services_enabled$containsLists the connections that have the given asset_types enabled. Supported types are: ['rds', 's3', 'ebs', 'ec2mssql']. {"services_enabled":{"$contains":"rds"}}
    For more information about filtering, refer to the Filtering section of this guide.
Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • items object[]

    A collection of requested items.

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • delete-connection-aws object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • read-organizational-unit object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • account_name string

    The alias given to the account on AWS.

  • account_native_id string

    The AWS-assigned ID of the account associated with the connection.

  • aws_region string

    The AWS region associated with the connection. For example, us-east-1.

  • clumio_aws_account_id string

    AWS account ID of the Clumio control plane.

  • clumio_aws_region string

    AWS region of the Clumio control plane

  • config object

    The consolidated configuration of the Clumio Cloud Protect and Clumio Cloud Discover products for this connection. If this connection is deprecated to use unconsolidated configuration, then this field has a value of null.

  • asset_types_enabled string[]

    The asset types supported on the current version of the feature

  • dynamodb object

    DynamodbAssetInfo The installed information for the DynamoDB feature.

  • installed_template_version string

    The current version of the feature.

  • ebs object

    EbsAssetInfo The installed information for the EBS feature.

  • installed_template_version string

    The current version of the feature.

  • ec2 object

    Ec2AssetInfo The installed information for the EC2 feature.

  • installed_template_version string

    The current version of the feature.

  • ec2_mssql object

    EC2MSSQLProtectConfig The installed information for the EC2_MSSQL feature.

  • installed_template_version string

    The current version of the feature.

  • installed_template_version string

    The current version of the feature.

  • rds object

    RdsAssetInfo The installed information for the RDS feature.

  • installed_template_version string

    The current version of the feature.

  • s3 object

    S3AssetInfo The installed information for the S3 feature.

  • installed_template_version string

    The current version of the feature.

  • warm_tier_protect object

    The configuration of the Clumio Cloud Warm-Tier Protect product for this connection.

  • dynamodb object

    DynamodbAssetInfo The installed information for the DynamoDB feature.

  • installed_template_version string

    The current version of the feature.

  • installed_template_version string

    The current version of the feature.

  • connection_group_id string

    Clumio assigned ID of the associated connection group.

  • connection_management_status string

    Possible values: [managed, unmanaged]

    Management status of connection.

  • connection_status string

    Possible values: [connecting, connected, unlinked, failed-deployment]

    The status of the connection considering all the deployments made for it.

  • created_timestamp string

    The timestamp of when the connection was created.

  • data_plane_account_id string

    AWS account ID of the data plane for the connection.

  • deployment_type string

    Possible values: [group_cft, self_cft, self_tf, manual, manual_tf, none]

    The deployment method with which the currently active connection was established.

  • description string

    The user-provided description for this connection.

  • discover object

    The configuration of the Clumio Discover product for this connection. If this connection is not configured for Clumio Discover, then this field has a value of null.

  • asset_types_enabled string[]

    The asset types supported on the current version of the feature

  • installed_template_version string

    The current version of the feature.

  • external_id string

    Clumio assigned external ID of the connection or of the associated connection group.

  • id string

    The Clumio-assigned ID of the connection.

  • ingestion_status string

    Status denoting whether Ingestion has started for the connection. Valid values are "initial", "in_progress", "failed", "completed".

  • namespace string

    K8S Namespace

  • organizational_unit_id string

    The Clumio-assigned ID of the organizational unit associated with the AWS environment. If this parameter is not provided, then the value defaults to the first organizational unit assigned to the requesting user. For more information about organizational units, refer to the Organizational-Units documentation.

  • protect object

    The configuration of the Clumio Cloud Protect product for this connection. If this connection is not configured for Clumio Cloud Protect, then this field has a value of null.

  • asset_types_enabled string[]

    The asset types supported on the current version of the feature

  • ebs object

    EbsAssetInfo The installed information for the EBS feature.

  • installed_template_version string

    The current version of the feature.

  • installed_template_version string

    The current version of the feature.

  • rds object

    RdsAssetInfo The installed information for the RDS feature.

  • installed_template_version string

    The current version of the feature.

  • protect_asset_types_enabled string[]

    The asset types enabled for protect. Valid values are any of ["EC2/EBS", "RDS", "DynamoDB", "EC2MSSQL", "S3", "EBS"].

    NOTE -

    1. EC2/EBS is required for EC2MSSQL.
    2. EBS as a value is deprecated in favor of EC2/EBS.
  • resources object
  • clumio_event_pub_arn string

    SNS topic created in the account to receive relevant events.

  • clumio_iam_role_arn string

    ARN of the IAM role created in the account, which will be assumed by Clumio.

  • clumio_support_role_arn string

    ARN of the support role which will be used by the Clumio support team.

  • event_rules object
  • cloudtrail_rule_arn string

    Cloudtrail rule for the service if any.

  • cloudwatch_rule_arn string

    Cloudwatch rule for the service if any.

  • service_roles object
  • mssql object
  • ec2_instance_profile_role_arn string

    Role assumable by ec2 service.

  • ec2_ssm_instance_profile_arn string

    Instance created for ec2 instance profile role

  • ssm_notification_role_arn string

    Role assumable by ssm service.

  • s3 object
  • continuous_backups_role_arn string

    Role assumable by Event Bridge to send event notifications.

  • retired_stack_arn string

    The Amazon Resource Name of the stale CloudFormation stack when the connection was migrated to connection groups. NOTE - This has to be removed from AWS as well to delete the connection completely.

  • services_enabled string[]

    The services to be enabled for this configuration. Valid values are ["discover"], ["discover", "protect"]. This is only set when the registration is created, the enabled services are obtained directly from the installed template after that. (Deprecated as all connections will have both discover and protect enabled)

  • stack_arn string

    The Amazon Resource Name of the installed and active CloudFormation stack(if any) in AWS.

  • stack_name string

    The name given to the installed and active CloudFormation stack(if any) in AWS.

  • target_setup_status string

    Status denoting whether Target Setup has started for the connection. Valid values are "initial", "in_progress", "failed", "completed".

  • template_permission_set string
  • token string

    The 36-character Clumio AWS integration ID token used to identify the installation of the CloudFormation template on the account. This value will be pasted into the ClumioToken field when creating the CloudFormation stack.

  • _links object

    URLs to pages related to the resource.

  • _first object

    The HATEOAS link to the first page of results.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • _next object

    The HATEOAS link to the next page of results.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • create-aws-connection object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • current_count int64

    The number of items listed on the current page.

  • filter_applied string

    The filter used in the request. The filter includes both manually-specified and system-generated filters.

  • limit int64

    The maximum number of items displayed per page in the response.

  • start string

    The page token used to get this response.

Loading...