Edit This Page

route53

class pulumi_aws.route53.DelegationSet(resource_name, opts=None, reference_name=None, __name__=None, __opts__=None)

Provides a Route53 Delegation Set resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • reference_name (pulumi.Input[str]) – This is a reference name used in Caller Reference (helpful for identifying single delegation set amongst others)
name_servers = None

A list of authoritative name servers for the hosted zone (effectively a list of NS records).

reference_name = None

This is a reference name used in Caller Reference (helpful for identifying single delegation set amongst others)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.route53.GetDelegationSetResult(caller_reference=None, name_servers=None)

A collection of values returned by getDelegationSet.

class pulumi_aws.route53.GetZoneResult(caller_reference=None, comment=None, name=None, name_servers=None, resource_record_set_count=None, tags=None, vpc_id=None, zone_id=None, id=None)

A collection of values returned by getZone.

caller_reference = None

Caller Reference of the Hosted Zone.

comment = None

The comment field of the Hosted Zone.

name_servers = None

The list of DNS name servers for the Hosted Zone.

resource_record_set_count = None

the number of Record Set in the Hosted Zone

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.route53.HealthCheck(resource_name, opts=None, child_health_threshold=None, child_healthchecks=None, cloudwatch_alarm_name=None, cloudwatch_alarm_region=None, enable_sni=None, failure_threshold=None, fqdn=None, insufficient_data_health_status=None, invert_healthcheck=None, ip_address=None, measure_latency=None, port=None, reference_name=None, regions=None, request_interval=None, resource_path=None, search_string=None, tags=None, type=None, __name__=None, __opts__=None)

Provides a Route53 health check.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • child_health_threshold (pulumi.Input[int]) – The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
  • child_healthchecks (pulumi.Input[list]) – For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
  • cloudwatch_alarm_name (pulumi.Input[str]) – The name of the CloudWatch alarm.
  • cloudwatch_alarm_region (pulumi.Input[str]) – The CloudWatchRegion that the CloudWatch alarm was created in.
  • enable_sni (pulumi.Input[bool]) – A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS’ defaults: when the type is “HTTPS” enable_sni defaults to true, when type is anything else enable_sni defaults to false.
  • failure_threshold (pulumi.Input[int]) – The number of consecutive health checks that an endpoint must pass or fail.
  • fqdn (pulumi.Input[str]) – The fully qualified domain name of the endpoint to be checked.
  • insufficient_data_health_status (pulumi.Input[str]) – The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
  • invert_healthcheck (pulumi.Input[bool]) – A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
  • ip_address (pulumi.Input[str]) – The IP address of the endpoint to be checked.
  • measure_latency (pulumi.Input[bool]) – A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
  • port (pulumi.Input[int]) – The port of the endpoint to be checked.
  • reference_name (pulumi.Input[str]) – This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
  • regions (pulumi.Input[list]) – A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
  • request_interval (pulumi.Input[int]) – The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
  • resource_path (pulumi.Input[str]) – The path that you want Amazon Route 53 to request when performing health checks.
  • search_string (pulumi.Input[str]) – String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the health check.
  • type (pulumi.Input[str]) – The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED and CLOUDWATCH_METRIC.
child_health_threshold = None

The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive

child_healthchecks = None

For a specified parent health check, a list of HealthCheckId values for the associated child health checks.

cloudwatch_alarm_name = None

The name of the CloudWatch alarm.

cloudwatch_alarm_region = None

The CloudWatchRegion that the CloudWatch alarm was created in.

enable_sni = None

A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS’ defaults: when the type is “HTTPS” enable_sni defaults to true, when type is anything else enable_sni defaults to false.

failure_threshold = None

The number of consecutive health checks that an endpoint must pass or fail.

fqdn = None

The fully qualified domain name of the endpoint to be checked.

insufficient_data_health_status = None

The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.

invert_healthcheck = None

A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.

ip_address = None

The IP address of the endpoint to be checked.

measure_latency = None

A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.

port = None

The port of the endpoint to be checked.

reference_name = None

This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)

regions = None

A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.

request_interval = None

The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.

resource_path = None

The path that you want Amazon Route 53 to request when performing health checks.

search_string = None

String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.

tags = None

A mapping of tags to assign to the health check.

type = None

The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED and CLOUDWATCH_METRIC.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.route53.QueryLog(resource_name, opts=None, cloudwatch_log_group_arn=None, zone_id=None, __name__=None, __opts__=None)

Provides a Route53 query logging configuration resource.

NOTE: There are restrictions on the configuration of query logging. Notably, the CloudWatch log group must be in the us-east-1 region, a permissive CloudWatch log resource policy must be in place, and the Route53 hosted zone must be public. See Configuring Logging for DNS Queries for additional details.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • cloudwatch_log_group_arn (pulumi.Input[str]) – CloudWatch log group ARN to send query logs.
  • zone_id (pulumi.Input[str]) – Route53 hosted zone ID to enable query logs.
cloudwatch_log_group_arn = None

CloudWatch log group ARN to send query logs.

zone_id = None

Route53 hosted zone ID to enable query logs.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.route53.Record(resource_name, opts=None, aliases=None, allow_overwrite=None, failover_routing_policies=None, geolocation_routing_policies=None, health_check_id=None, latency_routing_policies=None, multivalue_answer_routing_policy=None, name=None, records=None, set_identifier=None, ttl=None, type=None, weighted_routing_policies=None, zone_id=None, __name__=None, __opts__=None)

Provides a Route53 record resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • aliases (pulumi.Input[list]) – An alias block. Conflicts with ttl & records. Alias record documented below.
  • allow_overwrite (pulumi.Input[bool]) – Allow creation of this record in Terraform to overwrite an existing record, if any. This does not prevent other resources within Terraform or manual Route53 changes from overwriting this record. true by default.
  • failover_routing_policies (pulumi.Input[list]) – A block indicating the routing behavior when associated health check fails. Conflicts with any other routing policy. Documented below.
  • geolocation_routing_policies (pulumi.Input[list]) – A block indicating a routing policy based on the geolocation of the requestor. Conflicts with any other routing policy. Documented below.
  • health_check_id (pulumi.Input[str]) – The health check the record should be associated with.
  • latency_routing_policies (pulumi.Input[list]) – A block indicating a routing policy based on the latency between the requestor and an AWS region. Conflicts with any other routing policy. Documented below.
  • multivalue_answer_routing_policy (pulumi.Input[bool]) – Set to true to indicate a multivalue answer routing policy. Conflicts with any other routing policy.
  • name (pulumi.Input[str]) – DNS domain name for a CloudFront distribution, S3 bucket, ELB, or another resource record set in this hosted zone.
  • records (pulumi.Input[list]) – A string list of records. To specify a single record value longer than 255 characters such as a TXT record for DKIM, add "" inside the Terraform configuration string (e.g. "first255characters""morecharacters").
  • set_identifier (pulumi.Input[str]) – Unique identifier to differentiate records with routing policies from one another. Required if using failover, geolocation, latency, or weighted routing policies documented below.
  • ttl (pulumi.Input[int]) – The TTL of the record.
  • type (pulumi.Input[str]) – PRIMARY or SECONDARY. A PRIMARY record will be served if its healthcheck is passing, otherwise the SECONDARY will be served. See http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html#dns-failover-failover-rrsets
  • weighted_routing_policies (pulumi.Input[list]) – A block indicating a weighted routing policy. Conflicts with any other routing policy. Documented below.
  • zone_id (pulumi.Input[str]) – Hosted zone ID for a CloudFront distribution, S3 bucket, ELB, or Route 53 hosted zone. See ``resource_elb.zone_id` <https://www.terraform.io/docs/providers/aws/r/elb.html#zone_id>`_ for example.
aliases = None

An alias block. Conflicts with ttl & records. Alias record documented below.

allow_overwrite = None

Allow creation of this record in Terraform to overwrite an existing record, if any. This does not prevent other resources within Terraform or manual Route53 changes from overwriting this record. true by default.

failover_routing_policies = None

A block indicating the routing behavior when associated health check fails. Conflicts with any other routing policy. Documented below.

fqdn = None

FQDN built using the zone domain and name.

geolocation_routing_policies = None

A block indicating a routing policy based on the geolocation of the requestor. Conflicts with any other routing policy. Documented below.

health_check_id = None

The health check the record should be associated with.

latency_routing_policies = None

A block indicating a routing policy based on the latency between the requestor and an AWS region. Conflicts with any other routing policy. Documented below.

multivalue_answer_routing_policy = None

Set to true to indicate a multivalue answer routing policy. Conflicts with any other routing policy.

name = None

DNS domain name for a CloudFront distribution, S3 bucket, ELB, or another resource record set in this hosted zone.

records = None

A string list of records. To specify a single record value longer than 255 characters such as a TXT record for DKIM, add "" inside the Terraform configuration string (e.g. "first255characters""morecharacters").

set_identifier = None

Unique identifier to differentiate records with routing policies from one another. Required if using failover, geolocation, latency, or weighted routing policies documented below.

ttl = None

The TTL of the record.

type = None

PRIMARY or SECONDARY. A PRIMARY record will be served if its healthcheck is passing, otherwise the SECONDARY will be served. See http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html#dns-failover-failover-rrsets

weighted_routing_policies = None

A block indicating a weighted routing policy. Conflicts with any other routing policy. Documented below.

zone_id = None

Hosted zone ID for a CloudFront distribution, S3 bucket, ELB, or Route 53 hosted zone. See ``resource_elb.zone_id` <https://www.terraform.io/docs/providers/aws/r/elb.html#zone_id>`_ for example.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.route53.Zone(resource_name, opts=None, comment=None, delegation_set_id=None, force_destroy=None, name=None, tags=None, vpcs=None, vpc_id=None, vpc_region=None, __name__=None, __opts__=None)

Manages a Route53 Hosted Zone.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • comment (pulumi.Input[str]) – A comment for the hosted zone. Defaults to ‘Managed by Terraform’.
  • delegation_set_id (pulumi.Input[str]) – The ID of the reusable delegation set whose NS records you want to assign to the hosted zone. Conflicts with vpc and vpc_id as delegation sets can only be used for public zones.
  • force_destroy (pulumi.Input[bool]) – Whether to destroy all records (possibly managed outside of Terraform) in the zone when destroying the zone.
  • name (pulumi.Input[str]) – This is the name of the hosted zone.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the zone.
  • vpcs (pulumi.Input[list]) – Configuration block(s) specifying VPC(s) to associate with a private hosted zone. Conflicts with delegation_set_id, vpc_id, and vpc_region in this resource and any ``aws_route53_zone_association` resource <https://www.terraform.io/docs/providers/aws/r/route53_zone_association.html>`_ specifying the same zone ID. Detailed below.
  • vpc_id (pulumi.Input[str]) – ID of the VPC to associate.
  • vpc_region (pulumi.Input[str]) – Region of the VPC to associate. Defaults to AWS provider region.
comment = None

A comment for the hosted zone. Defaults to ‘Managed by Terraform’.

delegation_set_id = None

The ID of the reusable delegation set whose NS records you want to assign to the hosted zone. Conflicts with vpc and vpc_id as delegation sets can only be used for public zones.

force_destroy = None

Whether to destroy all records (possibly managed outside of Terraform) in the zone when destroying the zone.

name = None

This is the name of the hosted zone.

name_servers = None

A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.

tags = None

A mapping of tags to assign to the zone.

vpcs = None

Configuration block(s) specifying VPC(s) to associate with a private hosted zone. Conflicts with delegation_set_id, vpc_id, and vpc_region in this resource and any ``aws_route53_zone_association` resource <https://www.terraform.io/docs/providers/aws/r/route53_zone_association.html>`_ specifying the same zone ID. Detailed below.

vpc_id = None

ID of the VPC to associate.

vpc_region = None

Region of the VPC to associate. Defaults to AWS provider region.

zone_id = None

The Hosted Zone ID. This can be referenced by zone records.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.route53.ZoneAssociation(resource_name, opts=None, vpc_id=None, vpc_region=None, zone_id=None, __name__=None, __opts__=None)

Manages a Route53 Hosted Zone VPC association. VPC associations can only be made on private zones.

NOTE: Unless explicit association ordering is required (e.g. a separate cross-account association authorization), usage of this resource is not recommended. Use the vpc configuration blocks available within the ``aws_route53_zone` resource <https://www.terraform.io/docs/providers/aws/r/route53_zone.html>`_ instead.

NOTE: Terraform provides both this standalone Zone VPC Association resource and exclusive VPC associations defined in-line in the ``aws_route53_zone` resource <https://www.terraform.io/docs/providers/aws/r/route53_zone.html>`_ via vpc configuration blocks. At this time, you cannot use those in-line VPC associations in conjunction with this resource and the same zone ID otherwise it will cause a perpetual difference in plan output. You can optionally use the generic Terraform resource lifecycle configuration block with ignore_changes in the aws_route53_zone resource to manage additional associations via this resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • vpc_id (pulumi.Input[str]) – The VPC to associate with the private hosted zone.
  • vpc_region (pulumi.Input[str]) – The VPC’s region. Defaults to the region of the AWS provider.
  • zone_id (pulumi.Input[str]) – The private hosted zone to associate.
vpc_id = None

The VPC to associate with the private hosted zone.

vpc_region = None

The VPC’s region. Defaults to the region of the AWS provider.

zone_id = None

The private hosted zone to associate.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_aws.route53.get_delegation_set(id=None)

aws_route53_delegation_set provides details about a specific Route 53 Delegation Set.

This data source allows to find a list of name servers associated with a specific delegation set.

pulumi_aws.route53.get_zone(caller_reference=None, comment=None, name=None, private_zone=None, resource_record_set_count=None, tags=None, vpc_id=None, zone_id=None)

aws_route53_zone provides details about a specific Route 53 Hosted Zone.

This data source allows to find a Hosted Zone ID given Hosted Zone name and certain search criteria.