CfnRecordSetGroupProps

class aws_cdk.aws_route53.CfnRecordSetGroupProps(*, comment=None, hosted_zone_id=None, hosted_zone_name=None, record_sets=None)

Bases: object

Properties for defining a CfnRecordSetGroup.

Parameters
  • comment (Optional[str]) – Optional: Any comments you want to include about a change batch request.

  • hosted_zone_id (Optional[str]) – The ID of the hosted zone that you want to create records in. Specify either HostedZoneName or HostedZoneId , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId .

  • hosted_zone_name (Optional[str]) – The name of the hosted zone that you want to create records in. You must include a trailing dot (for example, www.example.com. ) as part of the HostedZoneName . When you create a stack using an AWS::Route53::RecordSet that specifies HostedZoneName , AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName . If AWS CloudFormation can’t find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack. Specify either HostedZoneName or HostedZoneId , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId .

  • record_sets (Union[IResolvable, Sequence[Union[IResolvable, RecordSetProperty]], None]) – A complex type that contains one RecordSet element for each record that you want to create.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.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_route53 as route53

cfn_record_set_group_props = route53.CfnRecordSetGroupProps(
    comment="comment",
    hosted_zone_id="hostedZoneId",
    hosted_zone_name="hostedZoneName",
    record_sets=[route53.CfnRecordSetGroup.RecordSetProperty(
        name="name",
        type="type",

        # the properties below are optional
        alias_target=route53.CfnRecordSetGroup.AliasTargetProperty(
            dns_name="dnsName",
            hosted_zone_id="hostedZoneId",

            # the properties below are optional
            evaluate_target_health=False
        ),
        comment="comment",
        failover="failover",
        geo_location=route53.CfnRecordSetGroup.GeoLocationProperty(
            continent_code="continentCode",
            country_code="countryCode",
            subdivision_code="subdivisionCode"
        ),
        health_check_id="healthCheckId",
        hosted_zone_id="hostedZoneId",
        hosted_zone_name="hostedZoneName",
        multi_value_answer=False,
        region="region",
        resource_records=["resourceRecords"],
        set_identifier="setIdentifier",
        ttl="ttl",
        weight=123
    )]
)

Attributes

comment
  • Any comments you want to include about a change batch request.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-comment

Type

*Optional

Return type

Optional[str]

hosted_zone_id

The ID of the hosted zone that you want to create records in.

Specify either HostedZoneName or HostedZoneId , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzoneid

Return type

Optional[str]

hosted_zone_name

The name of the hosted zone that you want to create records in.

You must include a trailing dot (for example, www.example.com. ) as part of the HostedZoneName .

When you create a stack using an AWS::Route53::RecordSet that specifies HostedZoneName , AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName . If AWS CloudFormation can’t find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.

Specify either HostedZoneName or HostedZoneId , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzonename

Return type

Optional[str]

record_sets

A complex type that contains one RecordSet element for each record that you want to create.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-recordsets

Return type

Union[IResolvable, List[Union[IResolvable, RecordSetProperty]], None]