Skip to main content

Create AWS cloud connection​

API to create AWS cloud connection

Path Parameters
  • accountId int64 required

    Cloud Rewind account ID.

  • projectId string required

    Cloud Rewind project ID.

Request Body required
  • name string required

    Possible values: >= 3 and <= 50, Value must match regular expression ^[a-zA-Z][a-zA-Z0-9-]*$

    Name of the cloud connection.
    Constraints: It must begin with a letter and may include only letters, numbers, and hyphens.

  • description string

    Possible values: <= 1000

    Description of the cloud connection.

  • operationalRegions string[] required

    Possible values: [us-east-1, us-east-2, us-west-1, us-west-2, ap-south-1, ap-south-2, ap-northeast-3, ap-northeast-2, ap-northeast-1, ap-southeast-1, ap-southeast-2, ap-southeast-3, ca-central-1, eu-central-1, eu-central-2, eu-west-1, eu-west-2, eu-west-3, eu-north-1, sa-east-1, af-south-1, ap-east-1, eu-south-1, eu-south-2, me-central-1, me-south-1, il-central-1]

    Allows discovery, protection, and recovery operations in the specified AWS regions.

  • awsIamRoleArn string required

    Possible values: Value must match regular expression ^arn:aws:iam::[0-9]+:role/[a-zA-Z0-9+=,.@_-]{1,64}$

    The ARN of the AWS IAM role that grants permissions for the cloud connection.
    Example: arn:aws:iam::123456789012:role/MyExample-Role_1

  • cloudFormationStackName string

    Possible values: Value must match regular expression ^[a-zA-Z][a-zA-Z0-9-]{0,127}$

    The name of the CloudFormation stack that was deployed using the Download AWS CloudFormation Template API, which provisioned the AWS IAM role with Cloud Rewind permissions required to create the AWS Cloud Connection.
    Provide this value to update the latest Cloud Rewind permissions using the same CloudFormation stack. Or else, Cloud Rewind permissions must be managed and updated manually.
    Example: CloudRewind-IamRole-Stack

Responses

Created

Schema
  • accountId int64

    Cloud Rewind account ID.

  • projectId string

    Cloud Rewind project ID.

  • id int64

    The unique identifier for the created cloud connection.

  • name string

    The name of the cloud connection.

  • operationalRegions string[]

    Grants the role permission to perform discovery, protection, and recovery operations in the specified AWS regions.

  • services string[]

    Grants the role permission to perform discovery, protection, and recovery operations in the specified AWS services.

  • createdAt date-time

    The time when the Cloud connection was created.

Loading...