Skip to main content

Create Connection Group​

Initiates a new connection group request, and in response returns a URL under field "deployment_template_url". Upon successfully deploying the cloudformation template retrieved from the URL in the AWS account, the connection-group is created or the request is discarded.


NOTE - The lifecycle of a connection-group is governed by its CloudFormation stack. If the CFT for a connection-group is deleted from AWS, the connection-group is automatically deleted. The deletion does not affect any backups taken nor any connections it managed.
Request Body

The body of the request.

  • account_native_id string required

    The AWS-assigned ID of the account to be associated with the Connection Group.

  • asset_types string[] required

    The asset types to be connected via the connection-group. 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.
  • asset_types_enabled string[]

    DEPRECATED, use "asset_types" instead.

    The asset types to be connected via the connection-group. 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.
  • aws_regions string[] required

    The AWS regions to be associated with the Connection Group.

  • description string

    Description for this connection group.

  • master_aws_account_id string required

    The AWS Account that manages the connection-group's stack. If the provided master_aws_account_id different than the account_native_id then use service managed permissions while deploying stack.

  • master_region string required

    The AWS Region that manages the connection-group's stack.

  • 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.

Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • _etag string

    The ETag value.

  • _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.

  • 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 associated account in AWS.

  • account_native_ids string[]

    The AWS-assigned IDs of the accounts associated with the Connection Group.

  • asset_types_enabled string[]

    List of asset types connected via the connection-group. 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.
  • aws_regions string[]

    The AWS regions associated with the with the Connection Group.

  • 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.

  • created_timestamp string

    The timestamp of when the connection was created.

  • deployment_template_url string

    Clumio's S3 URL that contains the template to create the required resources in the given account(s) according to the request.

  • description string

    User-provided description for this connection group.

  • external_id string

    Clumio assigned external ID for the connection group, should be used while creating the AWS stack.

  • id string

    The Clumio-assigned ID of the Connection Group, should be used as the token while creating the stack in AWS.

  • intended_account_native_ids string[]

    The AWS Account IDs that are intended to be associated with the Connection Group.

  • intended_asset_types string[]

    THe asset types that are intended to be connected via connection-group.

  • intended_aws_regions string[]

    The AWS regions that are intended to be connected with the Connection Group.

  • master_aws_account_id string

    The master account which manages the connection-group's stack.

  • master_region string

    The master region which manages the connection-group's stack.

  • ongoing_stack_operation string

    Possible values: [creating_stack, updating_stack, deleting_stack, no_active_operation]

    Ongoing Operation of the deployed and active stack of ConnectionGroup.

  • 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.

  • stack_arn string

    The Amazon Resource Name of the installed CloudFormation stack in AWS.

  • stack_name string

    The name given to the installed CloudFormation stack in AWS.

  • status string

    Possible values: [connecting, fully_connected, partially_connected, deployment_failed, connected_with_no_managed_stacks, unlinked]

    The status of the Connection Group based on the stack in associated AWS account.

POST /connections/aws/connection-groups

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
Body
{

  "account_native_id": "string",

  "asset_types": [

    "string"

  ],

  "asset_types_enabled": [

    "string"

  ],

  "aws_regions": [

    "string"

  ],

  "description": "string",

  "master_aws_account_id": "string",

  "master_region": "string",

  "organizational_unit_id": "string"

}

curl -L -X POST 'https://us-west-2.api.clumio.com/connections/aws/connection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-connection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "account_native_id": "string",
  "asset_types": [
    "string"
  ],
  "asset_types_enabled": [
    "string"
  ],
  "aws_regions": [
    "string"
  ],
  "description": "string",
  "master_aws_account_id": "string",
  "master_region": "string",
  "organizational_unit_id": "string"
}'