Amazon Route 53 Application Recovery Controller Recovery Readiness API Reference Guide

(1)

Amazon Route 53 Application Recovery Controller

Recovery Readiness API Reference Guide

(2)

Amazon Route 53 Application Recovery Controller: Recovery Readiness API Reference Guide

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

What is recovery readiness in Amazon Route 53 Application Recovery Controller?

Welcome to the Recovery Readiness API Reference Guide for Amazon Route 53 Application Recovery Controller.

Recovery Readiness API actions support the readiness check feature of Route 53 ARC. This API Reference Guide provides information about the API actions that you use to model your application with Route 53 ARC. Next, you add readiness checks so that you can ensure that your application is always properly scaled and conﬁgured to handle failover traﬃc.

To set up recovery readiness in Route 53 ARC, you model your application with structures that enable Route 53 ARC to continually inspect your application resources and routing policies to make sure that your application's redundant failure-containment units, or replicas, are always ready for failover.

The ﬁrst step is to create a recovery group that represents your application. Each recovery group includes cells for each individual failure-containment unit or replica of your application – for example, for each Regional or zonal version of the application. Then you create resource sets for each resource type and associate readiness checks with them. Finally, you associate the resources with the cells in your recovery group so that you can check the readiness status of your individual replicas.

With recovery groups and readiness checks, you can monitor the readiness status for each replica of your application—for example, in different AWS Regions—to determine how ready your application is to fail over from one replica to another. You can also monitor readiness details for resources at different levels and in different ways, such as checking the readiness of each type of resource. Or, you can view the readiness status of a resource in a specific cell (Availability Zone or Region).

By adding readiness checks, you can monitor the readiness status of your application and resources, for example, by using API calls. In addition, creating readiness checks enables Route 53 ARC to take some corrective actions for you, to help make sure that your application and resources are ready for you to quickly reroute traﬃc to a failover application replica, if needed. After you create resource sets and set up readiness checks, Route 53 ARC continually (once every minute) runs readiness checks on your resources. These checks inspect your resources to ensure that your provisioned capacities match, across all resource sets, and where possible, Route 53 ARC takes corrective action. For more information, see the Amazon Route 53 Application Recovery Controller Developer Guide.

After you create readiness checks, you can monitor and manage recovery readiness. You can also set up cross-account authorization in Route 53 ARC to make it easier to set up and monitor distributed resources from one AWS account.

Route 53 ARC is a global service that supports endpoints in multiple AWS Regions but you must specify the US West (Oregon) Region when you work with readiness and recovery control conﬁguration resources, for example, to create readiness checks or routing controls.

For more information about Route 53 ARC, see the following:

• For more information about creating resilient applications and preparing for recovery readiness with Route 53 ARC, see the Amazon Route 53 Application Recovery Controller Developer Guide.

• For more information setting up routing control in Route 53 ARC to route around failures, see the Recovery Control Conﬁguration API Reference Guide for Amazon Route 53 Application Recovery

(7)

Controller and the Routing Control API Reference Guide for Amazon Route 53 Application Recovery Controller.

(8)

DeleteCrossAccountAuthorization

Resources

The Amazon Route 53 Application Recovery Controller REST API includes the following resources.

Topics

• DeleteCrossAccountAuthorization (p. 3)

• GetArchitectureRecommendations (p. 5)

• GetCell, UpdateCell, DeleteCell (p. 8)

• GetCellReadinessSummary (p. 13)

• GetReadinessCheck, UpdateReadinessCheck, DeleteReadinessCheck (p. 17)

• GetReadinessCheckResourceStatus (p. 22)

• GetReadinessCheckStatus (p. 26)

• GetRecoveryGroup, UpdateRecoveryGroup, DeleteRecoveryGroup (p. 30)

• GetRecoveryGroupReadinessSummary (p. 36)

• GetResourceSet, UpdateResourceSet, DeleteResourceSet (p. 39)

• ListCells, CreateCell (p. 47)

• ListCrossAccountAuthorizations, CreateCrossAccountAuthorization (p. 53)

• ListReadinessChecks, CreateReadinessCheck (p. 56)

• ListRecoveryGroups, CreateRecoveryGroup (p. 61)

• ListResourceSets, CreateResourceSet (p. 66)

• ListRules (p. 75)

• ListTagsForResources, TagResource, UntagResource (p. 78)

DeleteCrossAccountAuthorization

URI

/crossaccountauthorizations/crossAccountAuthorization

HTTP methods

DELETE

Operation ID: DeleteCrossAccountAuthorization Deletes cross account readiness authorization.

Path parameters

Name Type Required Description

crossAccountAuthorizationString True The cross-account authorization.

(9)

Schemas

Responses

Status code Response model Description

200 DeleteCrossAccountAuthorizationResult (p. 4)200 response - Success.

400 None 400 response - Multiple causes.

For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly.

403 None 403 response - Access denied

exception. You do not have suﬃcient access to perform this action.

429 None 429 response - Limit exceeded

exception or too many requests exception.

500 None 500 response - Internal service

error or temporary service error.

Retry the request.

OPTIONS

Enables CORS by returning correct headers.

Path parameters

crossAccountAuthorizationString True The cross-account authorization.

Responses

200 None 200 response - Success.

Schemas

Response bodies

DeleteCrossAccountAuthorizationResult schema

{}

(10)

Properties

DeleteCrossAccountAuthorizationResult

A successful DeleteCrossAccountAuthorization request returns no response.

DeleteCrossAccountAuthorization

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

GetArchitectureRecommendations

URI

/recoverygroups/recoveryGroupName/architectureRecommendations

HTTP methods

GET

Operation ID: GetArchitectureRecommendations

Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group.

Path parameters

recoveryGroupName String True The name of a recovery group.

Query parameters

nextToken String False The token that

identiﬁes which batch

(11)

HTTP methods

of results you want to see.

maxResults String False The number of objects

that you want to return with this call.

Responses

200 GetArchitectureRecommendationsOutput (p. 7)200 response - Success.

404 None 404 response - Malformed query

string. The query string contains a syntax error or resource not found.

Retry the request.

OPTIONS

Path parameters

Responses

(12)

Schemas

Response bodies

GetArchitectureRecommendationsOutput schema

{ "lastAuditTimestamp": "string", "nextToken": "string",

"recommendations": [ {

"recommendationText": "string"

} ] }

Properties

GetArchitectureRecommendationsOutput

Result from GetArchitectureRecommendations call.

lastAuditTimestamp

The time that a recovery group was last assessed for recommendations, in UTC ISO-8601 format.

Type: string Required: True

nextToken

The token that identiﬁes which batch of results you want to see.

Type: string Required: False

recommendations

A list of the recommendations for the customer's application.

Type: Array of type Recommendation (p. 7) Required: True

Recommendation

Recommendations that are provided to make an application more recovery resilient.

recommendationText

Text of the recommendations that are provided to make an application more recovery resilient.

Type: string

(13)

GetArchitectureRecommendations

• AWS SDK for C++

• AWS SDK for Go

GetCell, UpdateCell, DeleteCell

URI

/cells/cellName

HTTP methods

GET

Operation ID: GetCell

Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.

Path parameters

cellName String True The name of the cell.

Responses

200 CellOutput (p. 11) 200 response - Success.

For example, you might have a malformed query string, an input parameter might be out of

(14)

HTTP methods

range, or you used parameters together incorrectly.

Retry the request.

PUT

Operation ID: UpdateCell

Updates a cell to replace the list of nested cells with a new list of nested cells.

Path parameters

Responses

(15)

HTTP methods

Retry the request.

DELETE

Operation ID: DeleteCell

Delete a cell. When successful, the response code is 204, with no response body.

Path parameters

Responses

204 None 204 response - Successful

deletion

Retry the request.

(16)

Schemas

OPTIONS

Enable CORS by returning correct headers.

Path parameters

Responses

Schemas

Request bodies

PUT schema

{ "cells": [ "string"

] }

Response bodies

CellOutput schema

], "parentReadinessScopes": [ "string"

], "cellName": "string", "cellArn": "string", "tags": {

}}

Properties

CellOutput

Information about a cell.

cells

A list of cell ARNs.

(17)

Properties Type: Array of type string

Required: True

parentReadinessScopes

The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.

Type: Array of type string Required: True

cellName

The name of the cell.

Pattern: \A[a-zA-Z0-9_]+\z MaxLength: 64

cellArn

The Amazon Resource Name (ARN) for the cell.

Type: string Required: True MaxLength: 256

tags

Tags on the resources.

Type: Tags (p. 12) Required: False

CellUpdateParameters

Parameters used to update a cell.

cells

A list of cell Amazon Resource Names (ARNs), which completely replaces the previous list.

Tags

A collection of tags associated with a resource.

key-value pairs

Type: string

(18)

See also

GetCell

• AWS SDK for C++

• AWS SDK for Go

UpdateCell

• AWS SDK for C++

• AWS SDK for Go

DeleteCell

• AWS SDK for C++

• AWS SDK for Go

GetCellReadinessSummary

URI

/cellreadiness/cellName

(19)

HTTP methods

GET

Operation ID: GetCellReadinessSummary

Gets readiness for a cell. Aggregates the readiness of all the resources that are associated with the cell into a single value.

Path parameters

Query parameters

identiﬁes which batch of results you want to see.

Responses

200 GetCellReadinessSummaryOutput (p. 15)200 response - Success.

(20)

Schemas

Retry the request.

OPTIONS

Enable CORS by returning correct headers.

Path parameters

Responses

Schemas

Response bodies

GetCellReadinessSummaryOutput schema

{ "nextToken": "string", "readiness": enum, "readinessChecks": [ {

"readinessCheckName": "string", "readiness": enum

} ] }

Properties

GetCellReadinessSummaryOutput

Result of a GetReadinessCellSummary operation

nextToken

(21)

See also

readiness

The readiness at a cell level.

Type: Readiness (p. 16) Required: True

readinessChecks

Summaries for the readiness checks that make up the cell.

Type: Array of type ReadinessCheckSummary (p. 16) Required: True

Readiness

The readiness status.

READY NOT_READY UNKNOWN

NOT_AUTHORIZED

ReadinessCheckSummary

Summary of all readiness check statuses in a recovery group, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary.

readinessCheckName

The name of a readiness check.

readiness

The readiness status of this readiness check.

Type: Readiness (p. 16) Required: False

GetCellReadinessSummary

• AWS SDK for C++

(22)

GetReadinessCheck, UpdateReadinessCheck, DeleteReadinessCheck

• AWS SDK for Go

GetReadinessCheck, UpdateReadinessCheck, DeleteReadinessCheck

URI

/readinesschecks/readinessCheckName

HTTP methods

GET

Operation ID: GetReadinessCheck Gets details about a readiness check.

Path parameters

readinessCheckName String True Name of a readiness check.

Responses

200 ReadinessCheckOutput (p. 20)200 response - Success.

(23)

HTTP methods

Retry the request.

PUT

Operation ID: UpdateReadinessCheck Updates a readiness check.

Path parameters

Responses

200 ReadinessCheckOutput (p. 20)200 response - Success.

Retry the request.

(24)

HTTP methods

DELETE

Operation ID: DeleteReadinessCheck Deletes a readiness check.

Path parameters

Responses

deletion

Retry the request.

OPTIONS

Path parameters

(25)

Schemas

Responses

Schemas

Request bodies

PUT schema

{ "resourceSetName": "string"

}

Response bodies

ReadinessCheckOutput schema

{ "resourceSet": "string", "readinessCheckName": "string", "readinessCheckArn": "string", "tags": {

}}

Properties

ReadinessCheckOutput

A readiness check.

resourceSet

Name of the resource set to be checked.

readinessCheckName

Name of a readiness check.

(26)

See also

readinessCheckArn

The Amazon Resource Name (ARN) associated with a readiness check.

tags

ReadinessCheckUpdateParameters

Parameter used to create or update a readiness check.

resourceSetName

The name of the resource set to be checked.

Tags

key-value pairs

Type: string

GetReadinessCheck

• AWS SDK for C++

• AWS SDK for Go

(27)

GetReadinessCheckResourceStatus

UpdateReadinessCheck

• AWS SDK for C++

• AWS SDK for Go

DeleteReadinessCheck

• AWS SDK for C++

• AWS SDK for Go

GetReadinessCheckResourceStatus

URI

/readinesschecks/readinessCheckName/resource/resourceIdentifier/status

HTTP methods

GET

Operation ID: GetReadinessCheckResourceStatus

Gets individual readiness status for a readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in the recovery group, use GetRecoveryGroupReadinessSummary.

Path parameters

(28)

HTTP methods

resourceIdentifier String True The resource identiﬁer, which is the Amazon Resource Name (ARN) or the identiﬁer generated for the resource by Application Recovery Controller (for example, for a DNS target resource).

Query parameters

Responses

200 GetReadinessCheckResourceStatusOutput (p. 24)200 response - Success.

Retry the request.

(29)

Schemas

OPTIONS

Path parameters

resourceIdentifier String True The resource identiﬁer, which is the Amazon Resource Name (ARN) or the identiﬁer generated for the resource by Application Recovery Controller (for example, for a DNS target resource).

Responses

Schemas

Response bodies

GetReadinessCheckResourceStatusOutput schema

{ "nextToken": "string", "readiness": enum, "rules": [

{

"readiness": enum, "messages": [ {

"messageText": "string"

} ],

"lastCheckedTimestamp": "string", "ruleId": "string"

} ]}

Properties

GetReadinessCheckResourceStatusOutput

Result of a GetReadinessCheckResourceStatus operation.

(30)

Properties

nextToken

readiness

The readiness at a rule level.

rules

Details of the rule's results.

Type: Array of type RuleResult (p. 25) Required: True

Message

Information relating to readiness check status.

messageText

The text of a readiness check message.

Readiness

NOT_AUTHORIZED

RuleResult

The result of a successful Rule request, with status for an individual rule.

readiness

The readiness at rule level.

messages

Details about the resource's readiness.

(31)

See also Type: Array of type Message (p. 25)

Required: True

lastCheckedTimestamp

The time the resource was last checked for readiness, in ISO-8601 format, UTC.

ruleId

The identiﬁer of the rule.

GetReadinessCheckResourceStatus

• AWS SDK for C++

• AWS SDK for Go

GetReadinessCheckStatus

URI

/readinesschecks/readinessCheckName/status

HTTP methods

GET

Operation ID: GetReadinessCheckStatus

Gets the readiness status for an individual readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in a recovery group, use GetRecoveryGroupReadinessSummary.

(32)

HTTP methods

Path parameters

Query parameters

Responses

200 GetReadinessCheckStatusOutput (p. 28)200 response - Success.

Retry the request.

OPTIONS

(33)

Schemas

Path parameters

Responses

Schemas

Response bodies

GetReadinessCheckStatusOutput schema

{ "nextToken": "string", "readiness": enum, "messages": [ {

"messageText": "string"

} ],

"resources": [ {

"componentId": "string", "readiness": enum, "resourceArn": "string",

"lastCheckedTimestamp": "string"

} ]}

Properties

GetReadinessCheckStatusOutput

Result of a GetReadinessCheckStatus operation.

nextToken

readiness

The readiness at rule level.

Type: Readiness (p. 29)

(34)

Properties Required: True

messages

Top level messages for readiness check status Type: Array of type Message (p. 29) Required: True

resources

Summary of the readiness of resources.

Type: Array of type ResourceResult (p. 29) Required: True

Message

Information relating to readiness check status.

messageText

The text of a readiness check message.

Readiness

NOT_AUTHORIZED

ResourceResult

The result of a successful Resource request, with status for an individual resource.

componentId

The component id of the resource.

readiness

The readiness of a resource.

Type: Readiness (p. 29)

(35)

resourceArn

The Amazon Resource Name (ARN) of the resource.

lastCheckedTimestamp

The time (UTC) that the resource was last checked for readiness, in ISO-8601 format.

GetReadinessCheckStatus

• AWS SDK for C++

• AWS SDK for Go

GetRecoveryGroup, UpdateRecoveryGroup, DeleteRecoveryGroup

URI

/recoverygroups/recoveryGroupName

HTTP methods

GET

Operation ID: GetRecoveryGroup

Gets details about a recovery group, including a list of the cells that are included in it.

(36)

HTTP methods

Path parameters

Responses

200 RecoveryGroupOutput (p. 33)200 response - Success.

Retry the request.

PUT

Operation ID: UpdateRecoveryGroup Updates a recovery group.

Path parameters

Responses

200 RecoveryGroupOutput (p. 33)200 response - Success.

(37)

HTTP methods

Retry the request.

DELETE

Operation ID: DeleteRecoveryGroup Deletes a recovery group.

Path parameters

Responses

deletion

exception. You do not have

(38)

Schemas

suﬃcient access to perform this action.

Retry the request.

OPTIONS

Enable CORS by returning correct headers

Path parameters

Responses

Schemas

Request bodies

PUT schema

]}

Response bodies

RecoveryGroupOutput schema

{ "cells": [

(39)

Properties "string"

], "recoveryGroupName": "string", "recoveryGroupArn": "string", "tags": {

} }

Properties

RecoveryGroupOutput

A representation of the application, typically containing multiple cells.

cells

A list of a cell's Amazon Resource Names (ARNs).

recoveryGroupName

The name of the recovery group.

recoveryGroupArn

The Amazon Resource Name (ARN) for the recovery group.

tags

The tags associated with the recovery group.

RecoveryGroupUpdateParameters

Parameters used to update a recovery group.

cells

A list of cell Amazon Resource Names (ARNs). This list completely replaces the previous list.

(40)

See also

Tags

key-value pairs

Type: string

GetRecoveryGroup

• AWS SDK for C++

• AWS SDK for Go

UpdateRecoveryGroup

• AWS SDK for C++

• AWS SDK for Go

DeleteRecoveryGroup

• AWS SDK for C++

• AWS SDK for Go

(41)

GetRecoveryGroupReadinessSummary

URI

/recoverygroupreadiness/recoveryGroupName

HTTP methods

GET

Operation ID: GetRecoveryGroupReadinessSummary

Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one.

Path parameters

Query parameters

Responses

200 GetRecoveryGroupReadinessSummaryOutput (p. 37)200 response - Success.

(42)

Schemas

Retry the request.

OPTIONS

Path parameters

Responses

Schemas

Response bodies

GetRecoveryGroupReadinessSummaryOutput schema

{

"nextToken": "string", "readiness": enum, "readinessChecks": [ {

"readinessCheckName": "string", "readiness": enum

} ]}

Properties

GetRecoveryGroupReadinessSummaryOutput

Result of a GetReadinessRecoveryGroupSummary operation.

(43)

See also

nextToken

readiness

The readiness status at a recovery group level.

readinessChecks

Summaries of the readiness checks for the recovery group.

Type: Array of type ReadinessCheckSummary (p. 38) Required: True

Readiness

NOT_AUTHORIZED

ReadinessCheckSummary

Summary of all readiness check statuses in a recovery group, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary.

readinessCheckName

The name of a readiness check.

readiness

The readiness status of this readiness check.

Type: Readiness (p. 38) Required: False

GetRecoveryGroupReadinessSummary

• AWS SDK for C++

• AWS SDK for Go

GetResourceSet, UpdateResourceSet, DeleteResourceSet

URI

/resourcesets/resourceSetName

HTTP methods

GET

Operation ID: GetResourceSet

Displays the details about a resource set, including a list of the resources in the set.

Path parameters

resourceSetName String True Name of a resource set.

Responses

200 ResourceSetOutput (p. 42) 200 response - Success.

(45)

HTTP methods

Retry the request.

PUT

Operation ID: UpdateResourceSet Updates a resource set.

Path parameters

Responses

200 ResourceSetOutput (p. 42) 200 response - Success.

Retry the request.

(46)

HTTP methods

DELETE

Operation ID: DeleteResourceSet Deletes a resource set.

Path parameters

Responses

deletion

Retry the request.

OPTIONS

Path parameters

(47)

Schemas

Responses

Schemas

Request bodies

PUT schema

{ "resourceSetType": "string", "resources": [

{

"readinessScopes": [ "string"

],

"componentId": "string", "resourceArn": "string", "dnsTargetResource": { "recordType": "string", "domainName": "string", "hostedZoneArn": "string", "targetResource": { "r53Resource": {

"domainName": "string", "recordSetId": "string"

},

"nLBResource": { "arn": "string"

} },

"recordSetId": "string"

} } ]}

Response bodies

ResourceSetOutput schema

{ "resourceSetType": "string", "resourceSetName": "string", "resources": [

{

"readinessScopes": [ "string"

],

"componentId": "string", "resourceArn": "string", "dnsTargetResource": { "recordType": "string", "domainName": "string", "hostedZoneArn": "string", "targetResource": {

(48)

Properties "r53Resource": {

"domainName": "string", "recordSetId": "string"

},

"nLBResource": { "arn": "string"

} },

"recordSetId": "string"

} }

], "resourceSetArn": "string", "tags": {

}}

Properties

DNSTargetResource

A component for DNS/routing control readiness checks and architecture checks.

recordType

The type of DNS record of the target resource.

domainName

The domain name that acts as an ingress point to a portion of the customer application.

hostedZoneArn

The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.

targetResource

The target resource of the DNS target resource.

Type: TargetResource (p. 46) Required: False

recordSetId

The Route 53 record set ID that uniquely identiﬁes a DNS record, given a name and a type.

Type: string

(49)

Properties Required: False

NLBResource

The Network Load Balancer resource that a DNS target resource points to.

arn

The Network Load Balancer resource Amazon Resource Name (ARN).

R53ResourceRecord

The Route 53 resource that a DNS target resource record points to.

domainName

The DNS target domain name.

recordSetId

The Route 53 Resource Record Set ID.

Resource

The resource element of a resource set.

readinessScopes

The recovery group Amazon Resource Name (ARN) or the cell ARN that the readiness checks for this resource set are scoped to.

Type: Array of type string Required: False

componentId

The component identiﬁer of the resource, generated when DNS target resource is used.

resourceArn

The Amazon Resource Name (ARN) of the AWS resource.

Type: string

(50)

dnsTargetResource

The DNS target resource.

Type: DNSTargetResource (p. 43) Required: False

ResourceSetOutput

A collection of resources of the same type.

resourceSetType

The resource type of the resources in the resource set. One of the following values:

AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer,

AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck,

AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource

Pattern: AWS::[A-Za-z0-9]+::[A-Za-z0-9]+

resourceSetName

The name of the resource set.

resources

A list of resource objects.

Type: Array of type Resource (p. 44) Required: True

resourceSetArn

The Amazon Resource Name (ARN) for the resource set.

tags

Type: Tags (p. 46)

(51)

ResourceSetUpdateParameters

Parameters used to create a resource set.

resourceSetType

The resource type of the resources in the resource set. One of the following values:

AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer,

AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck,

AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource

Pattern: AWS::[A-Za-z0-9]+::[A-Za-z0-9]+

resources

A list of resource objects.

Type: Array of type Resource (p. 44) Required: True

Tags

key-value pairs

Type: string

TargetResource

The target resource that the Route 53 record points to.

r53Resource

The Route 53 resource.

Type: R53ResourceRecord (p. 44) Required: False

nLBResource

The Network Load Balancer resource.

Type: NLBResource (p. 44) Required: False

(52)

See also

GetResourceSet

• AWS SDK for C++

• AWS SDK for Go

UpdateResourceSet

• AWS SDK for C++

• AWS SDK for Go

DeleteResourceSet

• AWS SDK for C++

• AWS SDK for Go

ListCells, CreateCell

URI

/cells

(53)

HTTP methods

GET

Operation ID: ListCells Lists the cells for an account.

Query parameters

Responses

200 ListCellsResult (p. 50) 200 response - Success.

Retry the request.

POST

Operation ID: CreateCell Creates a cell in an account.

(54)

Schemas

Responses

409 None 409 response - Conﬂict

exception. You might be using a predeﬁned variable.

Retry the request.

OPTIONS

Responses

Schemas

Request bodies

POST schema

], "cellName": "string", "tags": {

}}

Response bodies

(55)

Properties ListCellsResult schema

{

"cells": [ {

"cells": [ "string"

],

"parentReadinessScopes": [ "string"

],

"cellName": "string", "cellArn": "string", "tags": {

} }

], "nextToken": "string"

}

CellOutput schema

],

"parentReadinessScopes": [ "string"

],

"cellName": "string", "cellArn": "string", "tags": {

}}

Properties

CellCreateParameters

Parameters used to create a cell.

cells

A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within speciﬁc AWS Regions.

Type: Array of type string Required: False

cellName

The name of the cell to create.

(56)

Properties

tags

CellOutput

Information about a cell.

cells

A list of cell ARNs.

parentReadinessScopes

The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.

cellName

The name of the cell.

cellArn

The Amazon Resource Name (ARN) for the cell.

tags

Tags on the resources.

ListCellsResult

The result of a successful ListCells request.

cells

A list of cells.

Amazon Route 53 Application Recovery Controller Recovery Readiness API Reference Guide

Amazon Route 53 Application Recovery Controller

Recovery Readiness API Reference Guide

Amazon Route 53 Application Recovery Controller: Recovery Readiness API Reference Guide

Table of Contents

What is recovery readiness in Amazon Route 53 Application Recovery Controller?

Resources

DeleteCrossAccountAuthorization

URI

HTTP methods

DELETE

Path parameters

Responses

OPTIONS

Path parameters

Responses

Schemas

Response bodies

Properties

DeleteCrossAccountAuthorizationResult

See also

DeleteCrossAccountAuthorization

GetArchitectureRecommendations

URI

HTTP methods

GET

Path parameters

Query parameters

Responses

OPTIONS

Path parameters

Responses

Schemas

Response bodies

Properties

GetArchitectureRecommendationsOutput

lastAuditTimestamp

nextToken

recommendations

Recommendation

recommendationText

See also

GetArchitectureRecommendations

GetCell, UpdateCell, DeleteCell

URI

HTTP methods

GET

Path parameters

Responses

PUT

Path parameters

Responses

DELETE

Path parameters

Responses

OPTIONS

Path parameters

Responses

Schemas

Request bodies

Response bodies

Properties

CellOutput

cells

parentReadinessScopes

cellName

cellArn

tags

CellUpdateParameters

cells

Tags

key-value pairs

See also

GetCell

UpdateCell

DeleteCell

GetCellReadinessSummary

URI

HTTP methods

GET