Create AWS cloud assembly

API to create AWS cloud assembly

Path Parameters

accountId int64 required
Cloud Rewind account ID.
projectId string required
Cloud Rewind project ID.

application/json

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 Assembly.
Constraints: It must begin with a letter and may include only letters, numbers, and hyphens.
description string
Possible values: <= 1000
Description of the AWS Cloud Assembly.
cloudConnectionId int64 required
Id of the AWS Cloud connection.
resourceFilterStrategy object required
Defines how AWS resources are filtered within the Cloud Assembly.
filterType string required
Possible values: [manual, vpc, tags]
Filter type used to select AWS resources within the assembly.

Value Description
manual Allows manual selection of specific resources.
vpc Protects all resources within a specified VPC.
tags Protects resources based on specified tags.
tags object[]
List of tags used to filter resources in the Cloud Assembly for tags based resource filtering.
key string
Key of the tag
value string
Value of the tag
conditions string
Possible values: [match-all-tags, match-any-tags]
Condition to apply between the resource tags for tags based resource filtering.

Value Description
match-all-tags Match resources that must have all specified tags
match-any-tags Match resources that have any of the specified tags
resources string[]
List of cloud resource IDs used to filter resources in the Cloud Assembly for manual based resource filtering.
sourceRegion 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]
Source region for the Cloud Assembly used to protect cloud resources.
replicaRegions string[]
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]
List of replica regions to replicate cloud resources.
allowCrossRegionRecovery boolean
Whether cross-region recovery is allowed.
allowCrossAccountRecovery boolean
Whether cross-account recovery is allowed.
vpcId string required
Specify the VPC ID that contains the resources to be protected. This ensures the protection operations are scoped to the correct network environment.
policyTemplateId int64 required
Id of the policy template
policyActivation string required
Possible values: [immediate, by-policy]
Activation option for the protection policy.

Value Description
immediate Once the policy is created, it is activated immediately and triggers one protection run right away.
by-policy The scheduled policy triggers at the specified date and time.
protectionStrategy string required
Possible values: [snapshot, metadata]
Protection strategy for AWS resources for Cloud Assembly.

Value Description
snapshot Protects resource configurations and data backup.
metadata Protects only the resource configurations.
protectionStrategyOptions object
Protection strategy options for cloud resources in the cloud assembly.
awsLambdaProtectionOptions object
Protection options for AWS Lambda
sourceBucketName string
The name of the source bucket. Ensure that the bucket configured for Lambda protection has versioning enabled.
replicaRegionBucketDetails object[]
Details of the replica region buckets
cloudConnectionId int64
The ID of the cloud connection
name string
The name of the replication bucket. Ensure that the bucket configured for Lambda protection has versioning enabled.
region string
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]
The region of the replication bucket
isEnabled boolean
Indicates if Lambda protection is enabled or not
awsRoute53ProtectionOptions object
Protection options for AWS Route 53
route53HostedZoneCloudConnectionId int64
The ID of the Route53 enabled cloud connection
isEnabled boolean
Indicates if Route53 protection is enabled or not
awsSqsProtectionOptions object
Protection options for AWS SQS
isEnabled boolean
Indicates if resource protection is enabled or not
awsSnsProtectionOptions object
Protection options for AWS SNS
isEnabled boolean
Indicates if resource protection is enabled or not
awsDynamoDBProtectionOptions object
Protection options for AWS DynamoDB
isEnabled boolean
Indicates if resource protection is enabled or not

Value	Description
manual	Allows manual selection of specific resources.
vpc	Protects all resources within a specified VPC.
tags	Protects resources based on specified tags.

Value	Description
match-all-tags	Match resources that must have all specified tags
match-any-tags	Match resources that have any of the specified tags

Value	Description
immediate	Once the policy is created, it is activated immediately and triggers one protection run right away.
by-policy	The scheduled policy triggers at the specified date and time.

Value	Description
snapshot	Protects resource configurations and data backup.
metadata	Protects only the resource configurations.

Responses

Created

application/json

Schema
Example (from schema)

Schema

accountId int64
Cloud Rewind account ID.
projectId string
Cloud Rewind project ID.
id int64
ID of the AWS cloud assembly.
name string
Name of the AWS Cloud Assembly.
description string
Description of the AWS Cloud Assembly.
cloudConnectionId int64
Id of the AWS Cloud connection.

status string

Possible values: [enabled, disabled, delete-requested, delete-pending, delete-locked, delete-in-progress, delete-failed, deleted]

Status of the Cloud Assembly.

Value	Description
enabled	The Cloud Assembly is enabled and actively protecting resources.
disabled	The Cloud Assembly is disabled and not protecting resources.
delete-requested	A request has been made to delete the Cloud Assembly.
delete-pending	The deletion of the Cloud Assembly is pending.
delete-locked	The deletion of the Cloud Assembly is locked and cannot proceed.
delete-in-progress	The deletion of the Cloud Assembly is currently in progress.
delete-failed	The deletion of the Cloud Assembly has failed.
deleted	The Cloud Assembly has been successfully deleted.

sourceRegion string
Source region for the Cloud Assembly used to protect cloud resources.
allowCrossRegionRecovery boolean
Whether cross-region recovery is allowed.
replicaRegions string[]
List of replica regions to replicate cloud resources.
vpcId string
The AWS VPC ID for the protected resources in this assembly.
protectionStrategy string
Protection strategy for the cloud resources in the cloud assembly.
protectionStrategyOptions object
Protection strategy options for cloud resources in the cloud assembly.
awsLambdaProtectionOptions object
Protection options for AWS Lambda
sourceBucketName string
The name of the source bucket.
isEnabled boolean
Indicates if Lambda protection is enabled or not
replicaRegionBucketDetails object[]
Details of the replica region buckets
cloudConnectionId int64
The ID of the cloud connection
name string
The name of the replication bucket.
region string
The region of the replication bucket
awsRoute53ProtectionOptions object
Protection options for AWS Route 53
isEnabled boolean
Indicates whether Route 53 protection strategy is enabled
route53HostedZoneCloudConnectionId int64
The ID of the Route53 enabled cloud connection
awsSqsProtectionOptions object
Protection options for AWS SQS
isEnabled boolean
Indicates if resource protection is enabled or not
awsSnsProtectionOptions object
Protection options for AWS SNS
isEnabled boolean
Indicates if resource protection is enabled or not
awsDynamoDBProtectionOptions object
Protection options for AWS DynamoDB
isEnabled boolean
Indicates if resource protection is enabled or not
resourceFilterStrategy object
Defines how AWS resources are filtered within the Cloud Assembly.
filterType string
Possible values: [manual, vpc, tags]
Filter type used to select AWS resources within the assembly.

Value Description
manual Allows manual selection of specific resources.
vpc Protects all resources within a specified VPC.
tags Protects resources based on specified tags.
tags object[]
List of tags used to filter resources in the Cloud Assembly for tags based resource filtering.
key string
Key of the tag
value string
Value of the tag
conditions string
Possible values: [match-all-tags, match-any-tags]
Condition to apply between the resource tags for tags based resource filtering.

Value Description
match-all-tags Match resources that must have all specified tags
match-any-tags Match resources that have any of the specified tags
resources string[]
List of cloud resource IDs used to filter resources in the Cloud Assembly for manual based resource filtering.
createdAt date-time
The time when the Cloud Assembly was created.

Value	Description
manual	Allows manual selection of specific resources.
vpc	Protects all resources within a specified VPC.
tags	Protects resources based on specified tags.

Value	Description
match-all-tags	Match resources that must have all specified tags
match-any-tags	Match resources that have any of the specified tags

{
  "accountId": 0,
  "projectId": "string",
  "id": 0,
  "name": "string",
  "description": "string",
  "cloudConnectionId": 0,
  "status": "enabled",
  "sourceRegion": "string",
  "allowCrossRegionRecovery": true,
  "replicaRegions": [
    "string"
  ],
  "vpcId": "string",
  "protectionStrategy": "string",
  "protectionStrategyOptions": {
    "awsLambdaProtectionOptions": {
      "sourceBucketName": "string",
      "isEnabled": true,
      "replicaRegionBucketDetails": [
        {
          "cloudConnectionId": 0,
          "name": "string",
          "region": "string"
        }
      ]
    },
    "awsRoute53ProtectionOptions": {
      "isEnabled": true,
      "route53HostedZoneCloudConnectionId": 0
    },
    "awsSqsProtectionOptions": {
      "isEnabled": true
    },
    "awsSnsProtectionOptions": {
      "isEnabled": true
    },
    "awsDynamoDBProtectionOptions": {
      "isEnabled": true
    }
  },
  "resourceFilterStrategy": {
    "filterType": "manual",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "conditions": "match-all-tags",
    "resources": [
      "string"
    ]
  },
  "createdAt": "2025-08-28"
}

Unauthorized

Schema
Example (from schema)

Schema

errors object[]
code string
message string
type string
fieldErrors object
property name* string
message string
requiredPermissions string[]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "fieldErrors": {},
  "message": "string",
  "requiredPermissions": [
    "string"
  ]
}

Forbidden

Schema
Example (from schema)

Schema

errors object[]
code string
message string
type string
fieldErrors object
property name* string
message string
requiredPermissions string[]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "fieldErrors": {},
  "message": "string",
  "requiredPermissions": [
    "string"
  ]
}

Not Found

Schema
Example (from schema)

Schema

errors object[]
code string
message string
type string
fieldErrors object
property name* string
message string
requiredPermissions string[]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "fieldErrors": {},
  "message": "string",
  "requiredPermissions": [
    "string"
  ]
}

Conflict

Schema
Example (from schema)

Schema

errors object[]
code string
message string
type string
fieldErrors object
property name* string
message string
requiredPermissions string[]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "fieldErrors": {},
  "message": "string",
  "requiredPermissions": [
    "string"
  ]
}

Precondition Failed

Schema
Example (from schema)

Schema

errors object[]
code string
message string
type string
fieldErrors object
property name* string
message string
requiredPermissions string[]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "fieldErrors": {},
  "message": "string",
  "requiredPermissions": [
    "string"
  ]
}

Internal Server Error

Schema
Example (from schema)

Schema

errors object[]
code string
message string
type string
fieldErrors object
property name* string
message string
requiredPermissions string[]

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "fieldErrors": {},
  "message": "string",
  "requiredPermissions": [
    "string"
  ]
}

Create AWS cloud assembly​

Create AWS cloud assembly