Package software.amazon.awscdk.services.route53

Class CfnRecordSetGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.route53.CfnRecordSetGroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.969Z") @Stability(Stable) public class CfnRecordSetGroup extends CfnResource implements IInspectable
A CloudFormation AWS::Route53::RecordSetGroup.

A complex type that contains an optional comment, the name and ID of the hosted zone that you want to make changes in, and values for the records that you want to create.

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.route53.*;
 CfnRecordSetGroup cfnRecordSetGroup = CfnRecordSetGroup.Builder.create(this, "MyCfnRecordSetGroup")
         .comment("comment")
         .hostedZoneId("hostedZoneId")
         .hostedZoneName("hostedZoneName")
         .recordSets(List.of(RecordSetProperty.builder()
                 .name("name")
                 .type("type")
                 // the properties below are optional
                 .aliasTarget(AliasTargetProperty.builder()
                         .dnsName("dnsName")
                         .hostedZoneId("hostedZoneId")
                         // the properties below are optional
                         .evaluateTargetHealth(false)
                         .build())
                 .cidrRoutingConfig(CidrRoutingConfigProperty.builder()
                         .collectionId("collectionId")
                         .locationName("locationName")
                         .build())
                 .failover("failover")
                 .geoLocation(GeoLocationProperty.builder()
                         .continentCode("continentCode")
                         .countryCode("countryCode")
                         .subdivisionCode("subdivisionCode")
                         .build())
                 .healthCheckId("healthCheckId")
                 .hostedZoneId("hostedZoneId")
                 .hostedZoneName("hostedZoneName")
                 .multiValueAnswer(false)
                 .region("region")
                 .resourceRecords(List.of("resourceRecords"))
                 .setIdentifier("setIdentifier")
                 .ttl("ttl")
                 .weight(123)
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRecordSetGroup

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

    • CfnRecordSetGroup

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

    • CfnRecordSetGroup

      @Stability(Stable) public CfnRecordSetGroup(@NotNull Construct scope, @NotNull String id, @Nullable CfnRecordSetGroupProps props)
      Create a new AWS::Route53::RecordSetGroup.

      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.

    • CfnRecordSetGroup

      @Stability(Stable) public CfnRecordSetGroup(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::Route53::RecordSetGroup.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getComment

      @Stability(Stable) @Nullable public String getComment()
      Optional: Any comments you want to include about a change batch request.

    • setComment

      @Stability(Stable) public void setComment(@Nullable String value)
      Optional: Any comments you want to include about a change batch request.

    • getHostedZoneId

      @Stability(Stable) @Nullable public String getHostedZoneId()
      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 .

    • setHostedZoneId

      @Stability(Stable) public void setHostedZoneId(@Nullable String value)
      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 .

    • getHostedZoneName

      @Stability(Stable) @Nullable public String getHostedZoneName()
      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 .

    • setHostedZoneName

      @Stability(Stable) public void setHostedZoneName(@Nullable String value)
      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 .

    • getRecordSets

      @Stability(Stable) @Nullable public Object getRecordSets()
      A complex type that contains one RecordSet element for each record that you want to create.

    • setRecordSets

      @Stability(Stable) public void setRecordSets(@Nullable IResolvable value)
      A complex type that contains one RecordSet element for each record that you want to create.

    • setRecordSets

      @Stability(Stable) public void setRecordSets(@Nullable List<Object> value)
      A complex type that contains one RecordSet element for each record that you want to create.