SrvRecordProps

class aws_cdk.aws_route53.SrvRecordProps(*, zone, comment=None, delete_existing=None, record_name=None, ttl=None, values)

Bases: RecordSetOptions

Construction properties for a SrvRecord.

Parameters
  • zone (IHostedZone) – The hosted zone in which to define the new record.

  • comment (Optional[str]) – A comment to add on the record. Default: no comment

  • delete_existing (Optional[bool]) – Whether to delete the same record set in the hosted zone if it already exists. 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. Default: false

  • record_name (Optional[str]) – The domain name for this record. Default: zone root

  • ttl (Optional[Duration]) – The resource record cache time to live (TTL). Default: Duration.minutes(30)

  • values (Sequence[Union[SrvRecordValue, Dict[str, Any]]]) – The values.

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_route53 as route53

# hosted_zone: route53.HostedZone

srv_record_props = route53.SrvRecordProps(
    values=[route53.SrvRecordValue(
        host_name="hostName",
        port=123,
        priority=123,
        weight=123
    )],
    zone=hosted_zone,

    # the properties below are optional
    comment="comment",
    delete_existing=False,
    record_name="recordName",
    ttl=cdk.Duration.minutes(30)
)

Attributes

comment

A comment to add on the record.

Default

no comment

Return type

Optional[str]

delete_existing

Whether to delete the same record set in the hosted zone if it already exists.

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.

Default

false

Return type

Optional[bool]

record_name

The domain name for this record.

Default

zone root

Return type

Optional[str]

ttl

The resource record cache time to live (TTL).

Default

Duration.minutes(30)

Return type

Optional[Duration]

values

The values.

Return type

List[SrvRecordValue]

zone

The hosted zone in which to define the new record.

Return type

IHostedZone