Package software.amazon.awscdk.services.route53

Class ARecordAttrs.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • targetDns

      @Stability(Stable) public ARecordAttrs.Builder targetDns(String targetDns)
      Sets the value of
      invalid @link 
      ARecordAttrs#getTargetDns
      Parameters:
      targetDns - Existing A record DNS name to set RecordTarget. This parameter is required.
      Returns:
      this

    • zone

      @Stability(Stable) public ARecordAttrs.Builder zone(IHostedZone zone)
      Sets the value of RecordSetOptions.getZone()
      Parameters:
      zone - The hosted zone in which to define the new record. This parameter is required.
      Returns:
      this

    • comment

      @Stability(Stable) public ARecordAttrs.Builder comment(String comment)
      Sets the value of RecordSetOptions.getComment()
      Parameters:
      comment - A comment to add on the record.
      Returns:
      this

    • deleteExisting

      @Stability(Stable) public ARecordAttrs.Builder deleteExisting(Boolean deleteExisting)
      Sets the value of RecordSetOptions.getDeleteExisting()
      Parameters:
      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!

      Returns:
      this

    • geoLocation

      @Stability(Stable) public ARecordAttrs.Builder geoLocation(GeoLocation geoLocation)
      Sets the value of RecordSetOptions.getGeoLocation()
      Parameters:
      geoLocation - The geographical origin for this record to return DNS records based on the user's location.
      Returns:
      this

    • healthCheck

      @Stability(Stable) public ARecordAttrs.Builder healthCheck(IHealthCheck healthCheck)
      Sets the value of RecordSetOptions.getHealthCheck()
      Parameters:
      healthCheck - The health check to associate with the record set. Route53 will return this record set in response to DNS queries only if the health check is passing.
      Returns:
      this

    • multiValueAnswer

      @Stability(Stable) public ARecordAttrs.Builder multiValueAnswer(Boolean multiValueAnswer)
      Sets the value of RecordSetOptions.getMultiValueAnswer()
      Parameters:
      multiValueAnswer - Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries.
      Returns:
      this

    • recordName

      @Stability(Stable) public ARecordAttrs.Builder recordName(String recordName)
      Sets the value of RecordSetOptions.getRecordName()
      Parameters:
      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.".

      Returns:
      this

    • region

      @Stability(Stable) public ARecordAttrs.Builder region(String region)
      Sets the value of RecordSetOptions.getRegion()
      Parameters:
      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.

      Returns:
      this

    • setIdentifier

      @Stability(Stable) public ARecordAttrs.Builder setIdentifier(String setIdentifier)
      Sets the value of RecordSetOptions.getSetIdentifier()
      Parameters:
      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.

      Returns:
      this

    • ttl

      @Stability(Stable) public ARecordAttrs.Builder ttl(Duration ttl)
      Sets the value of RecordSetOptions.getTtl()
      Parameters:
      ttl - The resource record cache time to live (TTL).
      Returns:
      this

    • weight

      @Stability(Stable) public ARecordAttrs.Builder weight(Number weight)
      Sets the value of RecordSetOptions.getWeight()
      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. 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.

      Returns:
      this

    • build

      @Stability(Stable) public ARecordAttrs build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<ARecordAttrs>
      Returns:
      a new instance of ARecordAttrs
      Throws:
      NullPointerException - if any required attribute was not provided