Package software.amazon.awscdk.services.route53

Class TxtRecord.Builder

java.lang.Object
software.amazon.awscdk.services.route53.TxtRecord.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<TxtRecord>
Enclosing class:
TxtRecord
@Stability(Stable) public static final class TxtRecord.Builder extends Object implements software.amazon.jsii.Builder<TxtRecord>
A fluent builder for TxtRecord.

  • Method Details

    • create

      @Stability(Stable) public static TxtRecord.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of TxtRecord.Builder.

    • zone

      @Stability(Stable) public TxtRecord.Builder zone(IHostedZone zone)
      The hosted zone in which to define the new record.

      Parameters:
      zone - The hosted zone in which to define the new record. This parameter is required.
      Returns:
      this

    • comment

      @Stability(Stable) public TxtRecord.Builder comment(String comment)
      A comment to add on the record.

      Default: no comment

      Parameters:
      comment - A comment to add on the record. This parameter is required.
      Returns:
      this

    • deleteExisting

      @Stability(Stable) public TxtRecord.Builder deleteExisting(Boolean deleteExisting)
      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

      Parameters:
      deleteExisting - Whether to delete the same record set in the hosted zone if it already exists (dangerous!). This parameter is required.
      Returns:
      this

    • geoLocation

      @Stability(Stable) public TxtRecord.Builder geoLocation(GeoLocation geoLocation)
      The geographical origin for this record to return DNS records based on the user's location.

      Parameters:
      geoLocation - The geographical origin for this record to return DNS records based on the user's location. This parameter is required.
      Returns:
      this

    • recordName

      @Stability(Stable) public TxtRecord.Builder recordName(String recordName)
      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

      Parameters:
      recordName - The subdomain name for this record. This should be relative to the zone root name. This parameter is required.
      Returns:
      this

    • ttl

      @Stability(Stable) public TxtRecord.Builder ttl(Duration ttl)
      The resource record cache time to live (TTL).

      Default: Duration.minutes(30)

      Parameters:
      ttl - The resource record cache time to live (TTL). This parameter is required.
      Returns:
      this

    • values

      @Stability(Stable) public TxtRecord.Builder values(List<String> values)
      The text values.

      Parameters:
      values - The text values. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public TxtRecord build()
      Specified by:
      build in interface software.amazon.jsii.Builder<TxtRecord>
      Returns:
      a newly built instance of TxtRecord.