# 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** | Name | Type | Required | Description | | --- |--- |--- |--- | | resourceSetName | String | True | Name of a resource set. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | ResourceSetOutput | 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. | | 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | | 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. | ### PUT **Operation ID:** `UpdateResourceSet` Updates a resource set. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | resourceSetName | String | True | Name of a resource set. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | ResourceSetOutput | 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. | | 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | | 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. | ### DELETE **Operation ID:** `DeleteResourceSet` Deletes a resource set. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | resourceSetName | String | True | Name of a resource set. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 204 | None | 204 response - Successful deletion | | 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. | | 404 | None | 404 response - Malformed query string. The query string contains a syntax error or resource not found. | | 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 **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | resourceSetName | String | True | Name of a resource set. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | 200 response - Success. | ## Schemas ### Request bodies #### PUT schema PUT ``` { "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 ResourceSetOutput ``` { "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 | [TargetResource](#resourcesets-resourcesetname-model-targetresource) | False | The target resource of the DNS target resource. | ### 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 | [DNSTargetResource](#resourcesets-resourcesetname-model-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. | ### ResourceSetOutput A collection of resources of the same type. | Property | Type | Required | Description | | --- |--- |--- |--- | | resources | Array of type [Resource](#resourcesets-resourcesetname-model-resource) | True | A list of resource objects. | | resourceSetArn | stringMaxLength: 256 | True | The Amazon Resource Name (ARN) for the resource set. | | resourceSetName | stringPattern: `\A[a-zA-Z0-9_]+\z`MaxLength: 64 | True | The name of the resource set. | | resourceSetType | stringPattern: `AWS::[A-Za-z0-9]+::[A-Za-z0-9]+` | 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 | [Tags](#resourcesets-resourcesetname-model-tags) | False | | ### ResourceSetUpdateParameters Parameters used to create a resource set. | Property | Type | Required | Description | | --- |--- |--- |--- | | resources | Array of type [Resource](#resourcesets-resourcesetname-model-resource) | True | A list of resource objects. | | resourceSetType | stringPattern: `AWS::[A-Za-z0-9]+::[A-Za-z0-9]+` | 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 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 | [NLBResource](#resourcesets-resourcesetname-model-nlbresource) | False | The Network Load Balancer resource. | | r53Resource | [R53ResourceRecord](#resourcesets-resourcesetname-model-r53resourcerecord) | 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: ### GetResourceSet + [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/GetResourceSet) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/GetResourceSet) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/GetResourceSet) + [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/GetResourceSet) + [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/GetResourceSet) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/GetResourceSet) + [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/GetResourceSet) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/GetResourceSet) + [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/GetResourceSet) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/GetResourceSet) ### UpdateResourceSet + [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/UpdateResourceSet) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/UpdateResourceSet) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/UpdateResourceSet) + [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/UpdateResourceSet) + [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/UpdateResourceSet) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/UpdateResourceSet) + [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/UpdateResourceSet) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/UpdateResourceSet) + [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/UpdateResourceSet) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/UpdateResourceSet) ### DeleteResourceSet + [AWS Command Line Interface V2](/goto/cli2/aws-meridian-beta-2019-12-02/DeleteResourceSet) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/aws-meridian-beta-2019-12-02/DeleteResourceSet) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/aws-meridian-beta-2019-12-02/DeleteResourceSet) + [AWS SDK for Go v2](/goto/SdkForGoV2/aws-meridian-beta-2019-12-02/DeleteResourceSet) + [AWS SDK for Java V2](/goto/SdkForJavaV2/aws-meridian-beta-2019-12-02/DeleteResourceSet) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/aws-meridian-beta-2019-12-02/DeleteResourceSet) + [AWS SDK for Kotlin](/goto/SdkForKotlin/aws-meridian-beta-2019-12-02/DeleteResourceSet) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/aws-meridian-beta-2019-12-02/DeleteResourceSet) + [AWS SDK for Python](/goto/boto3/aws-meridian-beta-2019-12-02/DeleteResourceSet) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/aws-meridian-beta-2019-12-02/DeleteResourceSet)