CfnResourceSetPropsMixin
- class aws_cdk.mixins_preview.aws_route53recoveryreadiness.mixins.CfnResourceSetPropsMixin(props, *, strategy=None)
Bases:
MixinCreates a resource set in Amazon Route 53 Application Recovery Controller.
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.
- See:
- CloudformationResource:
AWS::Route53RecoveryReadiness::ResourceSet
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview import mixins from aws_cdk.mixins_preview.aws_route53recoveryreadiness import mixins as route53recoveryreadiness_mixins cfn_resource_set_props_mixin = route53recoveryreadiness_mixins.CfnResourceSetPropsMixin(route53recoveryreadiness_mixins.CfnResourceSetMixinProps( resources=[route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.ResourceProperty( component_id="componentId", dns_target_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.DNSTargetResourceProperty( domain_name="domainName", hosted_zone_arn="hostedZoneArn", record_set_id="recordSetId", record_type="recordType", target_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.TargetResourceProperty( nlb_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.NLBResourceProperty( arn="arn" ), r53_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.R53ResourceRecordProperty( domain_name="domainName", record_set_id="recordSetId" ) ) ), readiness_scopes=["readinessScopes"], resource_arn="resourceArn" )], resource_set_name="resourceSetName", resource_set_type="resourceSetType", tags=[CfnTag( key="key", value="value" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::Route53RecoveryReadiness::ResourceSet.- Parameters:
props (
Union[CfnResourceSetMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['resources', 'resourceSetName', 'resourceSetType', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
DNSTargetResourceProperty
- class CfnResourceSetPropsMixin.DNSTargetResourceProperty(*, domain_name=None, hosted_zone_arn=None, record_set_id=None, record_type=None, target_resource=None)
Bases:
objectA component for DNS/routing control readiness checks and architecture checks.
- Parameters:
domain_name (
Optional[str]) – The domain name that acts as an ingress point to a portion of the customer application.hosted_zone_arn (
Optional[str]) – The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.record_set_id (
Optional[str]) – The Amazon Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.record_type (
Optional[str]) – The type of DNS record of the target resource.target_resource (
Union[IResolvable,TargetResourceProperty,Dict[str,Any],None]) – The target resource that the Route 53 record points to.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_route53recoveryreadiness import mixins as route53recoveryreadiness_mixins d_nSTarget_resource_property = route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.DNSTargetResourceProperty( domain_name="domainName", hosted_zone_arn="hostedZoneArn", record_set_id="recordSetId", record_type="recordType", target_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.TargetResourceProperty( nlb_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.NLBResourceProperty( arn="arn" ), r53_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.R53ResourceRecordProperty( domain_name="domainName", record_set_id="recordSetId" ) ) )
Attributes
- domain_name
The domain name that acts as an ingress point to a portion of the customer application.
- hosted_zone_arn
The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.
- record_set_id
The Amazon Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.
- record_type
The type of DNS record of the target resource.
- target_resource
The target resource that the Route 53 record points to.
NLBResourceProperty
- class CfnResourceSetPropsMixin.NLBResourceProperty(*, arn=None)
Bases:
objectThe Network Load Balancer resource that a DNS target resource points to.
- Parameters:
arn (
Optional[str]) – The Network Load Balancer resource Amazon Resource Name (ARN).- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_route53recoveryreadiness import mixins as route53recoveryreadiness_mixins n_lBResource_property = route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.NLBResourceProperty( arn="arn" )
Attributes
- arn
The Network Load Balancer resource Amazon Resource Name (ARN).
R53ResourceRecordProperty
- class CfnResourceSetPropsMixin.R53ResourceRecordProperty(*, domain_name=None, record_set_id=None)
Bases:
objectThe Amazon Route 53 resource that a DNS target resource record points to.
- Parameters:
domain_name (
Optional[str]) – The DNS target domain name.record_set_id (
Optional[str]) – The Amazon Route 53 Resource Record Set ID.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_route53recoveryreadiness import mixins as route53recoveryreadiness_mixins r53_resource_record_property = route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.R53ResourceRecordProperty( domain_name="domainName", record_set_id="recordSetId" )
Attributes
- domain_name
The DNS target domain name.
- record_set_id
The Amazon Route 53 Resource Record Set ID.
ResourceProperty
- class CfnResourceSetPropsMixin.ResourceProperty(*, component_id=None, dns_target_resource=None, readiness_scopes=None, resource_arn=None)
Bases:
objectThe resource element of a resource set.
- Parameters:
component_id (
Optional[str]) – The component identifier of the resource, generated when DNS target resource is used.dns_target_resource (
Union[IResolvable,DNSTargetResourceProperty,Dict[str,Any],None]) – A component for DNS/routing control readiness checks. This is a required setting whenResourceSetResourceSetTypeis set toAWS::Route53RecoveryReadiness::DNSTargetResource. Do not set it for any otherResourceSetTypesetting.readiness_scopes (
Optional[Sequence[str]]) – The recovery group Amazon Resource Name (ARN) or the cell ARN that the readiness checks for this resource set are scoped to.resource_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the AWS resource. This is a required setting for allResourceSetResourceSetTypesettings exceptAWS::Route53RecoveryReadiness::DNSTargetResource. Do not set this whenResourceSetTypeis set toAWS::Route53RecoveryReadiness::DNSTargetResource.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_route53recoveryreadiness import mixins as route53recoveryreadiness_mixins resource_property = route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.ResourceProperty( component_id="componentId", dns_target_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.DNSTargetResourceProperty( domain_name="domainName", hosted_zone_arn="hostedZoneArn", record_set_id="recordSetId", record_type="recordType", target_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.TargetResourceProperty( nlb_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.NLBResourceProperty( arn="arn" ), r53_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.R53ResourceRecordProperty( domain_name="domainName", record_set_id="recordSetId" ) ) ), readiness_scopes=["readinessScopes"], resource_arn="resourceArn" )
Attributes
- component_id
The component identifier of the resource, generated when DNS target resource is used.
- dns_target_resource
A component for DNS/routing control readiness checks.
This is a required setting when
ResourceSetResourceSetTypeis set toAWS::Route53RecoveryReadiness::DNSTargetResource. Do not set it for any otherResourceSetTypesetting.
- readiness_scopes
The recovery group Amazon Resource Name (ARN) or the cell ARN that the readiness checks for this resource set are scoped to.
- resource_arn
The Amazon Resource Name (ARN) of the AWS resource.
This is a required setting for all
ResourceSetResourceSetTypesettings exceptAWS::Route53RecoveryReadiness::DNSTargetResource. Do not set this whenResourceSetTypeis set toAWS::Route53RecoveryReadiness::DNSTargetResource.
TargetResourceProperty
- class CfnResourceSetPropsMixin.TargetResourceProperty(*, nlb_resource=None, r53_resource=None)
Bases:
objectThe target resource that the Route 53 record points to.
- Parameters:
nlb_resource (
Union[IResolvable,NLBResourceProperty,Dict[str,Any],None]) – The Network Load Balancer resource that a DNS target resource points to.r53_resource (
Union[IResolvable,R53ResourceRecordProperty,Dict[str,Any],None]) – The Route 53 resource that a DNS target resource record points to.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_route53recoveryreadiness import mixins as route53recoveryreadiness_mixins target_resource_property = route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.TargetResourceProperty( nlb_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.NLBResourceProperty( arn="arn" ), r53_resource=route53recoveryreadiness_mixins.CfnResourceSetPropsMixin.R53ResourceRecordProperty( domain_name="domainName", record_set_id="recordSetId" ) )
Attributes
- nlb_resource
The Network Load Balancer resource that a DNS target resource points to.
- r53_resource
The Route 53 resource that a DNS target resource record points to.