ListResourceSets, CreateResourceSet
URI
/resourcesets
HTTP methods
GET
Operation ID: ListResourceSets
Lists the resource sets in an account.
Query parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextToken | String | False | The token that identifies which batch of results you want to see. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxResults | String | False | The number of objects that you want to return with this call. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | ListResourceSetsResult | 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 sufficient 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. |
POST
Operation ID: CreateResourceSet
Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness.
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | ResourceSetOutput | 200 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 sufficient access to perform this action. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | None | 409 response - Conflict exception. You might be using a predefined variable. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
Enable CORS by returning correct headers
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | None | 200 response - Success. |
Schemas
Request bodies
{ "resourceSetType": "string", "resourceSetName": "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" } } ], "tags": { } }
Response bodies
{ "nextToken": "string", "resourceSets": [ { "resourceSetType": "string", "resourceSetName": "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" } } ], "resourceSetArn": "string", "tags": { } } ] }
{ "resourceSetType": "string", "resourceSetName": "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" } } ], "resourceSetArn": "string", "tags": { } }
Properties
DNSTargetResource
A component for DNS/routing control readiness checks and architecture checks.
Property | Type | Required | Description |
---|---|---|---|
domainName | string | False | The domain name that acts as an ingress point to a portion of the customer application. |
hostedZoneArn | string | False | The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource. |
recordSetId | string | False | The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type. |
recordType | string | False | The type of DNS record of the target resource. |
targetResource | False | The target resource of the DNS target resource. |
ListResourceSetsResult
The result of a successful ListResourceSets
request.
Property | Type | Required | Description |
---|---|---|---|
nextToken | string | False | The token that identifies which batch of results you want to see. |
resourceSets | Array of type ResourceSetOutput | False | A list of resource sets associated with the account. |
NLBResource
The Network Load Balancer resource that a DNS target resource points to.
Property | Type | Required | Description |
---|---|---|---|
arn | string | False | The Network Load Balancer resource Amazon Resource Name (ARN). |
R53ResourceRecord
The Route 53 resource that a DNS target resource record points to.
Property | Type | Required | Description |
---|---|---|---|
domainName | string | False | The DNS target domain name. |
recordSetId | string | False | The Route 53 Resource Record Set ID. |
Resource
The resource element of a resource set.
Property | Type | Required | Description |
---|---|---|---|
componentId | string | False | The component identifier of the resource, generated when DNS target resource is used. |
dnsTargetResource | False | The DNS target resource. | |
readinessScopes | Array of type string | False | The recovery group Amazon Resource Name (ARN) or the cell ARN that the readiness checks for this resource set are scoped to. |
resourceArn | string | False | The Amazon Resource Name (ARN) of the AWS resource. |
ResourceSetCreateParameters
The parameters used to create a resource set.
Property | Type | Required | Description |
---|---|---|---|
resources | Array of type Resource | True | A list of resource objects in the resource set. |
resourceSetName | string | True | The name of the resource set to create. |
resourceSetType | string Pattern: | True | 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 |
tags | False | A tag to associate with the parameters for a resource set. |
ResourceSetOutput
A collection of resources of the same type.
Property | Type | Required | Description |
---|---|---|---|
resources | Array of type Resource | True | A list of resource objects. |
resourceSetArn | string MaxLength: 256 | True | The Amazon Resource Name (ARN) for the resource set. |
resourceSetName | string Pattern: MaxLength: 64 | True | The name of the resource set. |
resourceSetType | string Pattern: | True | 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 |
tags | False |
Tags
A collection of tags associated with a resource.
Property | Type | Required | Description |
---|---|---|---|
| string | False |
TargetResource
The target resource that the Route 53 record points to.
Property | Type | Required | Description |
---|---|---|---|
nLBResource | False | The Network Load Balancer resource. | |
r53Resource | False | The Route 53 resource. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: