route53

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.route53.AwaitableGetDelegationSetResult(caller_reference=None, id=None, name_servers=None)
class pulumi_aws.route53.AwaitableGetResolverRuleResult(arn=None, domain_name=None, name=None, owner_id=None, resolver_endpoint_id=None, resolver_rule_id=None, rule_type=None, share_status=None, tags=None, id=None)
class pulumi_aws.route53.AwaitableGetResolverRulesResult(owner_id=None, resolver_endpoint_id=None, resolver_rule_ids=None, rule_type=None, share_status=None, id=None)
class pulumi_aws.route53.AwaitableGetZoneResult(caller_reference=None, comment=None, linked_service_description=None, linked_service_principal=None, name=None, name_servers=None, private_zone=None, resource_record_set_count=None, tags=None, vpc_id=None, zone_id=None, id=None)
class pulumi_aws.route53.DelegationSet(resource_name, opts=None, reference_name=None, __props__=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)

static get(resource_name, id, opts=None, name_servers=None, reference_name=None)

Get an existing DelegationSet resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name_servers (pulumi.Input[list]) – A list of authoritative name servers for the hosted zone (effectively a list of NS records).

  • reference_name (pulumi.Input[str]) – 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, id=None, name_servers=None)

A collection of values returned by getDelegationSet.

class pulumi_aws.route53.GetResolverRuleResult(arn=None, domain_name=None, name=None, owner_id=None, resolver_endpoint_id=None, resolver_rule_id=None, rule_type=None, share_status=None, tags=None, id=None)

A collection of values returned by getResolverRule.

arn = None

The ARN (Amazon Resource Name) for the resolver rule.

owner_id = None

When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

share_status = None

Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account. Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME

tags = None

A mapping of tags assigned to the resolver rule.

id = None

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

class pulumi_aws.route53.GetResolverRulesResult(owner_id=None, resolver_endpoint_id=None, resolver_rule_ids=None, rule_type=None, share_status=None, id=None)

A collection of values returned by getResolverRules.

resolver_rule_ids = None

The IDs of the matched resolver rules.

id = None

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

class pulumi_aws.route53.GetZoneResult(caller_reference=None, comment=None, linked_service_description=None, linked_service_principal=None, name=None, name_servers=None, private_zone=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.

linked_service_description = None

The description provided by the service that created the Hosted Zone (e.g. arn:aws:servicediscovery:us-east-1:1234567890:namespace/ns-xxxxxxxxxxxxxxxx).

linked_service_principal = None

The service that created the Hosted Zone (e.g. servicediscovery.amazonaws.com).

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, __props__=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[float]) – 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[float]) – 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[float]) – 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[float]) – 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.

static get(resource_name, id, 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)

Get an existing HealthCheck resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • child_health_threshold (pulumi.Input[float]) – 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[float]) – 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[float]) – 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[float]) – 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.

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, __props__=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.

static get(resource_name, id, opts=None, cloudwatch_log_group_arn=None, zone_id=None)

Get an existing QueryLog resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

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, __props__=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 to overwrite an existing record, if any. This does not affect the ability to update the record using this provider and does not prevent other resources within this provider or manual Route 53 changes outside this provider from overwriting this record. false by default. This configuration is not recommended for most environments.

  • 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 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[float]) – 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.

The aliases object supports the following:

  • evaluateTargetHealth (pulumi.Input[bool]) - Set to true if you want Route 53 to determine whether to respond to DNS queries using this resource record set by checking the health of the resource record set. Some resources have special requirements, see related part of documentation.

  • name (pulumi.Input[str]) - DNS domain name for a CloudFront distribution, S3 bucket, ELB, or another resource record set in this hosted zone.

  • 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.

The failover_routing_policies object supports the following:

The geolocation_routing_policies object supports the following:

The latency_routing_policies object supports the following:

The weighted_routing_policies object supports the following:

aliases = None

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

  • evaluateTargetHealth (bool) - Set to true if you want Route 53 to determine whether to respond to DNS queries using this resource record set by checking the health of the resource record set. Some resources have special requirements, see related part of documentation.

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

  • zone_id (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.

allow_overwrite = None

Allow creation of this record to overwrite an existing record, if any. This does not affect the ability to update the record using this provider and does not prevent other resources within this provider or manual Route 53 changes outside this provider from overwriting this record. false by default. This configuration is not recommended for most environments.

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 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.

static get(resource_name, id, opts=None, aliases=None, allow_overwrite=None, failover_routing_policies=None, fqdn=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)

Get an existing Record resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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 to overwrite an existing record, if any. This does not affect the ability to update the record using this provider and does not prevent other resources within this provider or manual Route 53 changes outside this provider from overwriting this record. false by default. This configuration is not recommended for most environments.

  • 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.

  • fqdn (pulumi.Input[str]) –

    FQDN built using the zone domain and name.

  • 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 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[float]) – 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.

The aliases object supports the following:

  • evaluateTargetHealth (pulumi.Input[bool]) - Set to true if you want Route 53 to determine whether to respond to DNS queries using this resource record set by checking the health of the resource record set. Some resources have special requirements, see related part of documentation.

  • name (pulumi.Input[str]) - DNS domain name for a CloudFront distribution, S3 bucket, ELB, or another resource record set in this hosted zone.

  • 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.

The failover_routing_policies object supports the following:

The geolocation_routing_policies object supports the following:

The latency_routing_policies object supports the following:

The weighted_routing_policies object supports the following:

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.ResolverEndpoint(resource_name, opts=None, direction=None, ip_addresses=None, name=None, security_group_ids=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides a Route 53 Resolver endpoint resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • direction (pulumi.Input[str]) – The direction of DNS queries to or from the Route 53 Resolver endpoint. Valid values are INBOUND (resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC) or OUTBOUND (resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC).

  • ip_addresses (pulumi.Input[list]) – The subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network (for outbound endpoints) or on the way from your network to your VPCs (for inbound endpoints). Described below.

  • name (pulumi.Input[str]) – The friendly name of the Route 53 Resolver endpoint.

  • security_group_ids (pulumi.Input[list]) – The ID of one or more security groups that you want to use to control access to this VPC.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The ip_addresses object supports the following:

  • ip (pulumi.Input[str]) - The IP address in the subnet that you want to use for DNS queries.

  • ipId (pulumi.Input[str])

  • subnet_id (pulumi.Input[str]) - The ID of the subnet that contains the IP address.

arn = None

The ARN of the Route 53 Resolver endpoint.

direction = None

The direction of DNS queries to or from the Route 53 Resolver endpoint. Valid values are INBOUND (resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC) or OUTBOUND (resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC).

host_vpc_id = None

The ID of the VPC that you want to create the resolver endpoint in.

ip_addresses = None

The subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network (for outbound endpoints) or on the way from your network to your VPCs (for inbound endpoints). Described below.

  • ip (str) - The IP address in the subnet that you want to use for DNS queries.

  • ipId (str)

  • subnet_id (str) - The ID of the subnet that contains the IP address.

name = None

The friendly name of the Route 53 Resolver endpoint.

security_group_ids = None

The ID of one or more security groups that you want to use to control access to this VPC.

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, arn=None, direction=None, host_vpc_id=None, ip_addresses=None, name=None, security_group_ids=None, tags=None)

Get an existing ResolverEndpoint resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The ARN of the Route 53 Resolver endpoint.

  • direction (pulumi.Input[str]) – The direction of DNS queries to or from the Route 53 Resolver endpoint. Valid values are INBOUND (resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC) or OUTBOUND (resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC).

  • host_vpc_id (pulumi.Input[str]) – The ID of the VPC that you want to create the resolver endpoint in.

  • ip_addresses (pulumi.Input[list]) – The subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network (for outbound endpoints) or on the way from your network to your VPCs (for inbound endpoints). Described below.

  • name (pulumi.Input[str]) – The friendly name of the Route 53 Resolver endpoint.

  • security_group_ids (pulumi.Input[list]) – The ID of one or more security groups that you want to use to control access to this VPC.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The ip_addresses object supports the following:

  • ip (pulumi.Input[str]) - The IP address in the subnet that you want to use for DNS queries.

  • ipId (pulumi.Input[str])

  • subnet_id (pulumi.Input[str]) - The ID of the subnet that contains the IP address.

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.ResolverRule(resource_name, opts=None, domain_name=None, name=None, resolver_endpoint_id=None, rule_type=None, tags=None, target_ips=None, __props__=None, __name__=None, __opts__=None)

Provides a Route53 Resolver rule.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • domain_name (pulumi.Input[str]) – DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.

  • name (pulumi.Input[str]) – A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

  • resolver_endpoint_id (pulumi.Input[str]) – The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify using target_ip. This argument should only be specified for FORWARD type rules.

  • rule_type (pulumi.Input[str]) – The rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • target_ips (pulumi.Input[list]) – Configuration block(s) indicating the IPs that you want Resolver to forward DNS queries to (documented below). This argument should only be specified for FORWARD type rules.

The target_ips object supports the following:

  • ip (pulumi.Input[str]) - One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

  • port (pulumi.Input[float]) - The port at ip that you want to forward DNS queries to. Default value is 53

arn = None

The ARN (Amazon Resource Name) for the resolver rule.

domain_name = None

DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.

name = None

A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

owner_id = None

When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

resolver_endpoint_id = None

The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify using target_ip. This argument should only be specified for FORWARD type rules.

rule_type = None

The rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.

share_status = None

Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account. Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME

tags = None

A mapping of tags to assign to the resource.

target_ips = None

Configuration block(s) indicating the IPs that you want Resolver to forward DNS queries to (documented below). This argument should only be specified for FORWARD type rules.

  • ip (str) - One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

  • port (float) - The port at ip that you want to forward DNS queries to. Default value is 53

static get(resource_name, id, opts=None, arn=None, domain_name=None, name=None, owner_id=None, resolver_endpoint_id=None, rule_type=None, share_status=None, tags=None, target_ips=None)

Get an existing ResolverRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The ARN (Amazon Resource Name) for the resolver rule.

  • domain_name (pulumi.Input[str]) – DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.

  • name (pulumi.Input[str]) – A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

  • owner_id (pulumi.Input[str]) – When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

  • resolver_endpoint_id (pulumi.Input[str]) – The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify using target_ip. This argument should only be specified for FORWARD type rules.

  • rule_type (pulumi.Input[str]) – The rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.

  • share_status (pulumi.Input[str]) – Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account. Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • target_ips (pulumi.Input[list]) – Configuration block(s) indicating the IPs that you want Resolver to forward DNS queries to (documented below). This argument should only be specified for FORWARD type rules.

The target_ips object supports the following:

  • ip (pulumi.Input[str]) - One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

  • port (pulumi.Input[float]) - The port at ip that you want to forward DNS queries to. Default value is 53

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.ResolverRuleAssociation(resource_name, opts=None, name=None, resolver_rule_id=None, vpc_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Route53 Resolver rule association.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – A name for the association that you’re creating between a resolver rule and a VPC.

  • resolver_rule_id (pulumi.Input[str]) – The ID of the resolver rule that you want to associate with the VPC.

  • vpc_id (pulumi.Input[str]) – The ID of the VPC that you want to associate the resolver rule with.

name = None

A name for the association that you’re creating between a resolver rule and a VPC.

resolver_rule_id = None

The ID of the resolver rule that you want to associate with the VPC.

vpc_id = None

The ID of the VPC that you want to associate the resolver rule with.

static get(resource_name, id, opts=None, name=None, resolver_rule_id=None, vpc_id=None)

Get an existing ResolverRuleAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – A name for the association that you’re creating between a resolver rule and a VPC.

  • resolver_rule_id (pulumi.Input[str]) – The ID of the resolver rule that you want to associate with the VPC.

  • vpc_id (pulumi.Input[str]) – The ID of the VPC that you want to associate the resolver rule with.

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, __props__=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 Pulumi’.

  • 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 as delegation sets can only be used for public zones.

  • force_destroy (pulumi.Input[bool]) – Whether to destroy all records (possibly managed outside of this provider) 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 the delegation_set_id argument in this resource and any ``route53.ZoneAssociation` resource <https://www.terraform.io/docs/providers/aws/r/route53_zone_association.html>`_ specifying the same zone ID. Detailed below.

The vpcs object supports the following:

  • 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 Pulumi’.

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 as delegation sets can only be used for public zones.

force_destroy = None

Whether to destroy all records (possibly managed outside of this provider) 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 the delegation_set_id argument in this resource and any ``route53.ZoneAssociation` resource <https://www.terraform.io/docs/providers/aws/r/route53_zone_association.html>`_ specifying the same zone ID. Detailed below.

  • vpc_id (str) - ID of the VPC to associate.

  • vpc_region (str) - 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.

static get(resource_name, id, opts=None, comment=None, delegation_set_id=None, force_destroy=None, name=None, name_servers=None, tags=None, vpcs=None, zone_id=None)

Get an existing Zone resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • comment (pulumi.Input[str]) – A comment for the hosted zone. Defaults to ‘Managed by Pulumi’.

  • 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 as delegation sets can only be used for public zones.

  • force_destroy (pulumi.Input[bool]) – Whether to destroy all records (possibly managed outside of this provider) in the zone when destroying the zone.

  • name (pulumi.Input[str]) – This is the name of the hosted zone.

  • name_servers (pulumi.Input[list]) –

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

  • 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 the delegation_set_id argument in this resource and any ``route53.ZoneAssociation` resource <https://www.terraform.io/docs/providers/aws/r/route53_zone_association.html>`_ specifying the same zone ID. Detailed below.

  • zone_id (pulumi.Input[str]) – The Hosted Zone ID. This can be referenced by zone records.

The vpcs object supports the following:

  • 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.

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, __props__=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 ``route53.Zone` resource <https://www.terraform.io/docs/providers/aws/r/route53_zone.html>`_ instead.

NOTE: This provider provides both this standalone Zone VPC Association resource and exclusive VPC associations defined in-line in the ``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 this provider resource lifecycle configuration block with ignore_changes in the 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.

static get(resource_name, id, opts=None, vpc_id=None, vpc_region=None, zone_id=None)

Get an existing ZoneAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

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, opts=None)

route53.DelegationSet 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.

Parameters

id (str) – The Hosted Zone id of the desired delegation set.

pulumi_aws.route53.get_resolver_rule(domain_name=None, name=None, resolver_endpoint_id=None, resolver_rule_id=None, rule_type=None, tags=None, opts=None)

route53.ResolverRule provides details about a specific Route53 Resolver rule.

Parameters
  • domain_name (str) – The domain name the desired resolver rule forwards DNS queries for. Conflicts with resolver_rule_id.

  • name (str) – The friendly name of the desired resolver rule. Conflicts with resolver_rule_id.

  • resolver_endpoint_id (str) – The ID of the outbound resolver endpoint of the desired resolver rule. Conflicts with resolver_rule_id.

  • resolver_rule_id (str) – The ID of the desired resolver rule. Conflicts with domain_name, name, resolver_endpoint_id and rule_type.

  • rule_type (str) – The rule type of the desired resolver rule. Valid values are FORWARD, SYSTEM and RECURSIVE. Conflicts with resolver_rule_id.

pulumi_aws.route53.get_resolver_rules(owner_id=None, resolver_endpoint_id=None, rule_type=None, share_status=None, opts=None)

route53.getResolverRules provides details about a set of Route53 Resolver rules.

Parameters
  • owner_id (str) – When the desired resolver rules are shared with another AWS account, the account ID of the account that the rules are shared with.

  • resolver_endpoint_id (str) – The ID of the outbound resolver endpoint for the desired resolver rules.

  • rule_type (str) – The rule type of the desired resolver rules. Valid values are FORWARD, SYSTEM and RECURSIVE.

  • share_status (str) – Whether the desired resolver rules are shared and, if so, whether the current account is sharing the rules with another account, or another account is sharing the rules with the current account. Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME

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

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.

Parameters
  • name (str) – The Hosted Zone name of the desired Hosted Zone.

  • private_zone (bool) – Used with name field to get a private Hosted Zone.

  • tags (dict) – Used with name field. A mapping of tags, each pair of which must exactly match a pair on the desired Hosted Zone.

  • vpc_id (str) – Used with name field to get a private Hosted Zone associated with the vpc_id (in this case, private_zone is not mandatory).

  • zone_id (str) – The Hosted Zone id of the desired Hosted Zone.