create_resource_set¶

create_resource_set(**kwargs)¶

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

Request Syntax

response = client.create_resource_set(
    ResourceSetName='string',
    ResourceSetType='string',
    Resources=[
        {
            '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={
        'string': 'string'
    }
)

Parameters

ResourceSetName (string) --
[REQUIRED]

The name of the resource set to create.
ResourceSetType (string) --
[REQUIRED]

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) --
[REQUIRED]

A list of resource objects in the resource set.
- (dict) --
  The resource element of a resource set.
  - ComponentId (string) --
    The component identifier of the resource, generated when DNS target resource is used.
  - DnsTargetResource (dict) --
    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 (dict) --
      The target resource of the DNS target resource.
      - NLBResource (dict) --
        The Network Load Balancer Resource.
        
        Arn (string) --
        The Network Load Balancer resource Amazon Resource Name (ARN).
      - R53Resource (dict) --
        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 (dict) --
A tag to associate with the parameters for a resource set.
- (string) --
  - (string) --

Return type

dict

Returns

Response Syntax

{
    'ResourceSetArn': 'string',
    'ResourceSetName': 'string',
    'ResourceSetType': 'string',
    'Resources': [
        {
            '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': {
        'string': 'string'
    }
}

Response Structure

(dict) --

200 response
- 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.
  - (dict) --
    
    The resource element of a resource set.
    - ComponentId (string) --
      
      The component identifier of the resource, generated when DNS target resource is used.
    - DnsTargetResource (dict) --
      
      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 (dict) --
        
        The target resource of the DNS target resource.
        
        NLBResource (dict) --
        
        The Network Load Balancer Resource.
        
        Arn (string) --
        
        The Network Load Balancer resource Amazon Resource Name (ARN).
        
        R53Resource (dict) --
        
        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 (dict) --
  
  A collection of tags associated with a resource.
  - (string) --
    - (string) --

Exceptions

Route53RecoveryReadiness.Client.exceptions.ThrottlingException
Route53RecoveryReadiness.Client.exceptions.ValidationException
Route53RecoveryReadiness.Client.exceptions.InternalServerException
Route53RecoveryReadiness.Client.exceptions.ConflictException
Route53RecoveryReadiness.Client.exceptions.AccessDeniedException

Select your cookie preferences

Customize cookie preferences

Essential

Performance

Functional

Advertising

Table Of Contents

create_resource_set¶