Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . route53-recovery-readiness ]

create-resource-set

Description

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.

See also: AWS API Documentation

Synopsis

  create-resource-set
--resource-set-name <value>
--resource-set-type <value>
--resources <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--resource-set-name (string)

The name of the resource set to create.

--resource-set-type (string)

The resource type of the resources in the resource set. Enter one of the following values for resource type:

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

--resources (list)

A list of resource objects in the resource set.

(structure)

The resource element of a resource set.

ComponentId -> (string)

The component identifier of the resource, generated when DNS target resource is used.

DnsTargetResource -> (structure)

The DNS target resource.

DomainName -> (string)

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

HostedZoneArn -> (string)

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

RecordSetId -> (string)

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

RecordType -> (string)

The type of DNS record of the target resource.

TargetResource -> (structure)

The target resource of the DNS target resource.

NLBResource -> (structure)

The Network Load Balancer Resource.

Arn -> (string)

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

R53Resource -> (structure)

The Route 53 resource.

DomainName -> (string)

The DNS target domain name.

RecordSetId -> (string)

The Route 53 Resource Record Set ID.

ReadinessScopes -> (list)

A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.

(string)

ResourceArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Web Services resource.

JSON Syntax:

[
  {
    "ComponentId": "string",
    "DnsTargetResource": {
      "DomainName": "string",
      "HostedZoneArn": "string",
      "RecordSetId": "string",
      "RecordType": "string",
      "TargetResource": {
        "NLBResource": {
          "Arn": "string"
        },
        "R53Resource": {
          "DomainName": "string",
          "RecordSetId": "string"
        }
      }
    },
    "ReadinessScopes": ["string", ...],
    "ResourceArn": "string"
  }
  ...
]

--tags (map)

A tag to associate with the parameters for a resource set.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ResourceSetArn -> (string)

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

ResourceSetName -> (string)

The name of the resource set.

ResourceSetType -> (string)

The resource type of the resources in the resource set. Enter one of the following values for resource type:

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

Resources -> (list)

A list of resource objects.

(structure)

The resource element of a resource set.

ComponentId -> (string)

The component identifier of the resource, generated when DNS target resource is used.

DnsTargetResource -> (structure)

The DNS target resource.

DomainName -> (string)

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

HostedZoneArn -> (string)

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

RecordSetId -> (string)

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

RecordType -> (string)

The type of DNS record of the target resource.

TargetResource -> (structure)

The target resource of the DNS target resource.

NLBResource -> (structure)

The Network Load Balancer Resource.

Arn -> (string)

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

R53Resource -> (structure)

The Route 53 resource.

DomainName -> (string)

The DNS target domain name.

RecordSetId -> (string)

The Route 53 Resource Record Set ID.

ReadinessScopes -> (list)

A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.

(string)

ResourceArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Web Services resource.

Tags -> (map)

A collection of tags associated with a resource.

key -> (string)

value -> (string)