software.amazon.awscdk.services.route53recoveryreadiness

Class CfnResourceSet

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.route53recoveryreadiness.CfnResourceSet

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.695Z")
 @Stability(value=Stable)
public class CfnResourceSet
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Route53RecoveryReadiness::ResourceSet`.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.route53recoveryreadiness.*;
 CfnResourceSet cfnResourceSet = CfnResourceSet.Builder.create(this, "MyCfnResourceSet")
         .resources(List.of(ResourceProperty.builder()
                 .componentId("componentId")
                 .dnsTargetResource(DNSTargetResourceProperty.builder()
                         .domainName("domainName")
                         .hostedZoneArn("hostedZoneArn")
                         .recordSetId("recordSetId")
                         .recordType("recordType")
                         .targetResource(TargetResourceProperty.builder()
                                 .nlbResource(NLBResourceProperty.builder()
                                         .arn("arn")
                                         .build())
                                 .r53Resource(R53ResourceRecordProperty.builder()
                                         .domainName("domainName")
                                         .recordSetId("recordSetId")
                                         .build())
                                 .build())
                         .build())
                 .readinessScopes(List.of("readinessScopes"))
                 .resourceArn("resourceArn")
                 .build()))
         .resourceSetName("resourceSetName")
         .resourceSetType("resourceSetType")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnResourceSet.Builder A fluent builder for CfnResourceSet.
static interface	CfnResourceSet.DNSTargetResourceProperty A component for DNS/routing control readiness checks and architecture checks.
static interface	CfnResourceSet.NLBResourceProperty The Network Load Balancer resource that a DNS target resource points to.
static interface	CfnResourceSet.R53ResourceRecordProperty The Route 53 resource that a DNS target resource record points to.
static interface	CfnResourceSet.ResourceProperty The resource element of a resource set.
static interface	CfnResourceSet.TargetResourceProperty The target resource that the Route 53 record points to.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnResourceSet(software.constructs.Construct scope, String id, CfnResourceSetProps props) Create a new `AWS::Route53RecoveryReadiness::ResourceSet`.
protected	CfnResourceSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResourceSet(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrResourceSetArn() The Amazon Resource Name (ARN) of the resource set.
protected Map<String,Object>	getCfnProperties()
Object	getResources() A list of resource objects in the resource set.
String	getResourceSetName() The name of the resource set to create.
String	getResourceSetType() The resource type of the resources in the resource set.
TagManager	getTags() A tag to associate with the parameters for a resource set.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setResources(IResolvable value) A list of resource objects in the resource set.
void	setResources(List<Object> value) A list of resource objects in the resource set.
void	setResourceSetName(String value) The name of the resource set to create.
void	setResourceSetType(String value) The resource type of the resources in the resource set.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnResourceSet

protected CfnResourceSet(software.amazon.jsii.JsiiObjectRef objRef)

CfnResourceSet

protected CfnResourceSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnResourceSet

@Stability(value=Stable)
public CfnResourceSet(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnResourceSetProps props)

Create a new `AWS::Route53RecoveryReadiness::ResourceSet`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrResourceSetArn

@Stability(value=Stable)
 @NotNull
public String getAttrResourceSetArn()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getResources

@Stability(value=Stable)
 @NotNull
public Object getResources()

A list of resource objects in the resource set.

setResources

@Stability(value=Stable)
public void setResources(@NotNull
                                                  IResolvable value)

A list of resource objects in the resource set.

setResources

@Stability(value=Stable)
public void setResources(@NotNull
                                                  List<Object> value)

A list of resource objects in the resource set.

getResourceSetName

@Stability(value=Stable)
 @NotNull
public String getResourceSetName()

The name of the resource set to create.

setResourceSetName

@Stability(value=Stable)
public void setResourceSetName(@NotNull
                                                        String value)

The name of the resource set to create.

getResourceSetType

@Stability(value=Stable)
 @NotNull
public String getResourceSetType()

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

AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, 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.

Note that AWS::Route53RecoveryReadiness::DNSTargetResource is only used for this setting. It isn't an actual AWS CloudFormation resource type.

setResourceSetType

@Stability(value=Stable)
public void setResourceSetType(@NotNull
                                                        String value)

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

AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, 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.

Note that AWS::Route53RecoveryReadiness::DNSTargetResource is only used for this setting. It isn't an actual AWS CloudFormation resource type.