Class SrvRecordProps
Construction properties for a SrvRecord.
Inheritance
Namespace: Amazon.CDK.AWS.Route53
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SrvRecordProps : Object, ISrvRecordProps, IRecordSetOptionsSyntax (vb)
Public Class SrvRecordProps
Inherits Object
Implements ISrvRecordProps, IRecordSetOptionsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.Route53;
GeoLocation geoLocation;
HealthCheck healthCheck;
HostedZone hostedZone;
var srvRecordProps = new SrvRecordProps {
Values = new [] { new SrvRecordValue {
HostName = "hostName",
Port = 123,
Priority = 123,
Weight = 123
} },
Zone = hostedZone,
// the properties below are optional
Comment = "comment",
DeleteExisting = false,
GeoLocation = geoLocation,
HealthCheck = healthCheck,
MultiValueAnswer = false,
RecordName = "recordName",
Region = "region",
SetIdentifier = "setIdentifier",
Ttl = Duration.Minutes(30),
Weight = 123
};Synopsis
Constructors
| SrvRecordProps() |
Properties
| Comment | A comment to add on the record. |
| DeleteExisting | Whether to delete the same record set in the hosted zone if it already exists (dangerous!). |
| GeoLocation | The geographical origin for this record to return DNS records based on the user's location. |
| HealthCheck | The health check to associate with the record set. |
| MultiValueAnswer | Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries. |
| RecordName | The subdomain name for this record. This should be relative to the zone root name. |
| Region | The Amazon EC2 Region where you created the resource that this resource record set refers to. |
| SetIdentifier | A string used to distinguish between different records with the same combination of DNS name and type. |
| Ttl | The resource record cache time to live (TTL). |
| Values | The values. |
| 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. |
| Zone | The hosted zone in which to define the new record. |
Constructors
SrvRecordProps()
public SrvRecordProps()Properties
Comment
A comment to add on the record.
public string Comment { get; set; }Property Value
System.String
Remarks
Default: no comment
DeleteExisting
Whether to delete the same record set in the hosted zone if it already exists (dangerous!).
public Nullable<bool> DeleteExisting { get; set; }Property Value
System.Nullable<System.Boolean>
Remarks
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
GeoLocation
The geographical origin for this record to return DNS records based on the user's location.
public GeoLocation GeoLocation { get; set; }Property Value
HealthCheck
The health check to associate with the record set.
public IHealthCheck HealthCheck { get; set; }Property Value
Remarks
Route53 will return this record set in response to DNS queries only if the health check is passing.
Default: - No health check configured
MultiValueAnswer
Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries.
public Nullable<bool> MultiValueAnswer { get; set; }Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
RecordName
The subdomain name for this record. This should be relative to the zone root name.
public string RecordName { get; set; }Property Value
System.String
Remarks
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
Region
The Amazon EC2 Region where you created the resource that this resource record set refers to.
public string Region { get; set; }Property Value
System.String
Remarks
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
SetIdentifier
A string used to distinguish between different records with the same combination of DNS name and type.
public string SetIdentifier { get; set; }Property Value
System.String
Remarks
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
Ttl
The resource record cache time to live (TTL).
public Duration Ttl { get; set; }Property Value
Remarks
Default: Duration.minutes(30)
Values
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.
public Nullable<double> Weight { get; set; }Property Value
System.Nullable<System.Double>
Remarks
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
See: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy-weighted.html
Zone
The hosted zone in which to define the new record.
public IHostedZone Zone { get; set; }Property Value