Package 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.93.0 (build 1706ca5)", date="2024-01-03T18:29:31.949Z") @Stability(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.*;
 GeoLocation geoLocation;
 HostedZone hostedZone;
 RecordSetOptions recordSetOptions = RecordSetOptions.builder()
         .zone(hostedZone)
         // the properties below are optional
         .comment("comment")
         .deleteExisting(false)
         .geoLocation(geoLocation)
         .recordName("recordName")
         .ttl(Duration.minutes(30))
         .build();

  • Method Details

    • getZone

      @Stability(Stable) @NotNull IHostedZone getZone()
      The hosted zone in which to define the new record.

    • getComment

      @Stability(Stable) @Nullable default String getComment()
      A comment to add on the record.

      Default: no comment

    • getDeleteExisting

      @Stability(Stable) @Nullable default Boolean getDeleteExisting()
      Whether to delete the same record set in the hosted zone if it already exists (dangerous!).

      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.

      N.B.: this feature is dangerous, use with caution! It can only be used safely when deleteExisting is set to true as soon as the resource is added to the stack. Changing an existing Record Set's deleteExisting property from false -> true after deployment will delete the record!

      Default: false

    • getGeoLocation

      @Stability(Stable) @Nullable default GeoLocation getGeoLocation()
      The geographical origin for this record to return DNS records based on the user's location.

    • getRecordName

      @Stability(Stable) @Nullable default String getRecordName()
      The subdomain name for this record. This should be relative to the zone root name.

      For example, if you want to create a record for acme.example.com, specify "acme".

      You can also specify the fully qualified domain name which terminates with a ".". For example, "acme.example.com.".

      Default: zone root

    • getTtl

      @Stability(Stable) @Nullable default Duration getTtl()
      The resource record cache time to live (TTL).

      Default: Duration.minutes(30)

    • builder

      @Stability(Stable) static RecordSetOptions.Builder builder()
      Returns:
      a RecordSetOptions.Builder of RecordSetOptions