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:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:43.760Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnRecordSetGroup.AliasTargetProperty *Alias records only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
static class	CfnRecordSetGroup.Builder A fluent builder for CfnRecordSetGroup.
static interface	CfnRecordSetGroup.CidrRoutingConfigProperty The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
static interface	CfnRecordSetGroup.GeoLocationProperty A complex type that contains information about a geographic location.
static interface	CfnRecordSetGroup.RecordSetProperty Information about one record that you want to create.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRecordSetGroup(Construct scope, String id) Create a new `AWS::Route53::RecordSetGroup`.
	CfnRecordSetGroup(Construct scope, String id, CfnRecordSetGroupProps props) Create a new `AWS::Route53::RecordSetGroup`.
protected	CfnRecordSetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRecordSetGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getComment() *Optional:* Any comments you want to include about a change batch request.
String	getHostedZoneId() The ID of the hosted zone that you want to create records in.
String	getHostedZoneName() The name of the hosted zone that you want to create records in.
Object	getRecordSets() A complex type that contains one `RecordSet` element for each record that you want to create.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setComment(String value) *Optional:* Any comments you want to include about a change batch request.
void	setHostedZoneId(String value) The ID of the hosted zone that you want to create records in.
void	setHostedZoneName(String value) The name of the hosted zone that you want to create records in.
void	setRecordSets(IResolvable value) A complex type that contains one `RecordSet` element for each record that you want to create.
void	setRecordSets(List<Object> value) A complex type that contains one `RecordSet` element for each record that you want to create.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRecordSetGroup

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

CfnRecordSetGroup

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

CfnRecordSetGroup

@Stability(value=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(value=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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getComment

@Stability(value=Stable)
 @Nullable
public String getComment()

*Optional:* Any comments you want to include about a change batch request.

setComment

@Stability(value=Stable)
public void setComment(@Nullable
                                                String value)

*Optional:* Any comments you want to include about a change batch request.

getHostedZoneId

@Stability(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public Object getRecordSets()

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

setRecordSets

@Stability(value=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(value=Stable)
public void setRecordSets(@Nullable
                                                   List<Object> value)

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