io.cloudshiftdev.awscdk.services.route53.SrvRecord.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.route53
import io.cloudshiftdev.awscdk.Duration
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import kotlin.Boolean
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* A DNS SRV record.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.*;
* import io.cloudshiftdev.awscdk.services.route53.*;
* GeoLocation geoLocation;
* HostedZone hostedZone;
* SrvRecord srvRecord = SrvRecord.Builder.create(this, "MySrvRecord")
* .values(List.of(SrvRecordValue.builder()
* .hostName("hostName")
* .port(123)
* .priority(123)
* .weight(123)
* .build()))
* .zone(hostedZone)
* // the properties below are optional
* .comment("comment")
* .deleteExisting(false)
* .geoLocation(geoLocation)
* .multiValueAnswer(false)
* .recordName("recordName")
* .region("region")
* .setIdentifier("setIdentifier")
* .ttl(Duration.minutes(30))
* .weight(123)
* .build();
* ```
*/
public open class SrvRecord(
cdkObject: software.amazon.awscdk.services.route53.SrvRecord,
) : RecordSet(cdkObject) {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: SrvRecordProps,
) :
this(software.amazon.awscdk.services.route53.SrvRecord(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(SrvRecordProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: SrvRecordProps.Builder.() -> Unit,
) : this(scope, id, SrvRecordProps(props)
)
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.route53.SrvRecord].
*/
@CdkDslMarker
public interface Builder {
/**
* A comment to add on the record.
*
* Default: no comment
*
* @param comment A comment to add on the record.
*/
public fun comment(comment: String)
/**
* 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
*
* @param deleteExisting Whether to delete the same record set in the hosted zone if it already
* exists (dangerous!).
*/
public fun deleteExisting(deleteExisting: Boolean)
/**
* The geographical origin for this record to return DNS records based on the user's location.
*
* @param geoLocation The geographical origin for this record to return DNS records based on the
* user's location.
*/
public fun geoLocation(geoLocation: GeoLocation)
/**
* 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
*
* @param setIdentifier A string used to distinguish between different records with the same
* combination of DNS name and type.
*/
public fun identifier(setIdentifier: String)
/**
* Whether to return multiple values, such as IP addresses for your web servers, in response to
* DNS queries.
*
* Default: false
*
* @param multiValueAnswer Whether to return multiple values, such as IP addresses for your web
* servers, in response to DNS queries.
*/
public fun multiValueAnswer(multiValueAnswer: Boolean)
/**
* 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
*
* @param recordName The subdomain name for this record. This should be relative to the zone
* root name.
*/
public fun recordName(recordName: String)
/**
* 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
*
* [Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordset.html#cfn-route53-recordset-region)
* @param region The Amazon EC2 Region where you created the resource that this resource record
* set refers to.
*/
public fun region(region: String)
/**
* The resource record cache time to live (TTL).
*
* Default: Duration.minutes(30)
*
* @param ttl The resource record cache time to live (TTL).
*/
public fun ttl(ttl: Duration)
/**
* The values.
*
* @param values The values.
*/
public fun values(values: List)
/**
* The values.
*
* @param values The values.
*/
public fun values(vararg values: SrvRecordValue)
/**
* 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
*
* [Documentation](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy-weighted.html)
* @param 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 fun weight(weight: Number)
/**
* The hosted zone in which to define the new record.
*
* @param zone The hosted zone in which to define the new record.
*/
public fun zone(zone: IHostedZone)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder: software.amazon.awscdk.services.route53.SrvRecord.Builder =
software.amazon.awscdk.services.route53.SrvRecord.Builder.create(scope, id)
/**
* A comment to add on the record.
*
* Default: no comment
*
* @param comment A comment to add on the record.
*/
override fun comment(comment: String) {
cdkBuilder.comment(comment)
}
/**
* 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
*
* @param deleteExisting Whether to delete the same record set in the hosted zone if it already
* exists (dangerous!).
*/
override fun deleteExisting(deleteExisting: Boolean) {
cdkBuilder.deleteExisting(deleteExisting)
}
/**
* The geographical origin for this record to return DNS records based on the user's location.
*
* @param geoLocation The geographical origin for this record to return DNS records based on the
* user's location.
*/
override fun geoLocation(geoLocation: GeoLocation) {
cdkBuilder.geoLocation(geoLocation.let(GeoLocation.Companion::unwrap))
}
/**
* 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
*
* @param setIdentifier A string used to distinguish between different records with the same
* combination of DNS name and type.
*/
override fun identifier(setIdentifier: String) {
cdkBuilder.setIdentifier(setIdentifier)
}
/**
* Whether to return multiple values, such as IP addresses for your web servers, in response to
* DNS queries.
*
* Default: false
*
* @param multiValueAnswer Whether to return multiple values, such as IP addresses for your web
* servers, in response to DNS queries.
*/
override fun multiValueAnswer(multiValueAnswer: Boolean) {
cdkBuilder.multiValueAnswer(multiValueAnswer)
}
/**
* 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
*
* @param recordName The subdomain name for this record. This should be relative to the zone
* root name.
*/
override fun recordName(recordName: String) {
cdkBuilder.recordName(recordName)
}
/**
* 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
*
* [Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordset.html#cfn-route53-recordset-region)
* @param region The Amazon EC2 Region where you created the resource that this resource record
* set refers to.
*/
override fun region(region: String) {
cdkBuilder.region(region)
}
/**
* The resource record cache time to live (TTL).
*
* Default: Duration.minutes(30)
*
* @param ttl The resource record cache time to live (TTL).
*/
override fun ttl(ttl: Duration) {
cdkBuilder.ttl(ttl.let(Duration.Companion::unwrap))
}
/**
* The values.
*
* @param values The values.
*/
override fun values(values: List) {
cdkBuilder.values(values.map(SrvRecordValue.Companion::unwrap))
}
/**
* The values.
*
* @param values The values.
*/
override fun values(vararg values: SrvRecordValue): Unit = values(values.toList())
/**
* 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
*
* [Documentation](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy-weighted.html)
* @param 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.
*/
override fun weight(weight: Number) {
cdkBuilder.weight(weight)
}
/**
* The hosted zone in which to define the new record.
*
* @param zone The hosted zone in which to define the new record.
*/
override fun zone(zone: IHostedZone) {
cdkBuilder.zone(zone.let(IHostedZone.Companion::unwrap))
}
public fun build(): software.amazon.awscdk.services.route53.SrvRecord = cdkBuilder.build()
}
public companion object {
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): SrvRecord {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return SrvRecord(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.route53.SrvRecord): SrvRecord =
SrvRecord(cdkObject)
internal fun unwrap(wrapped: SrvRecord): software.amazon.awscdk.services.route53.SrvRecord =
wrapped.cdkObject as software.amazon.awscdk.services.route53.SrvRecord
}
}