Class MxRecord.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<MxRecord>
- Enclosing class:
MxRecord
MxRecord
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
A comment to add on the record.static MxRecord.Builder
deleteExisting
(Boolean deleteExisting) Whether to delete the same record set in the hosted zone if it already exists (dangerous!).geoLocation
(GeoLocation geoLocation) The geographical origin for this record to return DNS records based on the user's location.multiValueAnswer
(Boolean multiValueAnswer) Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries.recordName
(String recordName) The subdomain name for this record.The Amazon EC2 Region where you created the resource that this resource record set refers to.setIdentifier
(String setIdentifier) A string used to distinguish between different records with the same combination of DNS name and type.The resource record cache time to live (TTL).values
(List<? extends MxRecordValue> values) The values.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.zone
(IHostedZone zone) The hosted zone in which to define the new record.
-
Method Details
-
create
@Stability(Stable) public static MxRecord.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.- Returns:
- a new instance of
MxRecord.Builder
.
-
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
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
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!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
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
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
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
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
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
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
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:
-
values
The values.- Parameters:
values
- The values. This parameter is required.- Returns:
this
-
build
-