Update Connection Group

put https://{region}.api.clumio.com/connections/aws/connection-groups/{connection_group_id}

Initiates an update to a connection group and in response returns a URL under the field "deployment_template_url". Upon successfully updating the connection group's stack with the CloudFormation template retrieved from the URL, the connection group update completes or the request is discarded.
NOTE - The lifecycle of a connection group is governed by its CloudFormation stack. If a connection group CFT is deleted from AWS, the connection group is automatically deleted. The deletion does not affect any backups taken nor any connections it managed.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

_embedded

object

Embedded responses related to the resource.

Has additional fields

_etag

string

The ETag value.

_links

object

URLs to pages related to the resource.

_self

object

The HATEOAS link to this resource.

read-organizational-unit

object

A resource-specific HATEOAS link.

account_name

string

The alias given to the associated account in AWS.

account_native_ids

array of strings

The AWS-assigned IDs of the accounts associated with the connection group.

account_native_ids

asset_types_enabled

array of strings

List of asset types connected via the connection-group. Valid values are any of ["EBS", "RDS", "DynamoDB", "EC2MSSQL", "S3"].

asset_types_enabled

aws_regions

array of strings

The AWS regions associated with the connection group.

aws_regions

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

array of strings

The asset types supported on the current version of the feature

asset_types_enabled

dynamodb

object

ebs

object

ec2_mssql

object

installed_template_version

string

The current version of the feature.

rds

object

warm_tier_protect

object

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

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, to be used while creating the AWS stack.

string

The Clumio-assigned ID of the connection group, to be used as the token while creating the AWS stack.

intended_account_native_ids

array of strings

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

intended_account_native_ids

intended_asset_types

array of strings

THe asset types to be connected via a connection group.

intended_asset_types

intended_aws_regions

array of strings

The AWS regions to be connected with a connection group.

intended_aws_regions

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

Ongoing operation of the deployed and active connection group stack.

["creating_stack" "updating_stack" "deleting_stack" "no_active_operation"].

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

The status of the connection group based on the stack in the associated AWS account.

["connecting" "fully_connected" "partially_connected" "deployment_failed" "connected_with_no_managed_stacks" "unlinked"].

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://us-west-2.api.clumio.com/connections/aws/connection-groups/connection_group_id \
3
     --header 'accept: application/api.clumio.aws-connection-groups=v1+json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
74
}
1
{
2
  "_embedded": {},
3
  "_etag": "string",
4
  "_links": {
5
    "_self": {
6
      "href": "string",
7
      "templated": true,
8
      "type": "string"
9
    },
10
    "read-organizational-unit": {
11
      "href": "string",
12
      "templated": true,
13
      "type": "string"
14
    }
15
  },
16
  "account_name": "string",
17
  "account_native_ids": [
18
    "string"
19
  ],
20
  "asset_types_enabled": [
21
    "string"
22
  ],
23
  "aws_regions": [
24
    "string"
25
  ],

200200 HTTP success response

defaultError