Package software.amazon.awscdk.services.route53

Class RecordSet.Builder

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

  • Method Details

    • create

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

    • zone

      @Stability(Stable) public RecordSet.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 RecordSet.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 RecordSet.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 RecordSet.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

    • multiValueAnswer

      @Stability(Stable) public RecordSet.Builder multiValueAnswer(Boolean multiValueAnswer)
      Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries.

      Default: false

      Parameters:
      multiValueAnswer - Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries. This parameter is required.
      Returns:
      this

    • recordName

      @Stability(Stable) public RecordSet.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

    • region

      @Stability(Stable) public RecordSet.Builder region(String region)
      The Amazon EC2 Region where you created the resource that this resource record set refers to.

      The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

      When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.

      Default: - Do not set latency based routing

      Parameters:
      region - The Amazon EC2 Region where you created the resource that this resource record set refers to. This parameter is required.
      Returns:
      this
      See Also:

    • setIdentifier

      @Stability(Stable) public RecordSet.Builder setIdentifier(String setIdentifier)
      A string used to distinguish between different records with the same combination of DNS name and type.

      It can only be set when either weight or geoLocation is defined.

      This parameter must be between 1 and 128 characters in length.

      Default: - Auto generated string

      Parameters:
      setIdentifier - A string used to distinguish between different records with the same combination of DNS name and type. This parameter is required.
      Returns:
      this

    • ttl

      @Stability(Stable) public RecordSet.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

    • weight

      @Stability(Stable) public RecordSet.Builder weight(Number weight)
      Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set.

      Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total.

      This value can be a number between 0 and 255.

      Default: - Do not set weighted routing

      Parameters:
      weight - Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. This parameter is required.
      Returns:
      this
      See Also:

    • recordType

      @Stability(Stable) public RecordSet.Builder recordType(RecordType recordType)
      The record type.

      Parameters:
      recordType - The record type. This parameter is required.
      Returns:
      this

    • target

      @Stability(Stable) public RecordSet.Builder target(RecordTarget target)
      The target for this record, either RecordTarget.fromValues() or RecordTarget.fromAlias().

      Parameters:
      target - The target for this record, either RecordTarget.fromValues() or RecordTarget.fromAlias(). This parameter is required.
      Returns:
      this

    • build

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