Class TxtRecordProps.Builder
java.lang.Object
software.amazon.awscdk.services.route53.TxtRecordProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<TxtRecordProps>
- Enclosing interface:
TxtRecordProps
@Stability(Stable)
public static final class TxtRecordProps.Builder
extends Object
implements software.amazon.jsii.Builder<TxtRecordProps>
A builder for
TxtRecordProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.Sets the value ofRecordSetOptions.getComment()
deleteExisting
(Boolean deleteExisting) Sets the value ofRecordSetOptions.getDeleteExisting()
geoLocation
(GeoLocation geoLocation) Sets the value ofRecordSetOptions.getGeoLocation()
recordName
(String recordName) Sets the value ofRecordSetOptions.getRecordName()
Sets the value ofRecordSetOptions.getTtl()
Sets the value ofTxtRecordProps.getValues()
zone
(IHostedZone zone) Sets the value ofRecordSetOptions.getZone()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
values
Sets the value ofTxtRecordProps.getValues()
- Parameters:
values
- The text values. This parameter is required.- Returns:
this
-
zone
Sets the value ofRecordSetOptions.getZone()
- Parameters:
zone
- The hosted zone in which to define the new record. This parameter is required.- Returns:
this
-
comment
Sets the value ofRecordSetOptions.getComment()
- Parameters:
comment
- A comment to add on the record.- Returns:
this
-
deleteExisting
Sets the value ofRecordSetOptions.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 totrue
as soon as the resource is added to the stack. Changing an existing Record Set'sdeleteExisting
property fromfalse -> true
after deployment will delete the record!- Returns:
this
-
geoLocation
Sets the value ofRecordSetOptions.getGeoLocation()
- Parameters:
geoLocation
- The geographical origin for this record to return DNS records based on the user's location.- Returns:
this
-
recordName
Sets the value ofRecordSetOptions.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
-
ttl
Sets the value ofRecordSetOptions.getTtl()
- Parameters:
ttl
- The resource record cache time to live (TTL).- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<TxtRecordProps>
- Returns:
- a new instance of
TxtRecordProps
- Throws:
NullPointerException
- if any required attribute was not provided
-