CfnResourceSet

class aws_cdk.aws_route53recoveryreadiness.CfnResourceSet(scope, id, *, resources, resource_set_name, resource_set_type, tags=None)

Bases: aws_cdk.core.CfnResource

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.

CloudformationResource

AWS::Route53RecoveryReadiness::ResourceSet

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53recoveryreadiness-resourceset.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_route53recoveryreadiness as route53recoveryreadiness

cfn_resource_set = route53recoveryreadiness.CfnResourceSet(self, "MyCfnResourceSet",
    resources=[route53recoveryreadiness.CfnResourceSet.ResourceProperty(
        component_id="componentId",
        dns_target_resource=route53recoveryreadiness.CfnResourceSet.DNSTargetResourceProperty(
            domain_name="domainName",
            hosted_zone_arn="hostedZoneArn",
            record_set_id="recordSetId",
            record_type="recordType",
            target_resource=route53recoveryreadiness.CfnResourceSet.TargetResourceProperty(
                nlb_resource=route53recoveryreadiness.CfnResourceSet.NLBResourceProperty(
                    arn="arn"
                ),
                r53_resource=route53recoveryreadiness.CfnResourceSet.R53ResourceRecordProperty(
                    domain_name="domainName",
                    record_set_id="recordSetId"
                )
            )
        ),
        readiness_scopes=["readinessScopes"],
        resource_arn="resourceArn"
    )],
    resource_set_name="resourceSetName",
    resource_set_type="resourceSetType",

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::Route53RecoveryReadiness::ResourceSet.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • resources (Union[IResolvable, Sequence[Union[ResourceProperty, IResolvable]]]) – A list of resource objects in the resource set.

  • resource_set_name (str) – The name of the resource set to create.

  • resource_set_type (str) – 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.

  • tags (Optional[Sequence[CfnTag]]) – A tag to associate with the parameters for a resource set.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Route53RecoveryReadiness::ResourceSet'
attr_resource_set_arn

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

CloudformationAttribute

ResourceSetArn

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

resource_set_name

The name of the resource set to create.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53recoveryreadiness-resourceset.html#cfn-route53recoveryreadiness-resourceset-resourcesetname

Return type

str

resource_set_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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53recoveryreadiness-resourceset.html#cfn-route53recoveryreadiness-resourceset-resourcesettype

Type

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

Return type

str

resources

A list of resource objects in the resource set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53recoveryreadiness-resourceset.html#cfn-route53recoveryreadiness-resourceset-resources

Return type

Union[IResolvable, List[Union[ResourceProperty, IResolvable]]]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53recoveryreadiness-resourceset.html#cfn-route53recoveryreadiness-resourceset-tags

Return type

TagManager

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

DNSTargetResourceProperty

class CfnResourceSet.DNSTargetResourceProperty(*, domain_name=None, hosted_zone_arn=None, record_set_id=None, record_type=None, target_resource=None)

Bases: object

A 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 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, None]) – The target resource that the Route 53 record points to.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-dnstargetresource.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_route53recoveryreadiness as route53recoveryreadiness

d_nSTarget_resource_property = route53recoveryreadiness.CfnResourceSet.DNSTargetResourceProperty(
    domain_name="domainName",
    hosted_zone_arn="hostedZoneArn",
    record_set_id="recordSetId",
    record_type="recordType",
    target_resource=route53recoveryreadiness.CfnResourceSet.TargetResourceProperty(
        nlb_resource=route53recoveryreadiness.CfnResourceSet.NLBResourceProperty(
            arn="arn"
        ),
        r53_resource=route53recoveryreadiness.CfnResourceSet.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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-dnstargetresource.html#cfn-route53recoveryreadiness-resourceset-dnstargetresource-domainname

Return type

Optional[str]

hosted_zone_arn

The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-dnstargetresource.html#cfn-route53recoveryreadiness-resourceset-dnstargetresource-hostedzonearn

Return type

Optional[str]

record_set_id

The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-dnstargetresource.html#cfn-route53recoveryreadiness-resourceset-dnstargetresource-recordsetid

Return type

Optional[str]

record_type

The type of DNS record of the target resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-dnstargetresource.html#cfn-route53recoveryreadiness-resourceset-dnstargetresource-recordtype

Return type

Optional[str]

target_resource

The target resource that the Route 53 record points to.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-dnstargetresource.html#cfn-route53recoveryreadiness-resourceset-dnstargetresource-targetresource

Return type

Union[IResolvable, TargetResourceProperty, None]

NLBResourceProperty

class CfnResourceSet.NLBResourceProperty(*, arn=None)

Bases: object

The Network Load Balancer resource that a DNS target resource points to.

Parameters

arn (Optional[str]) – The Network Load Balancer resource Amazon Resource Name (ARN).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-nlbresource.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_route53recoveryreadiness as route53recoveryreadiness

n_lBResource_property = route53recoveryreadiness.CfnResourceSet.NLBResourceProperty(
    arn="arn"
)

Attributes

arn

The Network Load Balancer resource Amazon Resource Name (ARN).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-nlbresource.html#cfn-route53recoveryreadiness-resourceset-nlbresource-arn

Return type

Optional[str]

R53ResourceRecordProperty

class CfnResourceSet.R53ResourceRecordProperty(*, domain_name=None, record_set_id=None)

Bases: object

The 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 Route 53 Resource Record Set ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-r53resourcerecord.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_route53recoveryreadiness as route53recoveryreadiness

r53_resource_record_property = route53recoveryreadiness.CfnResourceSet.R53ResourceRecordProperty(
    domain_name="domainName",
    record_set_id="recordSetId"
)

Attributes

domain_name

The DNS target domain name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-r53resourcerecord.html#cfn-route53recoveryreadiness-resourceset-r53resourcerecord-domainname

Return type

Optional[str]

record_set_id

The Route 53 Resource Record Set ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-r53resourcerecord.html#cfn-route53recoveryreadiness-resourceset-r53resourcerecord-recordsetid

Return type

Optional[str]

ResourceProperty

class CfnResourceSet.ResourceProperty(*, component_id=None, dns_target_resource=None, readiness_scopes=None, resource_arn=None)

Bases: object

The 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, None]) – A component for DNS/routing control readiness checks. This is a required setting when ResourceSet ResourceSetType is set to AWS::Route53RecoveryReadiness::DNSTargetResource . Do not set it for any other ResourceSetType setting.

  • 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 all ResourceSet ResourceSetType settings except AWS::Route53RecoveryReadiness::DNSTargetResource . Do not set this when ResourceSetType is set to AWS::Route53RecoveryReadiness::DNSTargetResource .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-resource.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_route53recoveryreadiness as route53recoveryreadiness

resource_property = route53recoveryreadiness.CfnResourceSet.ResourceProperty(
    component_id="componentId",
    dns_target_resource=route53recoveryreadiness.CfnResourceSet.DNSTargetResourceProperty(
        domain_name="domainName",
        hosted_zone_arn="hostedZoneArn",
        record_set_id="recordSetId",
        record_type="recordType",
        target_resource=route53recoveryreadiness.CfnResourceSet.TargetResourceProperty(
            nlb_resource=route53recoveryreadiness.CfnResourceSet.NLBResourceProperty(
                arn="arn"
            ),
            r53_resource=route53recoveryreadiness.CfnResourceSet.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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-resource.html#cfn-route53recoveryreadiness-resourceset-resource-componentid

Return type

Optional[str]

dns_target_resource

A component for DNS/routing control readiness checks.

This is a required setting when ResourceSet ResourceSetType is set to AWS::Route53RecoveryReadiness::DNSTargetResource . Do not set it for any other ResourceSetType setting.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-resource.html#cfn-route53recoveryreadiness-resourceset-resource-dnstargetresource

Return type

Union[IResolvable, DNSTargetResourceProperty, None]

readiness_scopes

The recovery group Amazon Resource Name (ARN) or the cell ARN that the readiness checks for this resource set are scoped to.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-resource.html#cfn-route53recoveryreadiness-resourceset-resource-readinessscopes

Return type

Optional[List[str]]

resource_arn

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

This is a required setting for all ResourceSet ResourceSetType settings except AWS::Route53RecoveryReadiness::DNSTargetResource . Do not set this when ResourceSetType is set to AWS::Route53RecoveryReadiness::DNSTargetResource .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-resource.html#cfn-route53recoveryreadiness-resourceset-resource-resourcearn

Return type

Optional[str]

TargetResourceProperty

class CfnResourceSet.TargetResourceProperty(*, nlb_resource=None, r53_resource=None)

Bases: object

The target resource that the Route 53 record points to.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-targetresource.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_route53recoveryreadiness as route53recoveryreadiness

target_resource_property = route53recoveryreadiness.CfnResourceSet.TargetResourceProperty(
    nlb_resource=route53recoveryreadiness.CfnResourceSet.NLBResourceProperty(
        arn="arn"
    ),
    r53_resource=route53recoveryreadiness.CfnResourceSet.R53ResourceRecordProperty(
        domain_name="domainName",
        record_set_id="recordSetId"
    )
)

Attributes

nlb_resource

The Network Load Balancer resource that a DNS target resource points to.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-targetresource.html#cfn-route53recoveryreadiness-resourceset-targetresource-nlbresource

Return type

Union[IResolvable, NLBResourceProperty, None]

r53_resource

The Route 53 resource that a DNS target resource record points to.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-targetresource.html#cfn-route53recoveryreadiness-resourceset-targetresource-r53resource

Return type

Union[IResolvable, R53ResourceRecordProperty, None]