software.amazon.awscdk.services.route53

Interface RecordSetOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AaaaRecordProps, ARecordProps, CaaAmazonRecordProps, CaaRecordProps, CnameRecordProps, DsRecordProps, MxRecordProps, NsRecordProps, RecordSetProps, SrvRecordProps, TxtRecordProps, ZoneDelegationRecordProps

All Known Implementing Classes:

AaaaRecordProps.Jsii$Proxy, ARecordProps.Jsii$Proxy, CaaAmazonRecordProps.Jsii$Proxy, CaaRecordProps.Jsii$Proxy, CnameRecordProps.Jsii$Proxy, DsRecordProps.Jsii$Proxy, MxRecordProps.Jsii$Proxy, NsRecordProps.Jsii$Proxy, RecordSetOptions.Jsii$Proxy, RecordSetProps.Jsii$Proxy, SrvRecordProps.Jsii$Proxy, TxtRecordProps.Jsii$Proxy, ZoneDelegationRecordProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.676Z")
 @Stability(value=Stable)
public interface RecordSetOptions
extends software.amazon.jsii.JsiiSerializable

Options for a RecordSet.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.route53.*;
 HostedZone hostedZone;
 RecordSetOptions recordSetOptions = RecordSetOptions.builder()
         .zone(hostedZone)
         // the properties below are optional
         .comment("comment")
         .deleteExisting(false)
         .recordName("recordName")
         .ttl(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RecordSetOptions.Builder A builder for RecordSetOptions
static class	RecordSetOptions.Jsii$Proxy An implementation for RecordSetOptions

Method Summary

Modifier and Type	Method and Description
static RecordSetOptions.Builder	builder()
default String	getComment() A comment to add on the record.
default Boolean	getDeleteExisting() Whether to delete the same record set in the hosted zone if it already exists.
default String	getRecordName() The domain name for this record.
default Duration	getTtl() The resource record cache time to live (TTL).
IHostedZone	getZone() The hosted zone in which to define the new record.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getZone

@Stability(value=Stable)
 @NotNull
IHostedZone getZone()

The hosted zone in which to define the new record.

getComment

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

A comment to add on the record.

Default: no comment

getDeleteExisting

@Stability(value=Stable)
 @Nullable
default Boolean getDeleteExisting()

Whether to delete the same record set in the hosted zone if it already exists.

This allows to deploy a new record set while minimizing the downtime because the new record set will be created immediately after the existing one is deleted. It also avoids "manual" actions to delete existing record sets.

Default: false

getRecordName

@Stability(value=Stable)
 @Nullable
default String getRecordName()

The domain name for this record.

Default: zone root

getTtl

@Stability(value=Stable)
 @Nullable
default Duration getTtl()

The resource record cache time to live (TTL).

Default: Duration.minutes(30)

builder

@Stability(value=Stable)
static RecordSetOptions.Builder builder()

Returns:

a RecordSetOptions.Builder of RecordSetOptions