Class CfnResourceSet
- All Implemented Interfaces:
IInspectable,ITaggable,IResourceSetRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
A resource set is a set of resources of one type, such as Network Load Balancers, that span multiple cells. You can associate a resource set with a readiness check to have Route 53 ARC continually monitor the resources in the set for failover readiness.
You typically create a resource set and a readiness check for each supported type of AWS resource in your application.
For more information, see Readiness checks, resource sets, and readiness scopes in the Amazon Route 53 Application Recovery Controller Developer Guide.
Route 53 ARC Readiness supports us-east-1 and us-west-2 AWS Regions only.
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()))
.resourceSetType("resourceSetType")
// the properties below are optional
.resourceSetName("resourceSetName")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA fluent builder forCfnResourceSet.static interfaceA component for DNS/routing control readiness checks and architecture checks.static interfaceThe Network Load Balancer resource that a DNS target resource points to.static interfaceThe Amazon Route 53 resource that a DNS target resource record points to.static interfaceThe resource element of a resource set.static interfaceThe target resource that the Route 53 record points to.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.route53recoveryreadiness.IResourceSetRef
IResourceSetRef.Jsii$Default, IResourceSetRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnResourceSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnResourceSet(software.amazon.jsii.JsiiObjectRef objRef) CfnResourceSet(software.constructs.Construct scope, String id, CfnResourceSetProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the resource set.A list of resource objects in the resource set.The name of the resource set to create.A reference to a ResourceSet resource.The resource type of the resources in the resource set.getTags()Tag Manager which manages the tags for this resource.A tag to associate with the parameters for a resource set.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetResources(List<Object> value) A list of resource objects in the resource set.voidsetResources(IResolvable value) A list of resource objects in the resource set.voidsetResourceSetName(String value) The name of the resource set to create.voidsetResourceSetType(String value) The resource type of the resources in the resource set.voidsetTagsRaw(List<CfnTag> value) A tag to associate with the parameters for a resource set.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnResourceSet
protected CfnResourceSet(software.amazon.jsii.JsiiObjectRef objRef) -
CfnResourceSet
protected CfnResourceSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnResourceSet
@Stability(Stable) public CfnResourceSet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnResourceSetProps props) - Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- Parameters:
inspector- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrResourceSetArn
The Amazon Resource Name (ARN) of the resource set. -
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getResourceSetRef
A reference to a ResourceSet resource.- Specified by:
getResourceSetRefin interfaceIResourceSetRef
-
getTags
Tag Manager which manages the tags for this resource. -
getResources
A list of resource objects in the resource set.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnResourceSet.ResourceProperty> -
setResources
A list of resource objects in the resource set. -
setResources
A list of resource objects in the resource set. -
getResourceSetType
The resource type of the resources in the resource set.Enter one of the following values for resource type:.
-
setResourceSetType
The resource type of the resources in the resource set.Enter one of the following values for resource type:.
-
getResourceSetName
The name of the resource set to create. -
setResourceSetName
The name of the resource set to create. -
getTagsRaw
A tag to associate with the parameters for a resource set. -
setTagsRaw
A tag to associate with the parameters for a resource set.
-