Skip to main content

Get AWS Cloud Assembly​

API to get AWS Cloud Assembly by cloud assembly ID

Path Parameters
  • accountId int64 required

    Cloud Rewind account ID.

  • projectId string required

    Cloud Rewind project ID.

  • id int64 required

    AWS cloud assembly ID.

Responses

OK

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.

    ValueDescription
    enabledThe Cloud Assembly is enabled and actively protecting resources.
    disabledThe Cloud Assembly is disabled and not protecting resources.
    delete-requestedA request has been made to delete the Cloud Assembly.
    delete-pendingThe deletion of the Cloud Assembly is pending.
    delete-lockedThe deletion of the Cloud Assembly is locked and cannot proceed.
    delete-in-progressThe deletion of the Cloud Assembly is currently in progress.
    delete-failedThe deletion of the Cloud Assembly has failed.
    deletedThe 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.

    ValueDescription
    manualAllows manual selection of specific resources.
    vpcProtects all resources within a specified VPC.
    tagsProtects 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.

    ValueDescription
    match-all-tagsMatch resources that must have all specified tags
    match-any-tagsMatch 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.

  • allowCrossAccountRecovery boolean

    Whether cross-account recovery is allowed

  • updatedAt date-time

    Timestamp indicating when the Cloud Assembly was updated

  • latestDiscoverySyncAt date-time

    Timestamp of the latest discovery synchronization

Loading...