# frozen_string_literal: true
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
module Aws::Route53
module Types
# A complex type that contains the type of limit that you specified in
# the request and the current value for that limit.
#
# @!attribute [rw] type
# The limit that you requested. Valid values include the following:
#
# * **MAX\_HEALTH\_CHECKS\_BY\_OWNER**\: The maximum number of health
# checks that you can create using the current account.
#
# * **MAX\_HOSTED\_ZONES\_BY\_OWNER**\: The maximum number of hosted
# zones that you can create using the current account.
#
# * **MAX\_REUSABLE\_DELEGATION\_SETS\_BY\_OWNER**\: The maximum
# number of reusable delegation sets that you can create using the
# current account.
#
# * **MAX\_TRAFFIC\_POLICIES\_BY\_OWNER**\: The maximum number of
# traffic policies that you can create using the current account.
#
# * **MAX\_TRAFFIC\_POLICY\_INSTANCES\_BY\_OWNER**\: The maximum
# number of traffic policy instances that you can create using the
# current account. (Traffic policy instances are referred to as
# traffic flow policy records in the Amazon Route 53 console.)
# @return [String]
#
# @!attribute [rw] value
# The current value for the limit that is specified by [Type][1].
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AccountLimit.html#Route53-Type-AccountLimit-Type
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/AccountLimit AWS API Documentation
#
class AccountLimit < Struct.new(
:type,
:value)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass ActivateKeySigningKeyRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# name: "SigningKeyName", # required
# }
#
# @!attribute [rw] hosted_zone_id
# A unique string used to identify a hosted zone.
# @return [String]
#
# @!attribute [rw] name
# A string used to identify a key-signing key (KSK). `Name` can
# include numbers, letters, and underscores (\_). `Name` must be
# unique for each key-signing key in the same hosted zone.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ActivateKeySigningKeyRequest AWS API Documentation
#
class ActivateKeySigningKeyRequest < Struct.new(
:hosted_zone_id,
:name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] change_info
# A complex type that describes change information about changes made
# to your hosted zone.
# @return [Types::ChangeInfo]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ActivateKeySigningKeyResponse AWS API Documentation
#
class ActivateKeySigningKeyResponse < Struct.new(
:change_info)
SENSITIVE = []
include Aws::Structure
end
# A complex type that identifies the CloudWatch alarm that you want
# Amazon Route 53 health checkers to use to determine whether the
# specified health check is healthy.
#
# @note When making an API call, you may pass AlarmIdentifier
# data as a hash:
#
# {
# region: "us-east-1", # required, accepts us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-central-1, eu-west-1, eu-west-2, eu-west-3, ap-east-1, me-south-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, cn-northwest-1, cn-north-1, af-south-1, eu-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1
# name: "AlarmName", # required
# }
#
# @!attribute [rw] region
# For the CloudWatch alarm that you want Route 53 health checkers to
# use to determine whether this health check is healthy, the region
# that the alarm was created in.
#
# For the current list of CloudWatch regions, see [Amazon CloudWatch
# endpoints and quotas][1] in the *Amazon Web Services General
# Reference*.
#
#
#
# [1]: https://docs.aws.amazon.com/general/latest/gr/cw_region.html
# @return [String]
#
# @!attribute [rw] name
# The name of the CloudWatch alarm that you want Amazon Route 53
# health checkers to use to determine whether this health check is
# healthy.
#
# <note markdown="1"> Route 53 supports CloudWatch alarms with the following features:
#
# * Standard-resolution metrics. High-resolution metrics aren't
# supported. For more information, see [High-Resolution Metrics][1]
# in the *Amazon CloudWatch User Guide*.
#
# * Statistics: Average, Minimum, Maximum, Sum, and SampleCount.
# Extended statistics aren't supported.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/AlarmIdentifier AWS API Documentation
#
class AlarmIdentifier < Struct.new(
:region,
:name)
SENSITIVE = []
include Aws::Structure
end
# *Alias resource record sets only:* Information about the Amazon Web
# Services resource, such as a CloudFront distribution or an Amazon S3
# bucket, that you want to route traffic to.
#
# When creating resource record sets for a private hosted zone, note the
# following:
#
# * Creating geolocation alias resource record sets or latency alias
# resource record sets in a private hosted zone is unsupported.
#
# * For information about creating failover resource record sets in a
# private hosted zone, see [Configuring Failover in a Private Hosted
# Zone][1].
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html
#
# @note When making an API call, you may pass AliasTarget
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# dns_name: "DNSName", # required
# evaluate_target_health: false, # required
# }
#
# @!attribute [rw] hosted_zone_id
# *Alias resource records sets only*\: The value used depends on where
# you want to route traffic:
#
# Amazon API Gateway custom regional APIs and edge-optimized APIs
#
# : Specify the hosted zone ID for your API. You can get the
# applicable value using the CLI command [get-domain-names][1]\:
#
# * For regional APIs, specify the value of `regionalHostedZoneId`.
#
# * For edge-optimized APIs, specify the value of
# `distributionHostedZoneId`.
#
# Amazon Virtual Private Cloud interface VPC endpoint
#
# : Specify the hosted zone ID for your interface endpoint. You can
# get the value of `HostedZoneId` using the CLI command
# [describe-vpc-endpoints][2].
#
# CloudFront distribution
#
# : Specify `Z2FDTNDATAQYW2`.
#
# <note markdown="1"> Alias resource record sets for CloudFront can't be created in a
# private zone.
#
# </note>
#
# Elastic Beanstalk environment
#
# : Specify the hosted zone ID for the region that you created the
# environment in. The environment must have a regionalized
# subdomain. For a list of regions and the corresponding hosted zone
# IDs, see [Elastic Beanstalk endpoints and quotas][3] in the the
# *Amazon Web Services General Reference*.
#
# ELB load balancer
#
# : Specify the value of the hosted zone ID for the load balancer. Use
# the following methods to get the hosted zone ID:
#
# * [Elastic Load Balancing endpoints and quotas][4] topic in the
# *Amazon Web Services General Reference*\: Use the value that
# corresponds with the region that you created your load balancer
# in. Note that there are separate columns for Application and
# Classic Load Balancers and for Network Load Balancers.
#
# * **Amazon Web Services Management Console**\: Go to the Amazon
# EC2 page, choose **Load Balancers** in the navigation pane,
# select the load balancer, and get the value of the **Hosted
# zone** field on the **Description** tab.
#
# * **Elastic Load Balancing API**\: Use `DescribeLoadBalancers` to
# get the applicable value. For more information, see the
# applicable guide:
#
# * Classic Load Balancers: Use [DescribeLoadBalancers][5] to get
# the value of `CanonicalHostedZoneNameId`.
#
# * Application and Network Load Balancers: Use
# [DescribeLoadBalancers][6] to get the value of
# `CanonicalHostedZoneId`.
#
# * **CLI**\: Use `describe-load-balancers` to get the applicable
# value. For more information, see the applicable guide:
#
# * Classic Load Balancers: Use [describe-load-balancers][7] to
# get the value of `CanonicalHostedZoneNameId`.
#
# * Application and Network Load Balancers: Use
# [describe-load-balancers][8] to get the value of
# `CanonicalHostedZoneId`.
#
# Global Accelerator accelerator
#
# : Specify `Z2BJ6XQ5FK7U4H`.
#
# An Amazon S3 bucket configured as a static website
#
# : Specify the hosted zone ID for the region that you created the
# bucket in. For more information about valid values, see the table
# [Amazon S3 Website Endpoints][9] in the *Amazon Web Services
# General Reference*.
#
# Another Route 53 resource record set in your hosted zone
#
# : Specify the hosted zone ID of your hosted zone. (An alias resource
# record set can't reference a resource record set in a different
# hosted zone.)
#
#
#
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html
# [2]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html
# [3]: https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html
# [4]: https://docs.aws.amazon.com/general/latest/gr/elb.html
# [5]: https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html
# [6]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html
# [7]: http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html
# [8]: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html
# [9]: https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints
# @return [String]
#
# @!attribute [rw] dns_name
# *Alias resource record sets only:* The value that you specify
# depends on where you want to route queries:
#
# Amazon API Gateway custom regional APIs and edge-optimized APIs
#
# : Specify the applicable domain name for your API. You can get the
# applicable value using the CLI command [get-domain-names][1]\:
#
# * For regional APIs, specify the value of `regionalDomainName`.
#
# * For edge-optimized APIs, specify the value of
# `distributionDomainName`. This is the name of the associated
# CloudFront distribution, such as `da1b2c3d4e5.cloudfront.net`.
#
# <note markdown="1"> The name of the record that you're creating must match a custom
# domain name for your API, such as `api.example.com`.
#
# </note>
#
# Amazon Virtual Private Cloud interface VPC endpoint
#
# : Enter the API endpoint for the interface endpoint, such as
# `vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com`.
# For edge-optimized APIs, this is the domain name for the
# corresponding CloudFront distribution. You can get the value of
# `DnsName` using the CLI command [describe-vpc-endpoints][2].
#
# CloudFront distribution
#
# : Specify the domain name that CloudFront assigned when you created
# your distribution.
#
# Your CloudFront distribution must include an alternate domain name
# that matches the name of the resource record set. For example, if
# the name of the resource record set is *acme.example.com*, your
# CloudFront distribution must include *acme.example.com* as one of
# the alternate domain names. For more information, see [Using
# Alternate Domain Names (CNAMEs)][3] in the *Amazon CloudFront
# Developer Guide*.
#
# You can't create a resource record set in a private hosted zone
# to route traffic to a CloudFront distribution.
#
# <note markdown="1"> For failover alias records, you can't specify a CloudFront
# distribution for both the primary and secondary records. A
# distribution must include an alternate domain name that matches
# the name of the record. However, the primary and secondary records
# have the same name, and you can't include the same alternate
# domain name in more than one distribution.
#
# </note>
#
# Elastic Beanstalk environment
#
# : If the domain name for your Elastic Beanstalk environment includes
# the region that you deployed the environment in, you can create an
# alias record that routes traffic to the environment. For example,
# the domain name `my-environment.us-west-2.elasticbeanstalk.com` is
# a regionalized domain name.
#
# For environments that were created before early 2016, the domain
# name doesn't include the region. To route traffic to these
# environments, you must create a CNAME record instead of an alias
# record. Note that you can't create a CNAME record for the root
# domain name. For example, if your domain name is example.com, you
# can create a record that routes traffic for acme.example.com to
# your Elastic Beanstalk environment, but you can't create a record
# that routes traffic for example.com to your Elastic Beanstalk
# environment.
#
# For Elastic Beanstalk environments that have regionalized
# subdomains, specify the `CNAME` attribute for the environment. You
# can use the following methods to get the value of the CNAME
# attribute:
#
# * *Amazon Web Services Management Console*\: For information about
# how to get the value by using the console, see [Using Custom
# Domains with Elastic Beanstalk][4] in the *Elastic Beanstalk
# Developer Guide*.
#
# * *Elastic Beanstalk API*\: Use the `DescribeEnvironments` action
# to get the value of the `CNAME` attribute. For more information,
# see [DescribeEnvironments][5] in the *Elastic Beanstalk API
# Reference*.
#
# * *CLI*\: Use the `describe-environments` command to get the value
# of the `CNAME` attribute. For more information, see
# [describe-environments][6] in the *CLI Command Reference*.
#
# ELB load balancer
#
# : Specify the DNS name that is associated with the load balancer.
# Get the DNS name by using the Amazon Web Services Management
# Console, the ELB API, or the CLI.
#
# * **Amazon Web Services Management Console**\: Go to the EC2 page,
# choose **Load Balancers** in the navigation pane, choose the
# load balancer, choose the **Description** tab, and get the value
# of the **DNS name** field.
#
# If you're routing traffic to a Classic Load Balancer, get the
# value that begins with **dualstack**. If you're routing traffic
# to another type of load balancer, get the value that applies to
# the record type, A or AAAA.
#
# * **Elastic Load Balancing API**\: Use `DescribeLoadBalancers` to
# get the value of `DNSName`. For more information, see the
# applicable guide:
#
# * Classic Load Balancers: [DescribeLoadBalancers][7]
#
# * Application and Network Load Balancers:
# [DescribeLoadBalancers][8]
#
# * **CLI**\: Use `describe-load-balancers` to get the value of
# `DNSName`. For more information, see the applicable guide:
#
# * Classic Load Balancers: [describe-load-balancers][9]
#
# * Application and Network Load Balancers:
# [describe-load-balancers][10]
#
# Global Accelerator accelerator
#
# : Specify the DNS name for your accelerator:
#
# * **Global Accelerator API:** To get the DNS name, use
# [DescribeAccelerator][11].
#
# * **CLI:** To get the DNS name, use [describe-accelerator][12].
#
# Amazon S3 bucket that is configured as a static website
#
# : Specify the domain name of the Amazon S3 website endpoint that you
# created the bucket in, for example,
# `s3-website.us-east-2.amazonaws.com`. For more information about
# valid values, see the table [Amazon S3 Website Endpoints][13] in
# the *Amazon Web Services General Reference*. For more information
# about using S3 buckets for websites, see [Getting Started with
# Amazon Route 53][14] in the *Amazon Route 53 Developer Guide.*
#
# Another Route 53 resource record set
#
# : Specify the value of the `Name` element for a resource record set
# in the current hosted zone.
#
# <note markdown="1"> If you're creating an alias record that has the same name as the
# hosted zone (known as the zone apex), you can't specify the
# domain name for a record for which the value of `Type` is `CNAME`.
# This is because the alias record must have the same type as the
# record that you're routing traffic to, and creating a CNAME
# record for the zone apex isn't supported even for an alias
# record.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html
# [2]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html
# [3]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html
# [4]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html
# [5]: https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html
# [6]: https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html
# [7]: https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html
# [8]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html
# [9]: http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html
# [10]: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html
# [11]: https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html
# [12]: https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html
# [13]: https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints
# [14]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html
# @return [String]
#
# @!attribute [rw] evaluate_target_health
# *Applies only to alias, failover alias, geolocation alias, latency
# alias, and weighted alias resource record sets:* When
# `EvaluateTargetHealth` is `true`, an alias resource record set
# inherits the health of the referenced Amazon Web Services resource,
# such as an ELB load balancer or another resource record set in the
# hosted zone.
#
# Note the following:
#
# CloudFront distributions
#
# : You can't set `EvaluateTargetHealth` to `true` when the alias
# target is a CloudFront distribution.
#
# Elastic Beanstalk environments that have regionalized subdomains
#
# : If you specify an Elastic Beanstalk environment in `DNSName` and
# the environment contains an ELB load balancer, Elastic Load
# Balancing routes queries only to the healthy Amazon EC2 instances
# that are registered with the load balancer. (An environment
# automatically contains an ELB load balancer if it includes more
# than one Amazon EC2 instance.) If you set `EvaluateTargetHealth`
# to `true` and either no Amazon EC2 instances are healthy or the
# load balancer itself is unhealthy, Route 53 routes queries to
# other available resources that are healthy, if any.
#
# If the environment contains a single Amazon EC2 instance, there
# are no special requirements.
#
# ELB load balancers
#
# : Health checking behavior depends on the type of load balancer:
#
# * **Classic Load Balancers**\: If you specify an ELB Classic Load
# Balancer in `DNSName`, Elastic Load Balancing routes queries
# only to the healthy Amazon EC2 instances that are registered
# with the load balancer. If you set `EvaluateTargetHealth` to
# `true` and either no EC2 instances are healthy or the load
# balancer itself is unhealthy, Route 53 routes queries to other
# resources.
#
# * **Application and Network Load Balancers**\: If you specify an
# ELB Application or Network Load Balancer and you set
# `EvaluateTargetHealth` to `true`, Route 53 routes queries to the
# load balancer based on the health of the target groups that are
# associated with the load balancer:
#
# * For an Application or Network Load Balancer to be considered
# healthy, every target group that contains targets must contain
# at least one healthy target. If any target group contains only
# unhealthy targets, the load balancer is considered unhealthy,
# and Route 53 routes queries to other resources.
#
# * A target group that has no registered targets is considered
# unhealthy.
#
# <note markdown="1"> When you create a load balancer, you configure settings for
# Elastic Load Balancing health checks; they're not Route 53 health
# checks, but they perform a similar function. Do not create Route
# 53 health checks for the EC2 instances that you register with an
# ELB load balancer.
#
# </note>
#
# S3 buckets
#
# : There are no special requirements for setting
# `EvaluateTargetHealth` to `true` when the alias target is an S3
# bucket.
#
# Other records in the same hosted zone
#
# : If the Amazon Web Services resource that you specify in `DNSName`
# is a record or a group of records (for example, a group of
# weighted records) but is not another alias record, we recommend
# that you associate a health check with all of the records in the
# alias target. For more information, see [What Happens When You
# Omit Health Checks?][1] in the *Amazon Route 53 Developer Guide*.
#
# For more information and examples, see [Amazon Route 53 Health
# Checks and DNS Failover][2] in the *Amazon Route 53 Developer
# Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting
# [2]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/AliasTarget AWS API Documentation
#
class AliasTarget < Struct.new(
:hosted_zone_id,
:dns_name,
:evaluate_target_health)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the request to
# associate a VPC with a private hosted zone.
#
# @note When making an API call, you may pass AssociateVPCWithHostedZoneRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# vpc: { # required
# vpc_region: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ap-east-1, me-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1, ap-southeast-1, ap-southeast-2, ap-south-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, ca-central-1, cn-north-1, af-south-1, eu-south-1
# vpc_id: "VPCId",
# },
# comment: "AssociateVPCComment",
# }
#
# @!attribute [rw] hosted_zone_id
# The ID of the private hosted zone that you want to associate an
# Amazon VPC with.
#
# Note that you can't associate a VPC with a hosted zone that
# doesn't have an existing VPC association.
# @return [String]
#
# @!attribute [rw] vpc
# A complex type that contains information about the VPC that you want
# to associate with a private hosted zone.
# @return [Types::VPC]
#
# @!attribute [rw] comment
# *Optional:* A comment about the association request.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/AssociateVPCWithHostedZoneRequest AWS API Documentation
#
class AssociateVPCWithHostedZoneRequest < Struct.new(
:hosted_zone_id,
:vpc,
:comment)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the
# `AssociateVPCWithHostedZone` request.
#
# @!attribute [rw] change_info
# A complex type that describes the changes made to your hosted zone.
# @return [Types::ChangeInfo]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/AssociateVPCWithHostedZoneResponse AWS API Documentation
#
class AssociateVPCWithHostedZoneResponse < Struct.new(
:change_info)
SENSITIVE = []
include Aws::Structure
end
# The information for each resource record set that you want to change.
#
# @note When making an API call, you may pass Change
# data as a hash:
#
# {
# action: "CREATE", # required, accepts CREATE, DELETE, UPSERT
# resource_record_set: { # required
# name: "DNSName", # required
# type: "SOA", # required, accepts SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA, DS
# set_identifier: "ResourceRecordSetIdentifier",
# weight: 1,
# region: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, cn-north-1, cn-northwest-1, ap-east-1, me-south-1, ap-south-1, af-south-1, eu-south-1
# geo_location: {
# continent_code: "GeoLocationContinentCode",
# country_code: "GeoLocationCountryCode",
# subdivision_code: "GeoLocationSubdivisionCode",
# },
# failover: "PRIMARY", # accepts PRIMARY, SECONDARY
# multi_value_answer: false,
# ttl: 1,
# resource_records: [
# {
# value: "RData", # required
# },
# ],
# alias_target: {
# hosted_zone_id: "ResourceId", # required
# dns_name: "DNSName", # required
# evaluate_target_health: false, # required
# },
# health_check_id: "HealthCheckId",
# traffic_policy_instance_id: "TrafficPolicyInstanceId",
# },
# }
#
# @!attribute [rw] action
# The action to perform:
#
# * `CREATE`\: Creates a resource record set that has the specified
# values.
#
# * `DELETE`\: Deletes a existing resource record set.
#
# To delete the resource record set that is associated with a
# traffic policy instance, use [DeleteTrafficPolicyInstance][1].
# Amazon Route 53 will delete the resource record set automatically.
# If you delete the resource record set by using
# `ChangeResourceRecordSets`, Route 53 doesn't automatically delete
# the traffic policy instance, and you'll continue to be charged
# for it even though it's no longer in use.
#
# * `UPSERT`\: If a resource record set doesn't already exist, Route
# 53 creates it. If a resource record set does exist, Route 53
# updates it with the values in the request.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicyInstance.html
# @return [String]
#
# @!attribute [rw] resource_record_set
# Information about the resource record set to create, delete, or
# update.
# @return [Types::ResourceRecordSet]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/Change AWS API Documentation
#
class Change < Struct.new(
:action,
:resource_record_set)
SENSITIVE = []
include Aws::Structure
end
# The information for a change request.
#
# @note When making an API call, you may pass ChangeBatch
# data as a hash:
#
# {
# comment: "ResourceDescription",
# changes: [ # required
# {
# action: "CREATE", # required, accepts CREATE, DELETE, UPSERT
# resource_record_set: { # required
# name: "DNSName", # required
# type: "SOA", # required, accepts SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA, DS
# set_identifier: "ResourceRecordSetIdentifier",
# weight: 1,
# region: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, cn-north-1, cn-northwest-1, ap-east-1, me-south-1, ap-south-1, af-south-1, eu-south-1
# geo_location: {
# continent_code: "GeoLocationContinentCode",
# country_code: "GeoLocationCountryCode",
# subdivision_code: "GeoLocationSubdivisionCode",
# },
# failover: "PRIMARY", # accepts PRIMARY, SECONDARY
# multi_value_answer: false,
# ttl: 1,
# resource_records: [
# {
# value: "RData", # required
# },
# ],
# alias_target: {
# hosted_zone_id: "ResourceId", # required
# dns_name: "DNSName", # required
# evaluate_target_health: false, # required
# },
# health_check_id: "HealthCheckId",
# traffic_policy_instance_id: "TrafficPolicyInstanceId",
# },
# },
# ],
# }
#
# @!attribute [rw] comment
# *Optional:* Any comments you want to include about a change batch
# request.
# @return [String]
#
# @!attribute [rw] changes
# Information about the changes to make to the record sets.
# @return [Array<Types::Change>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ChangeBatch AWS API Documentation
#
class ChangeBatch < Struct.new(
:comment,
:changes)
SENSITIVE = []
include Aws::Structure
end
# A complex type that describes change information about changes made to
# your hosted zone.
#
# @!attribute [rw] id
# This element contains an ID that you use when performing a
# [GetChange][1] action to get detailed information about the change.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html
# @return [String]
#
# @!attribute [rw] status
# The current state of the request. `PENDING` indicates that this
# request has not yet been applied to all Amazon Route 53 DNS servers.
# @return [String]
#
# @!attribute [rw] submitted_at
# The date and time that the change request was submitted in [ISO 8601
# format][1] and Coordinated Universal Time (UTC). For example, the
# value `2017-03-27T17:48:16.751Z` represents March 27, 2017 at
# 17:48:16.751 UTC.
#
#
#
# [1]: https://en.wikipedia.org/wiki/ISO_8601
# @return [Time]
#
# @!attribute [rw] comment
# A comment you can provide.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ChangeInfo AWS API Documentation
#
class ChangeInfo < Struct.new(
:id,
:status,
:submitted_at,
:comment)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains change information for the resource
# record set.
#
# @note When making an API call, you may pass ChangeResourceRecordSetsRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# change_batch: { # required
# comment: "ResourceDescription",
# changes: [ # required
# {
# action: "CREATE", # required, accepts CREATE, DELETE, UPSERT
# resource_record_set: { # required
# name: "DNSName", # required
# type: "SOA", # required, accepts SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA, DS
# set_identifier: "ResourceRecordSetIdentifier",
# weight: 1,
# region: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, cn-north-1, cn-northwest-1, ap-east-1, me-south-1, ap-south-1, af-south-1, eu-south-1
# geo_location: {
# continent_code: "GeoLocationContinentCode",
# country_code: "GeoLocationCountryCode",
# subdivision_code: "GeoLocationSubdivisionCode",
# },
# failover: "PRIMARY", # accepts PRIMARY, SECONDARY
# multi_value_answer: false,
# ttl: 1,
# resource_records: [
# {
# value: "RData", # required
# },
# ],
# alias_target: {
# hosted_zone_id: "ResourceId", # required
# dns_name: "DNSName", # required
# evaluate_target_health: false, # required
# },
# health_check_id: "HealthCheckId",
# traffic_policy_instance_id: "TrafficPolicyInstanceId",
# },
# },
# ],
# },
# }
#
# @!attribute [rw] hosted_zone_id
# The ID of the hosted zone that contains the resource record sets
# that you want to change.
# @return [String]
#
# @!attribute [rw] change_batch
# A complex type that contains an optional comment and the `Changes`
# element.
# @return [Types::ChangeBatch]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ChangeResourceRecordSetsRequest AWS API Documentation
#
class ChangeResourceRecordSetsRequest < Struct.new(
:hosted_zone_id,
:change_batch)
SENSITIVE = []
include Aws::Structure
end
# A complex type containing the response for the request.
#
# @!attribute [rw] change_info
# A complex type that contains information about changes made to your
# hosted zone.
#
# This element contains an ID that you use when performing a
# [GetChange][1] action to get detailed information about the change.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html
# @return [Types::ChangeInfo]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ChangeResourceRecordSetsResponse AWS API Documentation
#
class ChangeResourceRecordSetsResponse < Struct.new(
:change_info)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the tags that you want
# to add, edit, or delete.
#
# @note When making an API call, you may pass ChangeTagsForResourceRequest
# data as a hash:
#
# {
# resource_type: "healthcheck", # required, accepts healthcheck, hostedzone
# resource_id: "TagResourceId", # required
# add_tags: [
# {
# key: "TagKey",
# value: "TagValue",
# },
# ],
# remove_tag_keys: ["TagKey"],
# }
#
# @!attribute [rw] resource_type
# The type of the resource.
#
# * The resource type for health checks is `healthcheck`.
#
# * The resource type for hosted zones is `hostedzone`.
# @return [String]
#
# @!attribute [rw] resource_id
# The ID of the resource for which you want to add, change, or delete
# tags.
# @return [String]
#
# @!attribute [rw] add_tags
# A complex type that contains a list of the tags that you want to add
# to the specified health check or hosted zone and/or the tags that
# you want to edit `Value` for.
#
# You can add a maximum of 10 tags to a health check or a hosted zone.
# @return [Array<Types::Tag>]
#
# @!attribute [rw] remove_tag_keys
# A complex type that contains a list of the tags that you want to
# delete from the specified health check or hosted zone. You can
# specify up to 10 keys.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ChangeTagsForResourceRequest AWS API Documentation
#
class ChangeTagsForResourceRequest < Struct.new(
:resource_type,
:resource_id,
:add_tags,
:remove_tag_keys)
SENSITIVE = []
include Aws::Structure
end
# Empty response for the request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ChangeTagsForResourceResponse AWS API Documentation
#
class ChangeTagsForResourceResponse < Aws::EmptyStructure; end
# A complex type that contains information about the CloudWatch alarm
# that Amazon Route 53 is monitoring for this health check.
#
# @!attribute [rw] evaluation_periods
# For the metric that the CloudWatch alarm is associated with, the
# number of periods that the metric is compared to the threshold.
# @return [Integer]
#
# @!attribute [rw] threshold
# For the metric that the CloudWatch alarm is associated with, the
# value the metric is compared with.
# @return [Float]
#
# @!attribute [rw] comparison_operator
# For the metric that the CloudWatch alarm is associated with, the
# arithmetic operation that is used for the comparison.
# @return [String]
#
# @!attribute [rw] period
# For the metric that the CloudWatch alarm is associated with, the
# duration of one evaluation period in seconds.
# @return [Integer]
#
# @!attribute [rw] metric_name
# The name of the CloudWatch metric that the alarm is associated with.
# @return [String]
#
# @!attribute [rw] namespace
# The namespace of the metric that the alarm is associated with. For
# more information, see [Amazon CloudWatch Namespaces, Dimensions, and
# Metrics Reference][1] in the *Amazon CloudWatch User Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html
# @return [String]
#
# @!attribute [rw] statistic
# For the metric that the CloudWatch alarm is associated with, the
# statistic that is applied to the metric.
# @return [String]
#
# @!attribute [rw] dimensions
# For the metric that the CloudWatch alarm is associated with, a
# complex type that contains information about the dimensions for the
# metric. For information, see [Amazon CloudWatch Namespaces,
# Dimensions, and Metrics Reference][1] in the *Amazon CloudWatch User
# Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html
# @return [Array<Types::Dimension>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CloudWatchAlarmConfiguration AWS API Documentation
#
class CloudWatchAlarmConfiguration < Struct.new(
:evaluation_periods,
:threshold,
:comparison_operator,
:period,
:metric_name,
:namespace,
:statistic,
:dimensions)
SENSITIVE = []
include Aws::Structure
end
# Another user submitted a request to create, update, or delete the
# object at the same time that you did. Retry the request.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ConcurrentModification AWS API Documentation
#
class ConcurrentModification < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The cause of this error depends on the operation that you're
# performing:
#
# * **Create a public hosted zone:** Two hosted zones that have the same
# name or that have a parent/child relationship (example.com and
# test.example.com) can't have any common name servers. You tried to
# create a hosted zone that has the same name as an existing hosted
# zone or that's the parent or child of an existing hosted zone, and
# you specified a delegation set that shares one or more name servers
# with the existing hosted zone. For more information, see
# [CreateReusableDelegationSet][1].
#
# * **Create a private hosted zone:** A hosted zone with the specified
# name already exists and is already associated with the Amazon VPC
# that you specified.
#
# * **Associate VPCs with a private hosted zone:** The VPC that you
# specified is already associated with another hosted zone that has
# the same name.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ConflictingDomainExists AWS API Documentation
#
class ConflictingDomainExists < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# You tried to update a traffic policy instance by using a traffic
# policy version that has a different DNS type than the current type for
# the instance. You specified the type in the JSON document in the
# `CreateTrafficPolicy` or `CreateTrafficPolicyVersion`request.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ConflictingTypes AWS API Documentation
#
class ConflictingTypes < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the health check request information.
#
# @note When making an API call, you may pass CreateHealthCheckRequest
# data as a hash:
#
# {
# caller_reference: "HealthCheckNonce", # required
# health_check_config: { # required
# ip_address: "IPAddress",
# port: 1,
# type: "HTTP", # required, accepts HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC, RECOVERY_CONTROL
# resource_path: "ResourcePath",
# fully_qualified_domain_name: "FullyQualifiedDomainName",
# search_string: "SearchString",
# request_interval: 1,
# failure_threshold: 1,
# measure_latency: false,
# inverted: false,
# disabled: false,
# health_threshold: 1,
# child_health_checks: ["HealthCheckId"],
# enable_sni: false,
# regions: ["us-east-1"], # accepts us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1
# alarm_identifier: {
# region: "us-east-1", # required, accepts us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-central-1, eu-west-1, eu-west-2, eu-west-3, ap-east-1, me-south-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, cn-northwest-1, cn-north-1, af-south-1, eu-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1
# name: "AlarmName", # required
# },
# insufficient_data_health_status: "Healthy", # accepts Healthy, Unhealthy, LastKnownStatus
# routing_control_arn: "RoutingControlArn",
# },
# }
#
# @!attribute [rw] caller_reference
# A unique string that identifies the request and that allows you to
# retry a failed `CreateHealthCheck` request without the risk of
# creating two identical health checks:
#
# * If you send a `CreateHealthCheck` request with the same
# `CallerReference` and settings as a previous request, and if the
# health check doesn't exist, Amazon Route 53 creates the health
# check. If the health check does exist, Route 53 returns the
# settings for the existing health check.
#
# * If you send a `CreateHealthCheck` request with the same
# `CallerReference` as a deleted health check, regardless of the
# settings, Route 53 returns a `HealthCheckAlreadyExists` error.
#
# * If you send a `CreateHealthCheck` request with the same
# `CallerReference` as an existing health check but with different
# settings, Route 53 returns a `HealthCheckAlreadyExists` error.
#
# * If you send a `CreateHealthCheck` request with a unique
# `CallerReference` but settings identical to an existing health
# check, Route 53 creates the health check.
# @return [String]
#
# @!attribute [rw] health_check_config
# A complex type that contains settings for a new health check.
# @return [Types::HealthCheckConfig]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateHealthCheckRequest AWS API Documentation
#
class CreateHealthCheckRequest < Struct.new(
:caller_reference,
:health_check_config)
SENSITIVE = []
include Aws::Structure
end
# A complex type containing the response information for the new health
# check.
#
# @!attribute [rw] health_check
# A complex type that contains identifying information about the
# health check.
# @return [Types::HealthCheck]
#
# @!attribute [rw] location
# The unique URL representing the new health check.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateHealthCheckResponse AWS API Documentation
#
class CreateHealthCheckResponse < Struct.new(
:health_check,
:location)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the request to create a
# public or private hosted zone.
#
# @note When making an API call, you may pass CreateHostedZoneRequest
# data as a hash:
#
# {
# name: "DNSName", # required
# vpc: {
# vpc_region: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ap-east-1, me-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1, ap-southeast-1, ap-southeast-2, ap-south-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, ca-central-1, cn-north-1, af-south-1, eu-south-1
# vpc_id: "VPCId",
# },
# caller_reference: "Nonce", # required
# hosted_zone_config: {
# comment: "ResourceDescription",
# private_zone: false,
# },
# delegation_set_id: "ResourceId",
# }
#
# @!attribute [rw] name
# The name of the domain. Specify a fully qualified domain name, for
# example, *www.example.com*. The trailing dot is optional; Amazon
# Route 53 assumes that the domain name is fully qualified. This means
# that Route 53 treats *www.example.com* (without a trailing dot) and
# *www.example.com.* (with a trailing dot) as identical.
#
# If you're creating a public hosted zone, this is the name you have
# registered with your DNS registrar. If your domain name is
# registered with a registrar other than Route 53, change the name
# servers for your domain to the set of `NameServers` that
# `CreateHostedZone` returns in `DelegationSet`.
# @return [String]
#
# @!attribute [rw] vpc
# (Private hosted zones only) A complex type that contains information
# about the Amazon VPC that you're associating with this hosted zone.
#
# You can specify only one Amazon VPC when you create a private hosted
# zone. To associate additional Amazon VPCs with the hosted zone, use
# [AssociateVPCWithHostedZone][1] after you create a hosted zone.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AssociateVPCWithHostedZone.html
# @return [Types::VPC]
#
# @!attribute [rw] caller_reference
# A unique string that identifies the request and that allows failed
# `CreateHostedZone` requests to be retried without the risk of
# executing the operation twice. You must use a unique
# `CallerReference` string every time you submit a `CreateHostedZone`
# request. `CallerReference` can be any unique string, for example, a
# date/time stamp.
# @return [String]
#
# @!attribute [rw] hosted_zone_config
# (Optional) A complex type that contains the following optional
# values:
#
# * For public and private hosted zones, an optional comment
#
# * For private hosted zones, an optional `PrivateZone` element
#
# If you don't specify a comment or the `PrivateZone` element, omit
# `HostedZoneConfig` and the other elements.
# @return [Types::HostedZoneConfig]
#
# @!attribute [rw] delegation_set_id
# If you want to associate a reusable delegation set with this hosted
# zone, the ID that Amazon Route 53 assigned to the reusable
# delegation set when you created it. For more information about
# reusable delegation sets, see [CreateReusableDelegationSet][1].
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateHostedZoneRequest AWS API Documentation
#
class CreateHostedZoneRequest < Struct.new(
:name,
:vpc,
:caller_reference,
:hosted_zone_config,
:delegation_set_id)
SENSITIVE = []
include Aws::Structure
end
# A complex type containing the response information for the hosted
# zone.
#
# @!attribute [rw] hosted_zone
# A complex type that contains general information about the hosted
# zone.
# @return [Types::HostedZone]
#
# @!attribute [rw] change_info
# A complex type that contains information about the
# `CreateHostedZone` request.
# @return [Types::ChangeInfo]
#
# @!attribute [rw] delegation_set
# A complex type that describes the name servers for this hosted zone.
# @return [Types::DelegationSet]
#
# @!attribute [rw] vpc
# A complex type that contains information about an Amazon VPC that
# you associated with this hosted zone.
# @return [Types::VPC]
#
# @!attribute [rw] location
# The unique URL representing the new hosted zone.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateHostedZoneResponse AWS API Documentation
#
class CreateHostedZoneResponse < Struct.new(
:hosted_zone,
:change_info,
:delegation_set,
:vpc,
:location)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass CreateKeySigningKeyRequest
# data as a hash:
#
# {
# caller_reference: "Nonce", # required
# hosted_zone_id: "ResourceId", # required
# key_management_service_arn: "SigningKeyString", # required
# name: "SigningKeyName", # required
# status: "SigningKeyStatus", # required
# }
#
# @!attribute [rw] caller_reference
# A unique string that identifies the request.
# @return [String]
#
# @!attribute [rw] hosted_zone_id
# The unique string (ID) used to identify a hosted zone.
# @return [String]
#
# @!attribute [rw] key_management_service_arn
# The Amazon resource name (ARN) for a customer managed customer
# master key (CMK) in Key Management Service (KMS). The
# `KeyManagementServiceArn` must be unique for each key-signing key
# (KSK) in a single hosted zone. To see an example of
# `KeyManagementServiceArn` that grants the correct permissions for
# DNSSEC, scroll down to **Example**.
#
# You must configure the customer managed CMK as follows:
#
# Status
#
# : Enabled
#
# Key spec
#
# : ECC\_NIST\_P256
#
# Key usage
#
# : Sign and verify
#
# Key policy
#
# : The key policy must give permission for the following actions:
#
# * DescribeKey
#
# * GetPublicKey
#
# * Sign
#
# The key policy must also include the Amazon Route 53 service in
# the principal for your account. Specify the following:
#
# * `"Service": "dnssec-route53.amazonaws.com"`
#
# ^
#
# For more information about working with a customer managed CMK in
# KMS, see [Key Management Service concepts][1].
#
#
#
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html
# @return [String]
#
# @!attribute [rw] name
# A string used to identify a key-signing key (KSK). `Name` can
# include numbers, letters, and underscores (\_). `Name` must be
# unique for each key-signing key in the same hosted zone.
# @return [String]
#
# @!attribute [rw] status
# A string specifying the initial status of the key-signing key (KSK).
# You can set the value to `ACTIVE` or `INACTIVE`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateKeySigningKeyRequest AWS API Documentation
#
class CreateKeySigningKeyRequest < Struct.new(
:caller_reference,
:hosted_zone_id,
:key_management_service_arn,
:name,
:status)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] change_info
# A complex type that describes change information about changes made
# to your hosted zone.
# @return [Types::ChangeInfo]
#
# @!attribute [rw] key_signing_key
# The key-signing key (KSK) that the request creates.
# @return [Types::KeySigningKey]
#
# @!attribute [rw] location
# The unique URL representing the new key-signing key (KSK).
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateKeySigningKeyResponse AWS API Documentation
#
class CreateKeySigningKeyResponse < Struct.new(
:change_info,
:key_signing_key,
:location)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass CreateQueryLoggingConfigRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# cloud_watch_logs_log_group_arn: "CloudWatchLogsLogGroupArn", # required
# }
#
# @!attribute [rw] hosted_zone_id
# The ID of the hosted zone that you want to log queries for. You can
# log queries only for public hosted zones.
# @return [String]
#
# @!attribute [rw] cloud_watch_logs_log_group_arn
# The Amazon Resource Name (ARN) for the log group that you want to
# Amazon Route 53 to send query logs to. This is the format of the
# ARN:
#
# arn:aws:logs:*region*\:*account-id*\:log-group:*log\_group\_name*
#
# To get the ARN for a log group, you can use the CloudWatch console,
# the [DescribeLogGroups][1] API action, the [describe-log-groups][2]
# command, or the applicable command in one of the Amazon Web Services
# SDKs.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogGroups.html
# [2]: https://docs.aws.amazon.com/cli/latest/reference/logs/describe-log-groups.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateQueryLoggingConfigRequest AWS API Documentation
#
class CreateQueryLoggingConfigRequest < Struct.new(
:hosted_zone_id,
:cloud_watch_logs_log_group_arn)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] query_logging_config
# A complex type that contains the ID for a query logging
# configuration, the ID of the hosted zone that you want to log
# queries for, and the ARN for the log group that you want Amazon
# Route 53 to send query logs to.
# @return [Types::QueryLoggingConfig]
#
# @!attribute [rw] location
# The unique URL representing the new query logging configuration.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateQueryLoggingConfigResponse AWS API Documentation
#
class CreateQueryLoggingConfigResponse < Struct.new(
:query_logging_config,
:location)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass CreateReusableDelegationSetRequest
# data as a hash:
#
# {
# caller_reference: "Nonce", # required
# hosted_zone_id: "ResourceId",
# }
#
# @!attribute [rw] caller_reference
# A unique string that identifies the request, and that allows you to
# retry failed `CreateReusableDelegationSet` requests without the risk
# of executing the operation twice. You must use a unique
# `CallerReference` string every time you submit a
# `CreateReusableDelegationSet` request. `CallerReference` can be any
# unique string, for example a date/time stamp.
# @return [String]
#
# @!attribute [rw] hosted_zone_id
# If you want to mark the delegation set for an existing hosted zone
# as reusable, the ID for that hosted zone.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateReusableDelegationSetRequest AWS API Documentation
#
class CreateReusableDelegationSetRequest < Struct.new(
:caller_reference,
:hosted_zone_id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] delegation_set
# A complex type that contains name server information.
# @return [Types::DelegationSet]
#
# @!attribute [rw] location
# The unique URL representing the new reusable delegation set.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateReusableDelegationSetResponse AWS API Documentation
#
class CreateReusableDelegationSetResponse < Struct.new(
:delegation_set,
:location)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the resource record
# sets that you want to create based on a specified traffic policy.
#
# @note When making an API call, you may pass CreateTrafficPolicyInstanceRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# name: "DNSName", # required
# ttl: 1, # required
# traffic_policy_id: "TrafficPolicyId", # required
# traffic_policy_version: 1, # required
# }
#
# @!attribute [rw] hosted_zone_id
# The ID of the hosted zone that you want Amazon Route 53 to create
# resource record sets in by using the configuration in a traffic
# policy.
# @return [String]
#
# @!attribute [rw] name
# The domain name (such as example.com) or subdomain name (such as
# www.example.com) for which Amazon Route 53 responds to DNS queries
# by using the resource record sets that Route 53 creates for this
# traffic policy instance.
# @return [String]
#
# @!attribute [rw] ttl
# (Optional) The TTL that you want Amazon Route 53 to assign to all of
# the resource record sets that it creates in the specified hosted
# zone.
# @return [Integer]
#
# @!attribute [rw] traffic_policy_id
# The ID of the traffic policy that you want to use to create resource
# record sets in the specified hosted zone.
# @return [String]
#
# @!attribute [rw] traffic_policy_version
# The version of the traffic policy that you want to use to create
# resource record sets in the specified hosted zone.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateTrafficPolicyInstanceRequest AWS API Documentation
#
class CreateTrafficPolicyInstanceRequest < Struct.new(
:hosted_zone_id,
:name,
:ttl,
:traffic_policy_id,
:traffic_policy_version)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the
# `CreateTrafficPolicyInstance` request.
#
# @!attribute [rw] traffic_policy_instance
# A complex type that contains settings for the new traffic policy
# instance.
# @return [Types::TrafficPolicyInstance]
#
# @!attribute [rw] location
# A unique URL that represents a new traffic policy instance.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateTrafficPolicyInstanceResponse AWS API Documentation
#
class CreateTrafficPolicyInstanceResponse < Struct.new(
:traffic_policy_instance,
:location)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the traffic policy that
# you want to create.
#
# @note When making an API call, you may pass CreateTrafficPolicyRequest
# data as a hash:
#
# {
# name: "TrafficPolicyName", # required
# document: "TrafficPolicyDocument", # required
# comment: "TrafficPolicyComment",
# }
#
# @!attribute [rw] name
# The name of the traffic policy.
# @return [String]
#
# @!attribute [rw] document
# The definition of this traffic policy in JSON format. For more
# information, see [Traffic Policy Document Format][1].
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/api-policies-traffic-policy-document-format.html
# @return [String]
#
# @!attribute [rw] comment
# (Optional) Any comments that you want to include about the traffic
# policy.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateTrafficPolicyRequest AWS API Documentation
#
class CreateTrafficPolicyRequest < Struct.new(
:name,
:document,
:comment)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the
# `CreateTrafficPolicy` request.
#
# @!attribute [rw] traffic_policy
# A complex type that contains settings for the new traffic policy.
# @return [Types::TrafficPolicy]
#
# @!attribute [rw] location
# A unique URL that represents a new traffic policy.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateTrafficPolicyResponse AWS API Documentation
#
class CreateTrafficPolicyResponse < Struct.new(
:traffic_policy,
:location)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the traffic policy that
# you want to create a new version for.
#
# @note When making an API call, you may pass CreateTrafficPolicyVersionRequest
# data as a hash:
#
# {
# id: "TrafficPolicyId", # required
# document: "TrafficPolicyDocument", # required
# comment: "TrafficPolicyComment",
# }
#
# @!attribute [rw] id
# The ID of the traffic policy for which you want to create a new
# version.
# @return [String]
#
# @!attribute [rw] document
# The definition of this version of the traffic policy, in JSON
# format. You specified the JSON in the `CreateTrafficPolicyVersion`
# request. For more information about the JSON format, see
# [CreateTrafficPolicy][1].
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateTrafficPolicy.html
# @return [String]
#
# @!attribute [rw] comment
# The comment that you specified in the `CreateTrafficPolicyVersion`
# request, if any.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateTrafficPolicyVersionRequest AWS API Documentation
#
class CreateTrafficPolicyVersionRequest < Struct.new(
:id,
:document,
:comment)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the
# `CreateTrafficPolicyVersion` request.
#
# @!attribute [rw] traffic_policy
# A complex type that contains settings for the new version of the
# traffic policy.
# @return [Types::TrafficPolicy]
#
# @!attribute [rw] location
# A unique URL that represents a new traffic policy version.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateTrafficPolicyVersionResponse AWS API Documentation
#
class CreateTrafficPolicyVersionResponse < Struct.new(
:traffic_policy,
:location)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the request to
# authorize associating a VPC with your private hosted zone.
# Authorization is only required when a private hosted zone and a VPC
# were created by using different accounts.
#
# @note When making an API call, you may pass CreateVPCAssociationAuthorizationRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# vpc: { # required
# vpc_region: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ap-east-1, me-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1, ap-southeast-1, ap-southeast-2, ap-south-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, ca-central-1, cn-north-1, af-south-1, eu-south-1
# vpc_id: "VPCId",
# },
# }
#
# @!attribute [rw] hosted_zone_id
# The ID of the private hosted zone that you want to authorize
# associating a VPC with.
# @return [String]
#
# @!attribute [rw] vpc
# A complex type that contains the VPC ID and region for the VPC that
# you want to authorize associating with your hosted zone.
# @return [Types::VPC]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateVPCAssociationAuthorizationRequest AWS API Documentation
#
class CreateVPCAssociationAuthorizationRequest < Struct.new(
:hosted_zone_id,
:vpc)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information from a
# `CreateVPCAssociationAuthorization` request.
#
# @!attribute [rw] hosted_zone_id
# The ID of the hosted zone that you authorized associating a VPC
# with.
# @return [String]
#
# @!attribute [rw] vpc
# The VPC that you authorized associating with a hosted zone.
# @return [Types::VPC]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateVPCAssociationAuthorizationResponse AWS API Documentation
#
class CreateVPCAssociationAuthorizationResponse < Struct.new(
:hosted_zone_id,
:vpc)
SENSITIVE = []
include Aws::Structure
end
# The hosted zone doesn't have any DNSSEC resources.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DNSSECNotFound AWS API Documentation
#
class DNSSECNotFound < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A string repesenting the status of DNSSEC signing.
#
# @!attribute [rw] serve_signature
# A string that represents the current hosted zone signing status.
#
# Status can have one of the following values:
#
# SIGNING
#
# : DNSSEC signing is enabled for the hosted zone.
#
# NOT\_SIGNING
#
# : DNSSEC signing is not enabled for the hosted zone.
#
# DELETING
#
# : DNSSEC signing is in the process of being removed for the hosted
# zone.
#
# ACTION\_NEEDED
#
# : There is a problem with signing in the hosted zone that requires
# you to take action to resolve. For example, the customer managed
# customer master key (CMK) might have been deleted, or the
# permissions for the customer managed CMK might have been changed.
#
# INTERNAL\_FAILURE
#
# : There was an error during a request. Before you can continue to
# work with DNSSEC signing, including with key-signing keys (KSKs),
# you must correct the problem by enabling or disabling DNSSEC
# signing for the hosted zone.
# @return [String]
#
# @!attribute [rw] status_message
# The status message provided for the following DNSSEC signing status:
# `INTERNAL_FAILURE`. The status message includes information about
# what the problem might be and steps that you can take to correct the
# issue.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DNSSECStatus AWS API Documentation
#
class DNSSECStatus < Struct.new(
:serve_signature,
:status_message)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DeactivateKeySigningKeyRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# name: "SigningKeyName", # required
# }
#
# @!attribute [rw] hosted_zone_id
# A unique string used to identify a hosted zone.
# @return [String]
#
# @!attribute [rw] name
# A string used to identify a key-signing key (KSK).
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeactivateKeySigningKeyRequest AWS API Documentation
#
class DeactivateKeySigningKeyRequest < Struct.new(
:hosted_zone_id,
:name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] change_info
# A complex type that describes change information about changes made
# to your hosted zone.
# @return [Types::ChangeInfo]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeactivateKeySigningKeyResponse AWS API Documentation
#
class DeactivateKeySigningKeyResponse < Struct.new(
:change_info)
SENSITIVE = []
include Aws::Structure
end
# A complex type that lists the name servers in a delegation set, as
# well as the `CallerReference` and the `ID` for the delegation set.
#
# @!attribute [rw] id
# The ID that Amazon Route 53 assigns to a reusable delegation set.
# @return [String]
#
# @!attribute [rw] caller_reference
# The value that you specified for `CallerReference` when you created
# the reusable delegation set.
# @return [String]
#
# @!attribute [rw] name_servers
# A complex type that contains a list of the authoritative name
# servers for a hosted zone or for a reusable delegation set.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DelegationSet AWS API Documentation
#
class DelegationSet < Struct.new(
:id,
:caller_reference,
:name_servers)
SENSITIVE = []
include Aws::Structure
end
# A delegation set with the same owner and caller reference combination
# has already been created.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DelegationSetAlreadyCreated AWS API Documentation
#
class DelegationSetAlreadyCreated < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The specified delegation set has already been marked as reusable.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DelegationSetAlreadyReusable AWS API Documentation
#
class DelegationSetAlreadyReusable < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The specified delegation contains associated hosted zones which must
# be deleted before the reusable delegation set can be deleted.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DelegationSetInUse AWS API Documentation
#
class DelegationSetInUse < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# You can create a hosted zone that has the same name as an existing
# hosted zone (example.com is common), but there is a limit to the
# number of hosted zones that have the same name. If you get this error,
# Amazon Route 53 has reached that limit. If you own the domain name and
# Route 53 generates this error, contact Customer Support.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DelegationSetNotAvailable AWS API Documentation
#
class DelegationSetNotAvailable < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A reusable delegation set with the specified ID does not exist.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DelegationSetNotReusable AWS API Documentation
#
class DelegationSetNotReusable < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# This action deletes a health check.
#
# @note When making an API call, you may pass DeleteHealthCheckRequest
# data as a hash:
#
# {
# health_check_id: "HealthCheckId", # required
# }
#
# @!attribute [rw] health_check_id
# The ID of the health check that you want to delete.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteHealthCheckRequest AWS API Documentation
#
class DeleteHealthCheckRequest < Struct.new(
:health_check_id)
SENSITIVE = []
include Aws::Structure
end
# An empty element.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteHealthCheckResponse AWS API Documentation
#
class DeleteHealthCheckResponse < Aws::EmptyStructure; end
# A request to delete a hosted zone.
#
# @note When making an API call, you may pass DeleteHostedZoneRequest
# data as a hash:
#
# {
# id: "ResourceId", # required
# }
#
# @!attribute [rw] id
# The ID of the hosted zone you want to delete.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteHostedZoneRequest AWS API Documentation
#
class DeleteHostedZoneRequest < Struct.new(
:id)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response to a `DeleteHostedZone`
# request.
#
# @!attribute [rw] change_info
# A complex type that contains the ID, the status, and the date and
# time of a request to delete a hosted zone.
# @return [Types::ChangeInfo]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteHostedZoneResponse AWS API Documentation
#
class DeleteHostedZoneResponse < Struct.new(
:change_info)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DeleteKeySigningKeyRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# name: "SigningKeyName", # required
# }
#
# @!attribute [rw] hosted_zone_id
# A unique string used to identify a hosted zone.
# @return [String]
#
# @!attribute [rw] name
# A string used to identify a key-signing key (KSK).
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteKeySigningKeyRequest AWS API Documentation
#
class DeleteKeySigningKeyRequest < Struct.new(
:hosted_zone_id,
:name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] change_info
# A complex type that describes change information about changes made
# to your hosted zone.
# @return [Types::ChangeInfo]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteKeySigningKeyResponse AWS API Documentation
#
class DeleteKeySigningKeyResponse < Struct.new(
:change_info)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DeleteQueryLoggingConfigRequest
# data as a hash:
#
# {
# id: "QueryLoggingConfigId", # required
# }
#
# @!attribute [rw] id
# The ID of the configuration that you want to delete.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteQueryLoggingConfigRequest AWS API Documentation
#
class DeleteQueryLoggingConfigRequest < Struct.new(
:id)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteQueryLoggingConfigResponse AWS API Documentation
#
class DeleteQueryLoggingConfigResponse < Aws::EmptyStructure; end
# A request to delete a reusable delegation set.
#
# @note When making an API call, you may pass DeleteReusableDelegationSetRequest
# data as a hash:
#
# {
# id: "ResourceId", # required
# }
#
# @!attribute [rw] id
# The ID of the reusable delegation set that you want to delete.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteReusableDelegationSetRequest AWS API Documentation
#
class DeleteReusableDelegationSetRequest < Struct.new(
:id)
SENSITIVE = []
include Aws::Structure
end
# An empty element.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteReusableDelegationSetResponse AWS API Documentation
#
class DeleteReusableDelegationSetResponse < Aws::EmptyStructure; end
# A request to delete a specified traffic policy instance.
#
# @note When making an API call, you may pass DeleteTrafficPolicyInstanceRequest
# data as a hash:
#
# {
# id: "TrafficPolicyInstanceId", # required
# }
#
# @!attribute [rw] id
# The ID of the traffic policy instance that you want to delete.
#
# When you delete a traffic policy instance, Amazon Route 53 also
# deletes all of the resource record sets that were created when you
# created the traffic policy instance.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteTrafficPolicyInstanceRequest AWS API Documentation
#
class DeleteTrafficPolicyInstanceRequest < Struct.new(
:id)
SENSITIVE = []
include Aws::Structure
end
# An empty element.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteTrafficPolicyInstanceResponse AWS API Documentation
#
class DeleteTrafficPolicyInstanceResponse < Aws::EmptyStructure; end
# A request to delete a specified traffic policy version.
#
# @note When making an API call, you may pass DeleteTrafficPolicyRequest
# data as a hash:
#
# {
# id: "TrafficPolicyId", # required
# version: 1, # required
# }
#
# @!attribute [rw] id
# The ID of the traffic policy that you want to delete.
# @return [String]
#
# @!attribute [rw] version
# The version number of the traffic policy that you want to delete.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteTrafficPolicyRequest AWS API Documentation
#
class DeleteTrafficPolicyRequest < Struct.new(
:id,
:version)
SENSITIVE = []
include Aws::Structure
end
# An empty element.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteTrafficPolicyResponse AWS API Documentation
#
class DeleteTrafficPolicyResponse < Aws::EmptyStructure; end
# A complex type that contains information about the request to remove
# authorization to associate a VPC that was created by one Amazon Web
# Services account with a hosted zone that was created with a different
# Amazon Web Services account.
#
# @note When making an API call, you may pass DeleteVPCAssociationAuthorizationRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# vpc: { # required
# vpc_region: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ap-east-1, me-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1, ap-southeast-1, ap-southeast-2, ap-south-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, ca-central-1, cn-north-1, af-south-1, eu-south-1
# vpc_id: "VPCId",
# },
# }
#
# @!attribute [rw] hosted_zone_id
# When removing authorization to associate a VPC that was created by
# one Amazon Web Services account with a hosted zone that was created
# with a different Amazon Web Services account, the ID of the hosted
# zone.
# @return [String]
#
# @!attribute [rw] vpc
# When removing authorization to associate a VPC that was created by
# one Amazon Web Services account with a hosted zone that was created
# with a different Amazon Web Services account, a complex type that
# includes the ID and region of the VPC.
# @return [Types::VPC]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteVPCAssociationAuthorizationRequest AWS API Documentation
#
class DeleteVPCAssociationAuthorizationRequest < Struct.new(
:hosted_zone_id,
:vpc)
SENSITIVE = []
include Aws::Structure
end
# Empty response for the request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteVPCAssociationAuthorizationResponse AWS API Documentation
#
class DeleteVPCAssociationAuthorizationResponse < Aws::EmptyStructure; end
# For the metric that the CloudWatch alarm is associated with, a complex
# type that contains information about one dimension.
#
# @!attribute [rw] name
# For the metric that the CloudWatch alarm is associated with, the
# name of one dimension.
# @return [String]
#
# @!attribute [rw] value
# For the metric that the CloudWatch alarm is associated with, the
# value of one dimension.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/Dimension AWS API Documentation
#
class Dimension < Struct.new(
:name,
:value)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DisableHostedZoneDNSSECRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# }
#
# @!attribute [rw] hosted_zone_id
# A unique string used to identify a hosted zone.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DisableHostedZoneDNSSECRequest AWS API Documentation
#
class DisableHostedZoneDNSSECRequest < Struct.new(
:hosted_zone_id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] change_info
# A complex type that describes change information about changes made
# to your hosted zone.
# @return [Types::ChangeInfo]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DisableHostedZoneDNSSECResponse AWS API Documentation
#
class DisableHostedZoneDNSSECResponse < Struct.new(
:change_info)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the VPC that you want
# to disassociate from a specified private hosted zone.
#
# @note When making an API call, you may pass DisassociateVPCFromHostedZoneRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# vpc: { # required
# vpc_region: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ap-east-1, me-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1, ap-southeast-1, ap-southeast-2, ap-south-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, ca-central-1, cn-north-1, af-south-1, eu-south-1
# vpc_id: "VPCId",
# },
# comment: "DisassociateVPCComment",
# }
#
# @!attribute [rw] hosted_zone_id
# The ID of the private hosted zone that you want to disassociate a
# VPC from.
# @return [String]
#
# @!attribute [rw] vpc
# A complex type that contains information about the VPC that you're
# disassociating from the specified hosted zone.
# @return [Types::VPC]
#
# @!attribute [rw] comment
# *Optional:* A comment about the disassociation request.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DisassociateVPCFromHostedZoneRequest AWS API Documentation
#
class DisassociateVPCFromHostedZoneRequest < Struct.new(
:hosted_zone_id,
:vpc,
:comment)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the
# disassociate request.
#
# @!attribute [rw] change_info
# A complex type that describes the changes made to the specified
# private hosted zone.
# @return [Types::ChangeInfo]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DisassociateVPCFromHostedZoneResponse AWS API Documentation
#
class DisassociateVPCFromHostedZoneResponse < Struct.new(
:change_info)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass EnableHostedZoneDNSSECRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# }
#
# @!attribute [rw] hosted_zone_id
# A unique string used to identify a hosted zone.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/EnableHostedZoneDNSSECRequest AWS API Documentation
#
class EnableHostedZoneDNSSECRequest < Struct.new(
:hosted_zone_id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] change_info
# A complex type that describes change information about changes made
# to your hosted zone.
# @return [Types::ChangeInfo]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/EnableHostedZoneDNSSECResponse AWS API Documentation
#
class EnableHostedZoneDNSSECResponse < Struct.new(
:change_info)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about a geographic location.
#
# @note When making an API call, you may pass GeoLocation
# data as a hash:
#
# {
# continent_code: "GeoLocationContinentCode",
# country_code: "GeoLocationCountryCode",
# subdivision_code: "GeoLocationSubdivisionCode",
# }
#
# @!attribute [rw] continent_code
# The two-letter code for the continent.
#
# Amazon Route 53 supports the following continent codes:
#
# * **AF**\: Africa
#
# * **AN**\: Antarctica
#
# * **AS**\: Asia
#
# * **EU**\: Europe
#
# * **OC**\: Oceania
#
# * **NA**\: North America
#
# * **SA**\: South America
#
# Constraint: Specifying `ContinentCode` with either `CountryCode` or
# `SubdivisionCode` returns an `InvalidInput` error.
# @return [String]
#
# @!attribute [rw] country_code
# For geolocation resource record sets, the two-letter code for a
# country.
#
# Amazon Route 53 uses the two-letter country codes that are specified
# in [ISO standard 3166-1 alpha-2][1].
#
#
#
# [1]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
# @return [String]
#
# @!attribute [rw] subdivision_code
# For geolocation resource record sets, the two-letter code for a
# state of the United States. Route 53 doesn't support any other
# values for `SubdivisionCode`. For a list of state abbreviations, see
# [Appendix B: Two–Letter State and Possession Abbreviations][1] on
# the United States Postal Service website.
#
# If you specify `subdivisioncode`, you must also specify `US` for
# `CountryCode`.
#
#
#
# [1]: https://pe.usps.com/text/pub28/28apb.htm
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GeoLocation AWS API Documentation
#
class GeoLocation < Struct.new(
:continent_code,
:country_code,
:subdivision_code)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the codes and full continent, country,
# and subdivision names for the specified `geolocation` code.
#
# @!attribute [rw] continent_code
# The two-letter code for the continent.
# @return [String]
#
# @!attribute [rw] continent_name
# The full name of the continent.
# @return [String]
#
# @!attribute [rw] country_code
# The two-letter code for the country.
# @return [String]
#
# @!attribute [rw] country_name
# The name of the country.
# @return [String]
#
# @!attribute [rw] subdivision_code
# The code for the subdivision, such as a particular state within the
# United States. For a list of US state abbreviations, see [Appendix
# B: Two–Letter State and Possession Abbreviations][1] on the United
# States Postal Service website. For a list of all supported
# subdivision codes, use the [ListGeoLocations][2] API.
#
#
#
# [1]: https://pe.usps.com/text/pub28/28apb.htm
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListGeoLocations.html
# @return [String]
#
# @!attribute [rw] subdivision_name
# The full name of the subdivision. Route 53 currently supports only
# states in the United States.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GeoLocationDetails AWS API Documentation
#
class GeoLocationDetails < Struct.new(
:continent_code,
:continent_name,
:country_code,
:country_name,
:subdivision_code,
:subdivision_name)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the request to create a
# hosted zone.
#
# @note When making an API call, you may pass GetAccountLimitRequest
# data as a hash:
#
# {
# type: "MAX_HEALTH_CHECKS_BY_OWNER", # required, accepts MAX_HEALTH_CHECKS_BY_OWNER, MAX_HOSTED_ZONES_BY_OWNER, MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER, MAX_REUSABLE_DELEGATION_SETS_BY_OWNER, MAX_TRAFFIC_POLICIES_BY_OWNER
# }
#
# @!attribute [rw] type
# The limit that you want to get. Valid values include the following:
#
# * **MAX\_HEALTH\_CHECKS\_BY\_OWNER**\: The maximum number of health
# checks that you can create using the current account.
#
# * **MAX\_HOSTED\_ZONES\_BY\_OWNER**\: The maximum number of hosted
# zones that you can create using the current account.
#
# * **MAX\_REUSABLE\_DELEGATION\_SETS\_BY\_OWNER**\: The maximum
# number of reusable delegation sets that you can create using the
# current account.
#
# * **MAX\_TRAFFIC\_POLICIES\_BY\_OWNER**\: The maximum number of
# traffic policies that you can create using the current account.
#
# * **MAX\_TRAFFIC\_POLICY\_INSTANCES\_BY\_OWNER**\: The maximum
# number of traffic policy instances that you can create using the
# current account. (Traffic policy instances are referred to as
# traffic flow policy records in the Amazon Route 53 console.)
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetAccountLimitRequest AWS API Documentation
#
class GetAccountLimitRequest < Struct.new(
:type)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the requested limit.
#
# @!attribute [rw] limit
# The current setting for the specified limit. For example, if you
# specified `MAX_HEALTH_CHECKS_BY_OWNER` for the value of `Type` in
# the request, the value of `Limit` is the maximum number of health
# checks that you can create using the current account.
# @return [Types::AccountLimit]
#
# @!attribute [rw] count
# The current number of entities that you have created of the
# specified type. For example, if you specified
# `MAX_HEALTH_CHECKS_BY_OWNER` for the value of `Type` in the request,
# the value of `Count` is the current number of health checks that you
# have created using the current account.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetAccountLimitResponse AWS API Documentation
#
class GetAccountLimitResponse < Struct.new(
:limit,
:count)
SENSITIVE = []
include Aws::Structure
end
# The input for a GetChange request.
#
# @note When making an API call, you may pass GetChangeRequest
# data as a hash:
#
# {
# id: "ResourceId", # required
# }
#
# @!attribute [rw] id
# The ID of the change batch request. The value that you specify here
# is the value that `ChangeResourceRecordSets` returned in the `Id`
# element when you submitted the request.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetChangeRequest AWS API Documentation
#
class GetChangeRequest < Struct.new(
:id)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the `ChangeInfo` element.
#
# @!attribute [rw] change_info
# A complex type that contains information about the specified change
# batch.
# @return [Types::ChangeInfo]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetChangeResponse AWS API Documentation
#
class GetChangeResponse < Struct.new(
:change_info)
SENSITIVE = []
include Aws::Structure
end
# Empty request.
#
# @api private
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetCheckerIpRangesRequest AWS API Documentation
#
class GetCheckerIpRangesRequest < Aws::EmptyStructure; end
# A complex type that contains the `CheckerIpRanges` element.
#
# @!attribute [rw] checker_ip_ranges
# A complex type that contains sorted list of IP ranges in CIDR format
# for Amazon Route 53 health checkers.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetCheckerIpRangesResponse AWS API Documentation
#
class GetCheckerIpRangesResponse < Struct.new(
:checker_ip_ranges)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass GetDNSSECRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# }
#
# @!attribute [rw] hosted_zone_id
# A unique string used to identify a hosted zone.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetDNSSECRequest AWS API Documentation
#
class GetDNSSECRequest < Struct.new(
:hosted_zone_id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] status
# A string repesenting the status of DNSSEC.
# @return [Types::DNSSECStatus]
#
# @!attribute [rw] key_signing_keys
# The key-signing keys (KSKs) in your account.
# @return [Array<Types::KeySigningKey>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetDNSSECResponse AWS API Documentation
#
class GetDNSSECResponse < Struct.new(
:status,
:key_signing_keys)
SENSITIVE = []
include Aws::Structure
end
# A request for information about whether a specified geographic
# location is supported for Amazon Route 53 geolocation resource record
# sets.
#
# @note When making an API call, you may pass GetGeoLocationRequest
# data as a hash:
#
# {
# continent_code: "GeoLocationContinentCode",
# country_code: "GeoLocationCountryCode",
# subdivision_code: "GeoLocationSubdivisionCode",
# }
#
# @!attribute [rw] continent_code
# For geolocation resource record sets, a two-letter abbreviation that
# identifies a continent. Amazon Route 53 supports the following
# continent codes:
#
# * **AF**\: Africa
#
# * **AN**\: Antarctica
#
# * **AS**\: Asia
#
# * **EU**\: Europe
#
# * **OC**\: Oceania
#
# * **NA**\: North America
#
# * **SA**\: South America
# @return [String]
#
# @!attribute [rw] country_code
# Amazon Route 53 uses the two-letter country codes that are specified
# in [ISO standard 3166-1 alpha-2][1].
#
#
#
# [1]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
# @return [String]
#
# @!attribute [rw] subdivision_code
# The code for the subdivision, such as a particular state within the
# United States. For a list of US state abbreviations, see [Appendix
# B: Two–Letter State and Possession Abbreviations][1] on the United
# States Postal Service website. For a list of all supported
# subdivision codes, use the [ListGeoLocations][2] API.
#
#
#
# [1]: https://pe.usps.com/text/pub28/28apb.htm
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListGeoLocations.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetGeoLocationRequest AWS API Documentation
#
class GetGeoLocationRequest < Struct.new(
:continent_code,
:country_code,
:subdivision_code)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the
# specified geolocation code.
#
# @!attribute [rw] geo_location_details
# A complex type that contains the codes and full continent, country,
# and subdivision names for the specified geolocation code.
# @return [Types::GeoLocationDetails]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetGeoLocationResponse AWS API Documentation
#
class GetGeoLocationResponse < Struct.new(
:geo_location_details)
SENSITIVE = []
include Aws::Structure
end
# A request for the number of health checks that are associated with the
# current Amazon Web Services account.
#
# @api private
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHealthCheckCountRequest AWS API Documentation
#
class GetHealthCheckCountRequest < Aws::EmptyStructure; end
# A complex type that contains the response to a `GetHealthCheckCount`
# request.
#
# @!attribute [rw] health_check_count
# The number of health checks associated with the current Amazon Web
# Services account.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHealthCheckCountResponse AWS API Documentation
#
class GetHealthCheckCountResponse < Struct.new(
:health_check_count)
SENSITIVE = []
include Aws::Structure
end
# A request for the reason that a health check failed most recently.
#
# @note When making an API call, you may pass GetHealthCheckLastFailureReasonRequest
# data as a hash:
#
# {
# health_check_id: "HealthCheckId", # required
# }
#
# @!attribute [rw] health_check_id
# The ID for the health check for which you want the last failure
# reason. When you created the health check, `CreateHealthCheck`
# returned the ID in the response, in the `HealthCheckId` element.
#
# <note markdown="1"> If you want to get the last failure reason for a calculated health
# check, you must use the Amazon Route 53 console or the CloudWatch
# console. You can't use `GetHealthCheckLastFailureReason` for a
# calculated health check.
#
# </note>
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHealthCheckLastFailureReasonRequest AWS API Documentation
#
class GetHealthCheckLastFailureReasonRequest < Struct.new(
:health_check_id)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response to a
# `GetHealthCheckLastFailureReason` request.
#
# @!attribute [rw] health_check_observations
# A list that contains one `Observation` element for each Amazon Route
# 53 health checker that is reporting a last failure reason.
# @return [Array<Types::HealthCheckObservation>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHealthCheckLastFailureReasonResponse AWS API Documentation
#
class GetHealthCheckLastFailureReasonResponse < Struct.new(
:health_check_observations)
SENSITIVE = []
include Aws::Structure
end
# A request to get information about a specified health check.
#
# @note When making an API call, you may pass GetHealthCheckRequest
# data as a hash:
#
# {
# health_check_id: "HealthCheckId", # required
# }
#
# @!attribute [rw] health_check_id
# The identifier that Amazon Route 53 assigned to the health check
# when you created it. When you add or update a resource record set,
# you use this value to specify which health check to use. The value
# can be up to 64 characters long.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHealthCheckRequest AWS API Documentation
#
class GetHealthCheckRequest < Struct.new(
:health_check_id)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response to a `GetHealthCheck`
# request.
#
# @!attribute [rw] health_check
# A complex type that contains information about one health check that
# is associated with the current Amazon Web Services account.
# @return [Types::HealthCheck]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHealthCheckResponse AWS API Documentation
#
class GetHealthCheckResponse < Struct.new(
:health_check)
SENSITIVE = []
include Aws::Structure
end
# A request to get the status for a health check.
#
# @note When making an API call, you may pass GetHealthCheckStatusRequest
# data as a hash:
#
# {
# health_check_id: "HealthCheckId", # required
# }
#
# @!attribute [rw] health_check_id
# The ID for the health check that you want the current status for.
# When you created the health check, `CreateHealthCheck` returned the
# ID in the response, in the `HealthCheckId` element.
#
# <note markdown="1"> If you want to check the status of a calculated health check, you
# must use the Amazon Route 53 console or the CloudWatch console. You
# can't use `GetHealthCheckStatus` to get the status of a calculated
# health check.
#
# </note>
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHealthCheckStatusRequest AWS API Documentation
#
class GetHealthCheckStatusRequest < Struct.new(
:health_check_id)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response to a `GetHealthCheck`
# request.
#
# @!attribute [rw] health_check_observations
# A list that contains one `HealthCheckObservation` element for each
# Amazon Route 53 health checker that is reporting a status about the
# health check endpoint.
# @return [Array<Types::HealthCheckObservation>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHealthCheckStatusResponse AWS API Documentation
#
class GetHealthCheckStatusResponse < Struct.new(
:health_check_observations)
SENSITIVE = []
include Aws::Structure
end
# A request to retrieve a count of all the hosted zones that are
# associated with the current Amazon Web Services account.
#
# @api private
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHostedZoneCountRequest AWS API Documentation
#
class GetHostedZoneCountRequest < Aws::EmptyStructure; end
# A complex type that contains the response to a `GetHostedZoneCount`
# request.
#
# @!attribute [rw] hosted_zone_count
# The total number of public and private hosted zones that are
# associated with the current Amazon Web Services account.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHostedZoneCountResponse AWS API Documentation
#
class GetHostedZoneCountResponse < Struct.new(
:hosted_zone_count)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the request to create a
# hosted zone.
#
# @note When making an API call, you may pass GetHostedZoneLimitRequest
# data as a hash:
#
# {
# type: "MAX_RRSETS_BY_ZONE", # required, accepts MAX_RRSETS_BY_ZONE, MAX_VPCS_ASSOCIATED_BY_ZONE
# hosted_zone_id: "ResourceId", # required
# }
#
# @!attribute [rw] type
# The limit that you want to get. Valid values include the following:
#
# * **MAX\_RRSETS\_BY\_ZONE**\: The maximum number of records that you
# can create in the specified hosted zone.
#
# * **MAX\_VPCS\_ASSOCIATED\_BY\_ZONE**\: The maximum number of Amazon
# VPCs that you can associate with the specified private hosted
# zone.
# @return [String]
#
# @!attribute [rw] hosted_zone_id
# The ID of the hosted zone that you want to get a limit for.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHostedZoneLimitRequest AWS API Documentation
#
class GetHostedZoneLimitRequest < Struct.new(
:type,
:hosted_zone_id)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the requested limit.
#
# @!attribute [rw] limit
# The current setting for the specified limit. For example, if you
# specified `MAX_RRSETS_BY_ZONE` for the value of `Type` in the
# request, the value of `Limit` is the maximum number of records that
# you can create in the specified hosted zone.
# @return [Types::HostedZoneLimit]
#
# @!attribute [rw] count
# The current number of entities that you have created of the
# specified type. For example, if you specified `MAX_RRSETS_BY_ZONE`
# for the value of `Type` in the request, the value of `Count` is the
# current number of records that you have created in the specified
# hosted zone.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHostedZoneLimitResponse AWS API Documentation
#
class GetHostedZoneLimitResponse < Struct.new(
:limit,
:count)
SENSITIVE = []
include Aws::Structure
end
# A request to get information about a specified hosted zone.
#
# @note When making an API call, you may pass GetHostedZoneRequest
# data as a hash:
#
# {
# id: "ResourceId", # required
# }
#
# @!attribute [rw] id
# The ID of the hosted zone that you want to get information about.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHostedZoneRequest AWS API Documentation
#
class GetHostedZoneRequest < Struct.new(
:id)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contain the response to a `GetHostedZone` request.
#
# @!attribute [rw] hosted_zone
# A complex type that contains general information about the specified
# hosted zone.
# @return [Types::HostedZone]
#
# @!attribute [rw] delegation_set
# A complex type that lists the Amazon Route 53 name servers for the
# specified hosted zone.
# @return [Types::DelegationSet]
#
# @!attribute [rw] vp_cs
# A complex type that contains information about the VPCs that are
# associated with the specified hosted zone.
# @return [Array<Types::VPC>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHostedZoneResponse AWS API Documentation
#
class GetHostedZoneResponse < Struct.new(
:hosted_zone,
:delegation_set,
:vp_cs)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass GetQueryLoggingConfigRequest
# data as a hash:
#
# {
# id: "QueryLoggingConfigId", # required
# }
#
# @!attribute [rw] id
# The ID of the configuration for DNS query logging that you want to
# get information about.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetQueryLoggingConfigRequest AWS API Documentation
#
class GetQueryLoggingConfigRequest < Struct.new(
:id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] query_logging_config
# A complex type that contains information about the query logging
# configuration that you specified in a [GetQueryLoggingConfig][1]
# request.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetQueryLoggingConfig.html
# @return [Types::QueryLoggingConfig]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetQueryLoggingConfigResponse AWS API Documentation
#
class GetQueryLoggingConfigResponse < Struct.new(
:query_logging_config)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the request to create a
# hosted zone.
#
# @note When making an API call, you may pass GetReusableDelegationSetLimitRequest
# data as a hash:
#
# {
# type: "MAX_ZONES_BY_REUSABLE_DELEGATION_SET", # required, accepts MAX_ZONES_BY_REUSABLE_DELEGATION_SET
# delegation_set_id: "ResourceId", # required
# }
#
# @!attribute [rw] type
# Specify `MAX_ZONES_BY_REUSABLE_DELEGATION_SET` to get the maximum
# number of hosted zones that you can associate with the specified
# reusable delegation set.
# @return [String]
#
# @!attribute [rw] delegation_set_id
# The ID of the delegation set that you want to get the limit for.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetReusableDelegationSetLimitRequest AWS API Documentation
#
class GetReusableDelegationSetLimitRequest < Struct.new(
:type,
:delegation_set_id)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the requested limit.
#
# @!attribute [rw] limit
# The current setting for the limit on hosted zones that you can
# associate with the specified reusable delegation set.
# @return [Types::ReusableDelegationSetLimit]
#
# @!attribute [rw] count
# The current number of hosted zones that you can associate with the
# specified reusable delegation set.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetReusableDelegationSetLimitResponse AWS API Documentation
#
class GetReusableDelegationSetLimitResponse < Struct.new(
:limit,
:count)
SENSITIVE = []
include Aws::Structure
end
# A request to get information about a specified reusable delegation
# set.
#
# @note When making an API call, you may pass GetReusableDelegationSetRequest
# data as a hash:
#
# {
# id: "ResourceId", # required
# }
#
# @!attribute [rw] id
# The ID of the reusable delegation set that you want to get a list of
# name servers for.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetReusableDelegationSetRequest AWS API Documentation
#
class GetReusableDelegationSetRequest < Struct.new(
:id)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response to the
# `GetReusableDelegationSet` request.
#
# @!attribute [rw] delegation_set
# A complex type that contains information about the reusable
# delegation set.
# @return [Types::DelegationSet]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetReusableDelegationSetResponse AWS API Documentation
#
class GetReusableDelegationSetResponse < Struct.new(
:delegation_set)
SENSITIVE = []
include Aws::Structure
end
# Request to get the number of traffic policy instances that are
# associated with the current Amazon Web Services account.
#
# @api private
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetTrafficPolicyInstanceCountRequest AWS API Documentation
#
class GetTrafficPolicyInstanceCountRequest < Aws::EmptyStructure; end
# A complex type that contains information about the resource record
# sets that Amazon Route 53 created based on a specified traffic policy.
#
# @!attribute [rw] traffic_policy_instance_count
# The number of traffic policy instances that are associated with the
# current Amazon Web Services account.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetTrafficPolicyInstanceCountResponse AWS API Documentation
#
class GetTrafficPolicyInstanceCountResponse < Struct.new(
:traffic_policy_instance_count)
SENSITIVE = []
include Aws::Structure
end
# Gets information about a specified traffic policy instance.
#
# @note When making an API call, you may pass GetTrafficPolicyInstanceRequest
# data as a hash:
#
# {
# id: "TrafficPolicyInstanceId", # required
# }
#
# @!attribute [rw] id
# The ID of the traffic policy instance that you want to get
# information about.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetTrafficPolicyInstanceRequest AWS API Documentation
#
class GetTrafficPolicyInstanceRequest < Struct.new(
:id)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the resource record
# sets that Amazon Route 53 created based on a specified traffic policy.
#
# @!attribute [rw] traffic_policy_instance
# A complex type that contains settings for the traffic policy
# instance.
# @return [Types::TrafficPolicyInstance]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetTrafficPolicyInstanceResponse AWS API Documentation
#
class GetTrafficPolicyInstanceResponse < Struct.new(
:traffic_policy_instance)
SENSITIVE = []
include Aws::Structure
end
# Gets information about a specific traffic policy version.
#
# @note When making an API call, you may pass GetTrafficPolicyRequest
# data as a hash:
#
# {
# id: "TrafficPolicyId", # required
# version: 1, # required
# }
#
# @!attribute [rw] id
# The ID of the traffic policy that you want to get information about.
# @return [String]
#
# @!attribute [rw] version
# The version number of the traffic policy that you want to get
# information about.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetTrafficPolicyRequest AWS API Documentation
#
class GetTrafficPolicyRequest < Struct.new(
:id,
:version)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the request.
#
# @!attribute [rw] traffic_policy
# A complex type that contains settings for the specified traffic
# policy.
# @return [Types::TrafficPolicy]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetTrafficPolicyResponse AWS API Documentation
#
class GetTrafficPolicyResponse < Struct.new(
:traffic_policy)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about one health check that
# is associated with the current Amazon Web Services account.
#
# @!attribute [rw] id
# The identifier that Amazon Route 53 assigned to the health check
# when you created it. When you add or update a resource record set,
# you use this value to specify which health check to use. The value
# can be up to 64 characters long.
# @return [String]
#
# @!attribute [rw] caller_reference
# A unique string that you specified when you created the health
# check.
# @return [String]
#
# @!attribute [rw] linked_service
# If the health check was created by another service, the service that
# created the health check. When a health check is created by another
# service, you can't edit or delete it using Amazon Route 53.
# @return [Types::LinkedService]
#
# @!attribute [rw] health_check_config
# A complex type that contains detailed information about one health
# check.
# @return [Types::HealthCheckConfig]
#
# @!attribute [rw] health_check_version
# The version of the health check. You can optionally pass this value
# in a call to `UpdateHealthCheck` to prevent overwriting another
# change to the health check.
# @return [Integer]
#
# @!attribute [rw] cloud_watch_alarm_configuration
# A complex type that contains information about the CloudWatch alarm
# that Amazon Route 53 is monitoring for this health check.
# @return [Types::CloudWatchAlarmConfiguration]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HealthCheck AWS API Documentation
#
class HealthCheck < Struct.new(
:id,
:caller_reference,
:linked_service,
:health_check_config,
:health_check_version,
:cloud_watch_alarm_configuration)
SENSITIVE = []
include Aws::Structure
end
# The health check you're attempting to create already exists. Amazon
# Route 53 returns this error when you submit a request that has the
# following values:
#
# * The same value for `CallerReference` as an existing health check,
# and one or more values that differ from the existing health check
# that has the same caller reference.
#
# * The same value for `CallerReference` as a health check that you
# created and later deleted, regardless of the other settings in the
# request.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HealthCheckAlreadyExists AWS API Documentation
#
class HealthCheckAlreadyExists < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the health check.
#
# @note When making an API call, you may pass HealthCheckConfig
# data as a hash:
#
# {
# ip_address: "IPAddress",
# port: 1,
# type: "HTTP", # required, accepts HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED, CLOUDWATCH_METRIC, RECOVERY_CONTROL
# resource_path: "ResourcePath",
# fully_qualified_domain_name: "FullyQualifiedDomainName",
# search_string: "SearchString",
# request_interval: 1,
# failure_threshold: 1,
# measure_latency: false,
# inverted: false,
# disabled: false,
# health_threshold: 1,
# child_health_checks: ["HealthCheckId"],
# enable_sni: false,
# regions: ["us-east-1"], # accepts us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1
# alarm_identifier: {
# region: "us-east-1", # required, accepts us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-central-1, eu-west-1, eu-west-2, eu-west-3, ap-east-1, me-south-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, cn-northwest-1, cn-north-1, af-south-1, eu-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1
# name: "AlarmName", # required
# },
# insufficient_data_health_status: "Healthy", # accepts Healthy, Unhealthy, LastKnownStatus
# routing_control_arn: "RoutingControlArn",
# }
#
# @!attribute [rw] ip_address
# The IPv4 or IPv6 IP address of the endpoint that you want Amazon
# Route 53 to perform health checks on. If you don't specify a value
# for `IPAddress`, Route 53 sends a DNS request to resolve the domain
# name that you specify in `FullyQualifiedDomainName` at the interval
# that you specify in `RequestInterval`. Using an IP address returned
# by DNS, Route 53 then checks the health of the endpoint.
#
# Use one of the following formats for the value of `IPAddress`\:
#
# * **IPv4 address**\: four values between 0 and 255, separated by
# periods (.), for example, `192.0.2.44`.
#
# * **IPv6 address**\: eight groups of four hexadecimal values,
# separated by colons (:), for example,
# `2001:0db8:85a3:0000:0000:abcd:0001:2345`. You can also shorten
# IPv6 addresses as described in RFC 5952, for example,
# `2001:db8:85a3::abcd:1:2345`.
#
# If the endpoint is an EC2 instance, we recommend that you create an
# Elastic IP address, associate it with your EC2 instance, and specify
# the Elastic IP address for `IPAddress`. This ensures that the IP
# address of your instance will never change.
#
# For more information, see [FullyQualifiedDomainName][1].
#
# Constraints: Route 53 can't check the health of endpoints for which
# the IP address is in local, private, non-routable, or multicast
# ranges. For more information about IP addresses for which you can't
# create health checks, see the following documents:
#
# * [RFC 5735, Special Use IPv4 Addresses][2]
#
# * [RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space][3]
#
# * [RFC 5156, Special-Use IPv6 Addresses][4]
#
# When the value of `Type` is `CALCULATED` or `CLOUDWATCH_METRIC`,
# omit `IPAddress`.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName
# [2]: https://tools.ietf.org/html/rfc5735
# [3]: https://tools.ietf.org/html/rfc6598
# [4]: https://tools.ietf.org/html/rfc5156
# @return [String]
#
# @!attribute [rw] port
# The port on the endpoint that you want Amazon Route 53 to perform
# health checks on.
#
# <note markdown="1"> Don't specify a value for `Port` when you specify a value for
# `Type` of `CLOUDWATCH_METRIC` or `CALCULATED`.
#
# </note>
# @return [Integer]
#
# @!attribute [rw] type
# The type of health check that you want to create, which indicates
# how Amazon Route 53 determines whether an endpoint is healthy.
#
# You can't change the value of `Type` after you create a health
# check.
#
# You can create the following types of health checks:
#
# * **HTTP**\: Route 53 tries to establish a TCP connection. If
# successful, Route 53 submits an HTTP request and waits for an HTTP
# status code of 200 or greater and less than 400.
#
# * **HTTPS**\: Route 53 tries to establish a TCP connection. If
# successful, Route 53 submits an HTTPS request and waits for an
# HTTP status code of 200 or greater and less than 400.
#
# If you specify `HTTPS` for the value of `Type`, the endpoint must
# support TLS v1.0 or later.
#
# * **HTTP\_STR\_MATCH**\: Route 53 tries to establish a TCP
# connection. If successful, Route 53 submits an HTTP request and
# searches the first 5,120 bytes of the response body for the string
# that you specify in `SearchString`.
#
# * **HTTPS\_STR\_MATCH**\: Route 53 tries to establish a TCP
# connection. If successful, Route 53 submits an `HTTPS` request and
# searches the first 5,120 bytes of the response body for the string
# that you specify in `SearchString`.
#
# * **TCP**\: Route 53 tries to establish a TCP connection.
#
# * **CLOUDWATCH\_METRIC**\: The health check is associated with a
# CloudWatch alarm. If the state of the alarm is `OK`, the health
# check is considered healthy. If the state is `ALARM`, the health
# check is considered unhealthy. If CloudWatch doesn't have
# sufficient data to determine whether the state is `OK` or `ALARM`,
# the health check status depends on the setting for
# `InsufficientDataHealthStatus`\: `Healthy`, `Unhealthy`, or
# `LastKnownStatus`.
#
# * **CALCULATED**\: For health checks that monitor the status of
# other health checks, Route 53 adds up the number of health checks
# that Route 53 health checkers consider to be healthy and compares
# that number with the value of `HealthThreshold`.
#
# * **RECOVERY\_CONTROL**\: The health check is assocated with a
# Route53 Application Recovery Controller routing control. If the
# routing control state is `ON`, the health check is considered
# healthy. If the state is `OFF`, the health check is considered
# unhealthy.
#
# For more information, see [How Route 53 Determines Whether an
# Endpoint Is Healthy][1] in the *Amazon Route 53 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html
# @return [String]
#
# @!attribute [rw] resource_path
# The path, if any, that you want Amazon Route 53 to request when
# performing health checks. The path can be any value for which your
# endpoint will return an HTTP status code of 2xx or 3xx when the
# endpoint is healthy, for example, the file
# /docs/route53-health-check.html. You can also include query string
# parameters, for example, `/welcome.html?language=jp&login=y`.
# @return [String]
#
# @!attribute [rw] fully_qualified_domain_name
# Amazon Route 53 behavior depends on whether you specify a value for
# `IPAddress`.
#
# **If you specify a value for** `IPAddress`\:
#
# Amazon Route 53 sends health check requests to the specified IPv4 or
# IPv6 address and passes the value of `FullyQualifiedDomainName` in
# the `Host` header for all health checks except TCP health checks.
# This is typically the fully qualified DNS name of the endpoint on
# which you want Route 53 to perform health checks.
#
# When Route 53 checks the health of an endpoint, here is how it
# constructs the `Host` header:
#
# * If you specify a value of `80` for `Port` and `HTTP` or
# `HTTP_STR_MATCH` for `Type`, Route 53 passes the value of
# `FullyQualifiedDomainName` to the endpoint in the Host header.
#
# * If you specify a value of `443` for `Port` and `HTTPS` or
# `HTTPS_STR_MATCH` for `Type`, Route 53 passes the value of
# `FullyQualifiedDomainName` to the endpoint in the `Host` header.
#
# * If you specify another value for `Port` and any value except `TCP`
# for `Type`, Route 53 passes `FullyQualifiedDomainName:Port` to the
# endpoint in the `Host` header.
#
# If you don't specify a value for `FullyQualifiedDomainName`, Route
# 53 substitutes the value of `IPAddress` in the `Host` header in each
# of the preceding cases.
#
# <b>If you don't specify a value for <code>IPAddress</code> </b>\:
#
# Route 53 sends a DNS request to the domain that you specify for
# `FullyQualifiedDomainName` at the interval that you specify for
# `RequestInterval`. Using an IPv4 address that DNS returns, Route 53
# then checks the health of the endpoint.
#
# <note markdown="1"> If you don't specify a value for `IPAddress`, Route 53 uses only
# IPv4 to send health checks to the endpoint. If there's no resource
# record set with a type of A for the name that you specify for
# `FullyQualifiedDomainName`, the health check fails with a "DNS
# resolution failed" error.
#
# </note>
#
# If you want to check the health of weighted, latency, or failover
# resource record sets and you choose to specify the endpoint only by
# `FullyQualifiedDomainName`, we recommend that you create a separate
# health check for each endpoint. For example, create a health check
# for each HTTP server that is serving content for www.example.com.
# For the value of `FullyQualifiedDomainName`, specify the domain name
# of the server (such as us-east-2-www.example.com), not the name of
# the resource record sets (www.example.com).
#
# In this configuration, if you create a health check for which the
# value of `FullyQualifiedDomainName` matches the name of the resource
# record sets and you then associate the health check with those
# resource record sets, health check results will be unpredictable.
#
# In addition, if the value that you specify for `Type` is `HTTP`,
# `HTTPS`, `HTTP_STR_MATCH`, or `HTTPS_STR_MATCH`, Route 53 passes the
# value of `FullyQualifiedDomainName` in the `Host` header, as it does
# when you specify a value for `IPAddress`. If the value of `Type` is
# `TCP`, Route 53 doesn't pass a `Host` header.
# @return [String]
#
# @!attribute [rw] search_string
# If the value of Type is `HTTP_STR_MATCH` or `HTTPS_STR_MATCH`, the
# string that you want Amazon Route 53 to search for in the response
# body from the specified resource. If the string appears in the
# response body, Route 53 considers the resource healthy.
#
# Route 53 considers case when searching for `SearchString` in the
# response body.
# @return [String]
#
# @!attribute [rw] request_interval
# 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. Each Route 53 health checker makes requests at
# this interval.
#
# You can't change the value of `RequestInterval` after you create a
# health check.
#
# If you don't specify a value for `RequestInterval`, the default
# value is `30` seconds.
# @return [Integer]
#
# @!attribute [rw] failure_threshold
# The number of consecutive health checks that an endpoint must pass
# or fail for Amazon Route 53 to change the current status of the
# endpoint from unhealthy to healthy or vice versa. For more
# information, see [How Amazon Route 53 Determines Whether an Endpoint
# Is Healthy][1] in the *Amazon Route 53 Developer Guide*.
#
# If you don't specify a value for `FailureThreshold`, the default
# value is three health checks.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html
# @return [Integer]
#
# @!attribute [rw] measure_latency
# Specify whether you want Amazon Route 53 to measure the latency
# between health checkers in multiple Amazon Web Services regions and
# your endpoint, and to display CloudWatch latency graphs on the
# **Health Checks** page in the Route 53 console.
#
# You can't change the value of `MeasureLatency` after you create a
# health check.
# @return [Boolean]
#
# @!attribute [rw] inverted
# Specify whether you want Amazon Route 53 to invert the status of a
# health check, for example, to consider a health check unhealthy when
# it otherwise would be considered healthy.
# @return [Boolean]
#
# @!attribute [rw] disabled
# Stops Route 53 from performing health checks. When you disable a
# health check, here's what happens:
#
# * **Health checks that check the health of endpoints:** Route 53
# stops submitting requests to your application, server, or other
# resource.
#
# * **Calculated health checks:** Route 53 stops aggregating the
# status of the referenced health checks.
#
# * **Health checks that monitor CloudWatch alarms:** Route 53 stops
# monitoring the corresponding CloudWatch metrics.
#
# After you disable a health check, Route 53 considers the status of
# the health check to always be healthy. If you configured DNS
# failover, Route 53 continues to route traffic to the corresponding
# resources. If you want to stop routing traffic to a resource, change
# the value of [Inverted][1].
#
# Charges for a health check still apply when the health check is
# disabled. For more information, see [Amazon Route 53 Pricing][2].
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-Inverted
# [2]: http://aws.amazon.com/route53/pricing/
# @return [Boolean]
#
# @!attribute [rw] health_threshold
# The number of child health checks that are associated with a
# `CALCULATED` health check that Amazon Route 53 must consider healthy
# for the `CALCULATED` health check to be considered healthy. To
# specify the child health checks that you want to associate with a
# `CALCULATED` health check, use the [ChildHealthChecks][1] element.
#
# Note the following:
#
# * If you specify a number greater than the number of child health
# checks, Route 53 always considers this health check to be
# unhealthy.
#
# * If you specify `0`, Route 53 always considers this health check to
# be healthy.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks
# @return [Integer]
#
# @!attribute [rw] child_health_checks
# (CALCULATED Health Checks Only) A complex type that contains one
# `ChildHealthCheck` element for each health check that you want to
# associate with a `CALCULATED` health check.
# @return [Array<String>]
#
# @!attribute [rw] enable_sni
# Specify whether you want Amazon Route 53 to send the value of
# `FullyQualifiedDomainName` to the endpoint in the `client_hello`
# message during TLS negotiation. This allows the endpoint to respond
# to `HTTPS` health check requests with the applicable SSL/TLS
# certificate.
#
# Some endpoints require that `HTTPS` requests include the host name
# in the `client_hello` message. If you don't enable SNI, the status
# of the health check will be `SSL alert handshake_failure`. A health
# check can also have that status for other reasons. If SNI is enabled
# and you're still getting the error, check the SSL/TLS configuration
# on your endpoint and confirm that your certificate is valid.
#
# The SSL/TLS certificate on your endpoint includes a domain name in
# the `Common Name` field and possibly several more in the `Subject
# Alternative Names` field. One of the domain names in the certificate
# should match the value that you specify for
# `FullyQualifiedDomainName`. If the endpoint responds to the
# `client_hello` message with a certificate that does not include the
# domain name that you specified in `FullyQualifiedDomainName`, a
# health checker will retry the handshake. In the second attempt, the
# health checker will omit `FullyQualifiedDomainName` from the
# `client_hello` message.
# @return [Boolean]
#
# @!attribute [rw] regions
# A complex type that contains one `Region` element for each region
# from which you want Amazon Route 53 health checkers to check the
# specified endpoint.
#
# If you don't specify any regions, Route 53 health checkers
# automatically performs checks from all of the regions that are
# listed under **Valid Values**.
#
# If you update a health check to remove a region that has been
# performing health checks, Route 53 will briefly continue to perform
# checks from that region to ensure that some health checkers are
# always checking the endpoint (for example, if you replace three
# regions with four different regions).
# @return [Array<String>]
#
# @!attribute [rw] alarm_identifier
# A complex type that identifies the CloudWatch alarm that you want
# Amazon Route 53 health checkers to use to determine whether the
# specified health check is healthy.
# @return [Types::AlarmIdentifier]
#
# @!attribute [rw] insufficient_data_health_status
# When CloudWatch has insufficient data about the metric to determine
# the alarm state, the status that you want Amazon Route 53 to assign
# to the health check:
#
# * `Healthy`\: Route 53 considers the health check to be healthy.
#
# * `Unhealthy`\: Route 53 considers the health check to be unhealthy.
#
# * `LastKnownStatus`\: Route 53 uses the status of the health check
# from the last time that CloudWatch had sufficient data to
# determine the alarm state. For new health checks that have no last
# known status, the default status for the health check is healthy.
# @return [String]
#
# @!attribute [rw] routing_control_arn
# The Amazon Resource Name (ARN) for the Route 53 Application Recovery
# Controller routing control.
#
# For more information about Route 53 Application Recovery Controller,
# see [Route 53 Application Recovery Controller Developer Guide.][1].
#
#
#
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route-53-recovery.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HealthCheckConfig AWS API Documentation
#
class HealthCheckConfig < Struct.new(
:ip_address,
:port,
:type,
:resource_path,
:fully_qualified_domain_name,
:search_string,
:request_interval,
:failure_threshold,
:measure_latency,
:inverted,
:disabled,
:health_threshold,
:child_health_checks,
:enable_sni,
:regions,
:alarm_identifier,
:insufficient_data_health_status,
:routing_control_arn)
SENSITIVE = []
include Aws::Structure
end
# This error code is not in use.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HealthCheckInUse AWS API Documentation
#
class HealthCheckInUse < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the last failure reason as reported by
# one Amazon Route 53 health checker.
#
# @!attribute [rw] region
# The region of the Amazon Route 53 health checker that provided the
# status in `StatusReport`.
# @return [String]
#
# @!attribute [rw] ip_address
# The IP address of the Amazon Route 53 health checker that provided
# the failure reason in `StatusReport`.
# @return [String]
#
# @!attribute [rw] status_report
# A complex type that contains the last failure reason as reported by
# one Amazon Route 53 health checker and the time of the failed health
# check.
# @return [Types::StatusReport]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HealthCheckObservation AWS API Documentation
#
class HealthCheckObservation < Struct.new(
:region,
:ip_address,
:status_report)
SENSITIVE = []
include Aws::Structure
end
# The value of `HealthCheckVersion` in the request doesn't match the
# value of `HealthCheckVersion` in the health check.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HealthCheckVersionMismatch AWS API Documentation
#
class HealthCheckVersionMismatch < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains general information about the hosted
# zone.
#
# @!attribute [rw] id
# The ID that Amazon Route 53 assigned to the hosted zone when you
# created it.
# @return [String]
#
# @!attribute [rw] name
# The name of the domain. For public hosted zones, this is the name
# that you have registered with your DNS registrar.
#
# For information about how to specify characters other than `a-z`,
# `0-9`, and `-` (hyphen) and how to specify internationalized domain
# names, see [CreateHostedZone][1].
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html
# @return [String]
#
# @!attribute [rw] caller_reference
# The value that you specified for `CallerReference` when you created
# the hosted zone.
# @return [String]
#
# @!attribute [rw] config
# A complex type that includes the `Comment` and `PrivateZone`
# elements. If you omitted the `HostedZoneConfig` and `Comment`
# elements from the request, the `Config` and `Comment` elements
# don't appear in the response.
# @return [Types::HostedZoneConfig]
#
# @!attribute [rw] resource_record_set_count
# The number of resource record sets in the hosted zone.
# @return [Integer]
#
# @!attribute [rw] linked_service
# If the hosted zone was created by another service, the service that
# created the hosted zone. When a hosted zone is created by another
# service, you can't edit or delete it using Route 53.
# @return [Types::LinkedService]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HostedZone AWS API Documentation
#
class HostedZone < Struct.new(
:id,
:name,
:caller_reference,
:config,
:resource_record_set_count,
:linked_service)
SENSITIVE = []
include Aws::Structure
end
# The hosted zone you're trying to create already exists. Amazon Route
# 53 returns this error when a hosted zone has already been created with
# the specified `CallerReference`.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HostedZoneAlreadyExists AWS API Documentation
#
class HostedZoneAlreadyExists < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains an optional comment about your hosted
# zone. If you don't want to specify a comment, omit both the
# `HostedZoneConfig` and `Comment` elements.
#
# @note When making an API call, you may pass HostedZoneConfig
# data as a hash:
#
# {
# comment: "ResourceDescription",
# private_zone: false,
# }
#
# @!attribute [rw] comment
# Any comments that you want to include about the hosted zone.
# @return [String]
#
# @!attribute [rw] private_zone
# A value that indicates whether this is a private hosted zone.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HostedZoneConfig AWS API Documentation
#
class HostedZoneConfig < Struct.new(
:comment,
:private_zone)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the type of limit that you specified in
# the request and the current value for that limit.
#
# @!attribute [rw] type
# The limit that you requested. Valid values include the following:
#
# * **MAX\_RRSETS\_BY\_ZONE**\: The maximum number of records that you
# can create in the specified hosted zone.
#
# * **MAX\_VPCS\_ASSOCIATED\_BY\_ZONE**\: The maximum number of Amazon
# VPCs that you can associate with the specified private hosted
# zone.
# @return [String]
#
# @!attribute [rw] value
# The current value for the limit that is specified by `Type`.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HostedZoneLimit AWS API Documentation
#
class HostedZoneLimit < Struct.new(
:type,
:value)
SENSITIVE = []
include Aws::Structure
end
# The hosted zone contains resource records that are not SOA or NS
# records.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HostedZoneNotEmpty AWS API Documentation
#
class HostedZoneNotEmpty < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The specified HostedZone can't be found.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HostedZoneNotFound AWS API Documentation
#
class HostedZoneNotFound < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The specified hosted zone is a public hosted zone, not a private
# hosted zone.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HostedZoneNotPrivate AWS API Documentation
#
class HostedZoneNotPrivate < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A complex type that identifies a hosted zone that a specified Amazon
# VPC is associated with and the owner of the hosted zone. If there is a
# value for `OwningAccount`, there is no value for `OwningService`, and
# vice versa.
#
# @!attribute [rw] owning_account
# If the hosted zone was created by an Amazon Web Services account, or
# was created by an Amazon Web Services service that creates hosted
# zones using the current account, `OwningAccount` contains the
# account ID of that account. For example, when you use Cloud Map to
# create a hosted zone, Cloud Map creates the hosted zone using the
# current Amazon Web Services account.
# @return [String]
#
# @!attribute [rw] owning_service
# If an Amazon Web Services service uses its own account to create a
# hosted zone and associate the specified VPC with that hosted zone,
# `OwningService` contains an abbreviation that identifies the
# service. For example, if Amazon Elastic File System (Amazon EFS)
# created a hosted zone and associated a VPC with the hosted zone, the
# value of `OwningService` is `efs.amazonaws.com`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HostedZoneOwner AWS API Documentation
#
class HostedZoneOwner < Struct.new(
:owning_account,
:owning_service)
SENSITIVE = []
include Aws::Structure
end
# The hosted zone nameservers don't match the parent nameservers. The
# hosted zone and parent must have the same nameservers.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HostedZonePartiallyDelegated AWS API Documentation
#
class HostedZonePartiallyDelegated < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# In the response to a `ListHostedZonesByVPC` request, the
# `HostedZoneSummaries` element contains one `HostedZoneSummary` element
# for each hosted zone that the specified Amazon VPC is associated with.
# Each `HostedZoneSummary` element contains the hosted zone name and ID,
# and information about who owns the hosted zone.
#
# @!attribute [rw] hosted_zone_id
# The Route 53 hosted zone ID of a private hosted zone that the
# specified VPC is associated with.
# @return [String]
#
# @!attribute [rw] name
# The name of the private hosted zone, such as `example.com`.
# @return [String]
#
# @!attribute [rw] owner
# The owner of a private hosted zone that the specified VPC is
# associated with. The owner can be either an Amazon Web Services
# account or an Amazon Web Services service.
# @return [Types::HostedZoneOwner]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/HostedZoneSummary AWS API Documentation
#
class HostedZoneSummary < Struct.new(
:hosted_zone_id,
:name,
:owner)
SENSITIVE = []
include Aws::Structure
end
# The resource you're trying to access is unsupported on this Amazon
# Route 53 endpoint.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/IncompatibleVersion AWS API Documentation
#
class IncompatibleVersion < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# Amazon Route 53 doesn't have the permissions required to create log
# streams and send query logs to log streams. Possible causes include
# the following:
#
# * There is no resource policy that specifies the log group ARN in the
# value for `Resource`.
#
# * The resource policy that includes the log group ARN in the value for
# `Resource` doesn't have the necessary permissions.
#
# * The resource policy hasn't finished propagating yet.
#
# * The Key management service (KMS) key you specified doesn’t exist or
# it can’t be used with the log group associated with query log.
# Update or provide a resource policy to grant permissions for the KMS
# key.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/InsufficientCloudWatchLogsResourcePolicy AWS API Documentation
#
class InsufficientCloudWatchLogsResourcePolicy < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# Parameter name is not valid.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/InvalidArgument AWS API Documentation
#
class InvalidArgument < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# This exception contains a list of messages that might contain one or
# more error messages. Each error message indicates one error in the
# change batch.
#
# @!attribute [rw] messages
# @return [Array<String>]
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/InvalidChangeBatch AWS API Documentation
#
class InvalidChangeBatch < Struct.new(
:messages,
:message)
SENSITIVE = []
include Aws::Structure
end
# The specified domain name is not valid.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/InvalidDomainName AWS API Documentation
#
class InvalidDomainName < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The input is not valid.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/InvalidInput AWS API Documentation
#
class InvalidInput < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The KeyManagementServiceArn that you specified isn't valid to use
# with DNSSEC signing.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/InvalidKMSArn AWS API Documentation
#
class InvalidKMSArn < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The key-signing key (KSK) name that you specified isn't a valid name.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/InvalidKeySigningKeyName AWS API Documentation
#
class InvalidKeySigningKeyName < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The key-signing key (KSK) status isn't valid or another KSK has the
# status `INTERNAL_FAILURE`.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/InvalidKeySigningKeyStatus AWS API Documentation
#
class InvalidKeySigningKeyStatus < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The value that you specified to get the second or subsequent page of
# results is invalid.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/InvalidPaginationToken AWS API Documentation
#
class InvalidPaginationToken < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# Your hosted zone status isn't valid for this operation. In the hosted
# zone, change the status to enable `DNSSEC` or disable `DNSSEC`.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/InvalidSigningStatus AWS API Documentation
#
class InvalidSigningStatus < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The format of the traffic policy document that you specified in the
# `Document` element is not valid.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/InvalidTrafficPolicyDocument AWS API Documentation
#
class InvalidTrafficPolicyDocument < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The VPC ID that you specified either isn't a valid ID or the current
# account is not authorized to access this VPC.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/InvalidVPCId AWS API Documentation
#
class InvalidVPCId < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A key-signing key (KSK) is a complex type that represents a
# public/private key pair. The private key is used to generate a digital
# signature for the zone signing key (ZSK). The public key is stored in
# the DNS and is used to authenticate the ZSK. A KSK is always
# associated with a hosted zone; it cannot exist by itself.
#
# @!attribute [rw] name
# A string used to identify a key-signing key (KSK). `Name` can
# include numbers, letters, and underscores (\_). `Name` must be
# unique for each key-signing key in the same hosted zone.
# @return [String]
#
# @!attribute [rw] kms_arn
# The Amazon resource name (ARN) used to identify the customer managed
# customer master key (CMK) in Key Management Service (KMS). The
# `KmsArn` must be unique for each key-signing key (KSK) in a single
# hosted zone.
#
# You must configure the CMK as follows:
#
# Status
#
# : Enabled
#
# Key spec
#
# : ECC\_NIST\_P256
#
# Key usage
#
# : Sign and verify
#
# Key policy
#
# : The key policy must give permission for the following actions:
#
# * DescribeKey
#
# * GetPublicKey
#
# * Sign
#
# The key policy must also include the Amazon Route 53 service in
# the principal for your account. Specify the following:
#
# * `"Service": "dnssec-route53.amazonaws.com"`
#
# ^
#
# For more information about working with the customer managed CMK in
# KMS, see [Key Management Service concepts][1].
#
#
#
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html
# @return [String]
#
# @!attribute [rw] flag
# An integer that specifies how the key is used. For key-signing key
# (KSK), this value is always 257.
# @return [Integer]
#
# @!attribute [rw] signing_algorithm_mnemonic
# A string used to represent the signing algorithm. This value must
# follow the guidelines provided by [RFC-8624 Section 3.1][1].
#
#
#
# [1]: https://tools.ietf.org/html/rfc8624#section-3.1
# @return [String]
#
# @!attribute [rw] signing_algorithm_type
# An integer used to represent the signing algorithm. This value must
# follow the guidelines provided by [RFC-8624 Section 3.1][1].
#
#
#
# [1]: https://tools.ietf.org/html/rfc8624#section-3.1
# @return [Integer]
#
# @!attribute [rw] digest_algorithm_mnemonic
# A string used to represent the delegation signer digest algorithm.
# This value must follow the guidelines provided by [RFC-8624 Section
# 3.3][1].
#
#
#
# [1]: https://tools.ietf.org/html/rfc8624#section-3.3
# @return [String]
#
# @!attribute [rw] digest_algorithm_type
# An integer used to represent the delegation signer digest algorithm.
# This value must follow the guidelines provided by [RFC-8624 Section
# 3.3][1].
#
#
#
# [1]: https://tools.ietf.org/html/rfc8624#section-3.3
# @return [Integer]
#
# @!attribute [rw] key_tag
# An integer used to identify the DNSSEC record for the domain name.
# The process used to calculate the value is described in [RFC-4034
# Appendix B][1].
#
#
#
# [1]: https://tools.ietf.org/rfc/rfc4034.txt
# @return [Integer]
#
# @!attribute [rw] digest_value
# A cryptographic digest of a DNSKEY resource record (RR). DNSKEY
# records are used to publish the public key that resolvers can use to
# verify DNSSEC signatures that are used to secure certain kinds of
# information provided by the DNS system.
# @return [String]
#
# @!attribute [rw] public_key
# The public key, represented as a Base64 encoding, as required by [
# RFC-4034 Page 5][1].
#
#
#
# [1]: https://tools.ietf.org/rfc/rfc4034.txt
# @return [String]
#
# @!attribute [rw] ds_record
# A string that represents a delegation signer (DS) record.
# @return [String]
#
# @!attribute [rw] dnskey_record
# A string that represents a DNSKEY record.
# @return [String]
#
# @!attribute [rw] status
# A string that represents the current key-signing key (KSK) status.
#
# Status can have one of the following values:
#
# ACTIVE
#
# : The KSK is being used for signing.
#
# INACTIVE
#
# : The KSK is not being used for signing.
#
# DELETING
#
# : The KSK is in the process of being deleted.
#
# ACTION\_NEEDED
#
# : There is a problem with the KSK that requires you to take action
# to resolve. For example, the customer managed customer master key
# (CMK) might have been deleted, or the permissions for the customer
# managed CMK might have been changed.
#
# INTERNAL\_FAILURE
#
# : There was an error during a request. Before you can continue to
# work with DNSSEC signing, including actions that involve this KSK,
# you must correct the problem. For example, you may need to
# activate or deactivate the KSK.
# @return [String]
#
# @!attribute [rw] status_message
# The status message provided for the following key-signing key (KSK)
# statuses: `ACTION_NEEDED` or `INTERNAL_FAILURE`. The status message
# includes information about what the problem might be and steps that
# you can take to correct the issue.
# @return [String]
#
# @!attribute [rw] created_date
# The date when the key-signing key (KSK) was created.
# @return [Time]
#
# @!attribute [rw] last_modified_date
# The last time that the key-signing key (KSK) was changed.
# @return [Time]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/KeySigningKey AWS API Documentation
#
class KeySigningKey < Struct.new(
:name,
:kms_arn,
:flag,
:signing_algorithm_mnemonic,
:signing_algorithm_type,
:digest_algorithm_mnemonic,
:digest_algorithm_type,
:key_tag,
:digest_value,
:public_key,
:ds_record,
:dnskey_record,
:status,
:status_message,
:created_date,
:last_modified_date)
SENSITIVE = []
include Aws::Structure
end
# You've already created a key-signing key (KSK) with this name or with
# the same customer managed customer master key (CMK) ARN.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/KeySigningKeyAlreadyExists AWS API Documentation
#
class KeySigningKeyAlreadyExists < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The key-signing key (KSK) is specified in a parent DS record.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/KeySigningKeyInParentDSRecord AWS API Documentation
#
class KeySigningKeyInParentDSRecord < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The key-signing key (KSK) that you specified can't be deactivated
# because it's the only KSK for a currently-enabled DNSSEC. Disable
# DNSSEC signing, or add or enable another KSK.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/KeySigningKeyInUse AWS API Documentation
#
class KeySigningKeyInUse < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A key-signing key (KSK) with `ACTIVE` status wasn't found.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/KeySigningKeyWithActiveStatusNotFound AWS API Documentation
#
class KeySigningKeyWithActiveStatusNotFound < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The VPC that you're trying to disassociate from the private hosted
# zone is the last VPC that is associated with the hosted zone. Amazon
# Route 53 doesn't support disassociating the last VPC from a hosted
# zone.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/LastVPCAssociation AWS API Documentation
#
class LastVPCAssociation < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# This operation can't be completed either because the current account
# has reached the limit on reusable delegation sets that it can create
# or because you've reached the limit on the number of Amazon VPCs that
# you can associate with a private hosted zone. To get the current limit
# on the number of reusable delegation sets, see [GetAccountLimit][1].
# To get the current limit on the number of Amazon VPCs that you can
# associate with a private hosted zone, see [GetHostedZoneLimit][2]. To
# request a higher limit, [create a case][3] with the Amazon Web
# Services Support Center.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetHostedZoneLimit.html
# [3]: http://aws.amazon.com/route53-request
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/LimitsExceeded AWS API Documentation
#
class LimitsExceeded < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# If a health check or hosted zone was created by another service,
# `LinkedService` is a complex type that describes the service that
# created the resource. When a resource is created by another service,
# you can't edit or delete it using Amazon Route 53.
#
# @!attribute [rw] service_principal
# If the health check or hosted zone was created by another service,
# the service that created the resource. When a resource is created by
# another service, you can't edit or delete it using Amazon Route 53.
# @return [String]
#
# @!attribute [rw] description
# If the health check or hosted zone was created by another service,
# an optional description that can be provided by the other service.
# When a resource is created by another service, you can't edit or
# delete it using Amazon Route 53.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/LinkedService AWS API Documentation
#
class LinkedService < Struct.new(
:service_principal,
:description)
SENSITIVE = []
include Aws::Structure
end
# A request to get a list of geographic locations that Amazon Route 53
# supports for geolocation resource record sets.
#
# @note When making an API call, you may pass ListGeoLocationsRequest
# data as a hash:
#
# {
# start_continent_code: "GeoLocationContinentCode",
# start_country_code: "GeoLocationCountryCode",
# start_subdivision_code: "GeoLocationSubdivisionCode",
# max_items: 1,
# }
#
# @!attribute [rw] start_continent_code
# The code for the continent with which you want to start listing
# locations that Amazon Route 53 supports for geolocation. If Route 53
# has already returned a page or more of results, if `IsTruncated` is
# true, and if `NextContinentCode` from the previous response has a
# value, enter that value in `startcontinentcode` to return the next
# page of results.
#
# Include `startcontinentcode` only if you want to list continents.
# Don't include `startcontinentcode` when you're listing countries
# or countries with their subdivisions.
# @return [String]
#
# @!attribute [rw] start_country_code
# The code for the country with which you want to start listing
# locations that Amazon Route 53 supports for geolocation. If Route 53
# has already returned a page or more of results, if `IsTruncated` is
# `true`, and if `NextCountryCode` from the previous response has a
# value, enter that value in `startcountrycode` to return the next
# page of results.
# @return [String]
#
# @!attribute [rw] start_subdivision_code
# The code for the state of the United States with which you want to
# start listing locations that Amazon Route 53 supports for
# geolocation. If Route 53 has already returned a page or more of
# results, if `IsTruncated` is `true`, and if `NextSubdivisionCode`
# from the previous response has a value, enter that value in
# `startsubdivisioncode` to return the next page of results.
#
# To list subdivisions (U.S. states), you must include both
# `startcountrycode` and `startsubdivisioncode`.
# @return [String]
#
# @!attribute [rw] max_items
# (Optional) The maximum number of geolocations to be included in the
# response body for this request. If more than `maxitems` geolocations
# remain to be listed, then the value of the `IsTruncated` element in
# the response is `true`.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListGeoLocationsRequest AWS API Documentation
#
class ListGeoLocationsRequest < Struct.new(
:start_continent_code,
:start_country_code,
:start_subdivision_code,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type containing the response information for the request.
#
# @!attribute [rw] geo_location_details_list
# A complex type that contains one `GeoLocationDetails` element for
# each location that Amazon Route 53 supports for geolocation.
# @return [Array<Types::GeoLocationDetails>]
#
# @!attribute [rw] is_truncated
# A value that indicates whether more locations remain to be listed
# after the last location in this response. If so, the value of
# `IsTruncated` is `true`. To get more values, submit another request
# and include the values of `NextContinentCode`, `NextCountryCode`,
# and `NextSubdivisionCode` in the `startcontinentcode`,
# `startcountrycode`, and `startsubdivisioncode`, as applicable.
# @return [Boolean]
#
# @!attribute [rw] next_continent_code
# If `IsTruncated` is `true`, you can make a follow-up request to
# display more locations. Enter the value of `NextContinentCode` in
# the `startcontinentcode` parameter in another `ListGeoLocations`
# request.
# @return [String]
#
# @!attribute [rw] next_country_code
# If `IsTruncated` is `true`, you can make a follow-up request to
# display more locations. Enter the value of `NextCountryCode` in the
# `startcountrycode` parameter in another `ListGeoLocations` request.
# @return [String]
#
# @!attribute [rw] next_subdivision_code
# If `IsTruncated` is `true`, you can make a follow-up request to
# display more locations. Enter the value of `NextSubdivisionCode` in
# the `startsubdivisioncode` parameter in another `ListGeoLocations`
# request.
# @return [String]
#
# @!attribute [rw] max_items
# The value that you specified for `MaxItems` in the request.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListGeoLocationsResponse AWS API Documentation
#
class ListGeoLocationsResponse < Struct.new(
:geo_location_details_list,
:is_truncated,
:next_continent_code,
:next_country_code,
:next_subdivision_code,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A request to retrieve a list of the health checks that are associated
# with the current Amazon Web Services account.
#
# @note When making an API call, you may pass ListHealthChecksRequest
# data as a hash:
#
# {
# marker: "PageMarker",
# max_items: 1,
# }
#
# @!attribute [rw] marker
# If the value of `IsTruncated` in the previous response was `true`,
# you have more health checks. To get another group, submit another
# `ListHealthChecks` request.
#
# For the value of `marker`, specify the value of `NextMarker` from
# the previous response, which is the ID of the first health check
# that Amazon Route 53 will return if you submit another request.
#
# If the value of `IsTruncated` in the previous response was `false`,
# there are no more health checks to get.
# @return [String]
#
# @!attribute [rw] max_items
# The maximum number of health checks that you want `ListHealthChecks`
# to return in response to the current request. Amazon Route 53
# returns a maximum of 100 items. If you set `MaxItems` to a value
# greater than 100, Route 53 returns only the first 100 health checks.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListHealthChecksRequest AWS API Documentation
#
class ListHealthChecksRequest < Struct.new(
:marker,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response to a `ListHealthChecks`
# request.
#
# @!attribute [rw] health_checks
# A complex type that contains one `HealthCheck` element for each
# health check that is associated with the current Amazon Web Services
# account.
# @return [Array<Types::HealthCheck>]
#
# @!attribute [rw] marker
# For the second and subsequent calls to `ListHealthChecks`, `Marker`
# is the value that you specified for the `marker` parameter in the
# previous request.
# @return [String]
#
# @!attribute [rw] is_truncated
# A flag that indicates whether there are more health checks to be
# listed. If the response was truncated, you can get the next group of
# health checks by submitting another `ListHealthChecks` request and
# specifying the value of `NextMarker` in the `marker` parameter.
# @return [Boolean]
#
# @!attribute [rw] next_marker
# If `IsTruncated` is `true`, the value of `NextMarker` identifies the
# first health check that Amazon Route 53 returns if you submit
# another `ListHealthChecks` request and specify the value of
# `NextMarker` in the `marker` parameter.
# @return [String]
#
# @!attribute [rw] max_items
# The value that you specified for the `maxitems` parameter in the
# call to `ListHealthChecks` that produced the current response.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListHealthChecksResponse AWS API Documentation
#
class ListHealthChecksResponse < Struct.new(
:health_checks,
:marker,
:is_truncated,
:next_marker,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# Retrieves a list of the public and private hosted zones that are
# associated with the current Amazon Web Services account in ASCII order
# by domain name.
#
# @note When making an API call, you may pass ListHostedZonesByNameRequest
# data as a hash:
#
# {
# dns_name: "DNSName",
# hosted_zone_id: "ResourceId",
# max_items: 1,
# }
#
# @!attribute [rw] dns_name
# (Optional) For your first request to `ListHostedZonesByName`,
# include the `dnsname` parameter only if you want to specify the name
# of the first hosted zone in the response. If you don't include the
# `dnsname` parameter, Amazon Route 53 returns all of the hosted zones
# that were created by the current Amazon Web Services account, in
# ASCII order. For subsequent requests, include both `dnsname` and
# `hostedzoneid` parameters. For `dnsname`, specify the value of
# `NextDNSName` from the previous response.
# @return [String]
#
# @!attribute [rw] hosted_zone_id
# (Optional) For your first request to `ListHostedZonesByName`, do not
# include the `hostedzoneid` parameter.
#
# If you have more hosted zones than the value of `maxitems`,
# `ListHostedZonesByName` returns only the first `maxitems` hosted
# zones. To get the next group of `maxitems` hosted zones, submit
# another request to `ListHostedZonesByName` and include both
# `dnsname` and `hostedzoneid` parameters. For the value of
# `hostedzoneid`, specify the value of the `NextHostedZoneId` element
# from the previous response.
# @return [String]
#
# @!attribute [rw] max_items
# The maximum number of hosted zones to be included in the response
# body for this request. If you have more than `maxitems` hosted
# zones, then the value of the `IsTruncated` element in the response
# is true, and the values of `NextDNSName` and `NextHostedZoneId`
# specify the first hosted zone in the next group of `maxitems` hosted
# zones.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListHostedZonesByNameRequest AWS API Documentation
#
class ListHostedZonesByNameRequest < Struct.new(
:dns_name,
:hosted_zone_id,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the request.
#
# @!attribute [rw] hosted_zones
# A complex type that contains general information about the hosted
# zone.
# @return [Array<Types::HostedZone>]
#
# @!attribute [rw] dns_name
# For the second and subsequent calls to `ListHostedZonesByName`,
# `DNSName` is the value that you specified for the `dnsname`
# parameter in the request that produced the current response.
# @return [String]
#
# @!attribute [rw] hosted_zone_id
# The ID that Amazon Route 53 assigned to the hosted zone when you
# created it.
# @return [String]
#
# @!attribute [rw] is_truncated
# A flag that indicates whether there are more hosted zones to be
# listed. If the response was truncated, you can get the next group of
# `maxitems` hosted zones by calling `ListHostedZonesByName` again and
# specifying the values of `NextDNSName` and `NextHostedZoneId`
# elements in the `dnsname` and `hostedzoneid` parameters.
# @return [Boolean]
#
# @!attribute [rw] next_dns_name
# If `IsTruncated` is true, the value of `NextDNSName` is the name of
# the first hosted zone in the next group of `maxitems` hosted zones.
# Call `ListHostedZonesByName` again and specify the value of
# `NextDNSName` and `NextHostedZoneId` in the `dnsname` and
# `hostedzoneid` parameters, respectively.
#
# This element is present only if `IsTruncated` is `true`.
# @return [String]
#
# @!attribute [rw] next_hosted_zone_id
# If `IsTruncated` is `true`, the value of `NextHostedZoneId`
# identifies the first hosted zone in the next group of `maxitems`
# hosted zones. Call `ListHostedZonesByName` again and specify the
# value of `NextDNSName` and `NextHostedZoneId` in the `dnsname` and
# `hostedzoneid` parameters, respectively.
#
# This element is present only if `IsTruncated` is `true`.
# @return [String]
#
# @!attribute [rw] max_items
# The value that you specified for the `maxitems` parameter in the
# call to `ListHostedZonesByName` that produced the current response.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListHostedZonesByNameResponse AWS API Documentation
#
class ListHostedZonesByNameResponse < Struct.new(
:hosted_zones,
:dns_name,
:hosted_zone_id,
:is_truncated,
:next_dns_name,
:next_hosted_zone_id,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# Lists all the private hosted zones that a specified VPC is associated
# with, regardless of which Amazon Web Services account created the
# hosted zones.
#
# @note When making an API call, you may pass ListHostedZonesByVPCRequest
# data as a hash:
#
# {
# vpc_id: "VPCId", # required
# vpc_region: "us-east-1", # required, accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ap-east-1, me-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1, ap-southeast-1, ap-southeast-2, ap-south-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, ca-central-1, cn-north-1, af-south-1, eu-south-1
# max_items: 1,
# next_token: "PaginationToken",
# }
#
# @!attribute [rw] vpc_id
# The ID of the Amazon VPC that you want to list hosted zones for.
# @return [String]
#
# @!attribute [rw] vpc_region
# For the Amazon VPC that you specified for `VPCId`, the Amazon Web
# Services Region that you created the VPC in.
# @return [String]
#
# @!attribute [rw] max_items
# (Optional) The maximum number of hosted zones that you want Amazon
# Route 53 to return. If the specified VPC is associated with more
# than `MaxItems` hosted zones, the response includes a `NextToken`
# element. `NextToken` contains an encrypted token that identifies the
# first hosted zone that Route 53 will return if you submit another
# request.
# @return [Integer]
#
# @!attribute [rw] next_token
# If the previous response included a `NextToken` element, the
# specified VPC is associated with more hosted zones. To get more
# hosted zones, submit another `ListHostedZonesByVPC` request.
#
# For the value of `NextToken`, specify the value of `NextToken` from
# the previous response.
#
# If the previous response didn't include a `NextToken` element,
# there are no more hosted zones to get.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListHostedZonesByVPCRequest AWS API Documentation
#
class ListHostedZonesByVPCRequest < Struct.new(
:vpc_id,
:vpc_region,
:max_items,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] hosted_zone_summaries
# A list that contains one `HostedZoneSummary` element for each hosted
# zone that the specified Amazon VPC is associated with. Each
# `HostedZoneSummary` element contains the hosted zone name and ID,
# and information about who owns the hosted zone.
# @return [Array<Types::HostedZoneSummary>]
#
# @!attribute [rw] max_items
# The value that you specified for `MaxItems` in the most recent
# `ListHostedZonesByVPC` request.
# @return [Integer]
#
# @!attribute [rw] next_token
# The value that you will use for `NextToken` in the next
# `ListHostedZonesByVPC` request.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListHostedZonesByVPCResponse AWS API Documentation
#
class ListHostedZonesByVPCResponse < Struct.new(
:hosted_zone_summaries,
:max_items,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# A request to retrieve a list of the public and private hosted zones
# that are associated with the current Amazon Web Services account.
#
# @note When making an API call, you may pass ListHostedZonesRequest
# data as a hash:
#
# {
# marker: "PageMarker",
# max_items: 1,
# delegation_set_id: "ResourceId",
# }
#
# @!attribute [rw] marker
# If the value of `IsTruncated` in the previous response was `true`,
# you have more hosted zones. To get more hosted zones, submit another
# `ListHostedZones` request.
#
# For the value of `marker`, specify the value of `NextMarker` from
# the previous response, which is the ID of the first hosted zone that
# Amazon Route 53 will return if you submit another request.
#
# If the value of `IsTruncated` in the previous response was `false`,
# there are no more hosted zones to get.
# @return [String]
#
# @!attribute [rw] max_items
# (Optional) The maximum number of hosted zones that you want Amazon
# Route 53 to return. If you have more than `maxitems` hosted zones,
# the value of `IsTruncated` in the response is `true`, and the value
# of `NextMarker` is the hosted zone ID of the first hosted zone that
# Route 53 will return if you submit another request.
# @return [Integer]
#
# @!attribute [rw] delegation_set_id
# If you're using reusable delegation sets and you want to list all
# of the hosted zones that are associated with a reusable delegation
# set, specify the ID of that reusable delegation set.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListHostedZonesRequest AWS API Documentation
#
class ListHostedZonesRequest < Struct.new(
:marker,
:max_items,
:delegation_set_id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] hosted_zones
# A complex type that contains general information about the hosted
# zone.
# @return [Array<Types::HostedZone>]
#
# @!attribute [rw] marker
# For the second and subsequent calls to `ListHostedZones`, `Marker`
# is the value that you specified for the `marker` parameter in the
# request that produced the current response.
# @return [String]
#
# @!attribute [rw] is_truncated
# A flag indicating whether there are more hosted zones to be listed.
# If the response was truncated, you can get more hosted zones by
# submitting another `ListHostedZones` request and specifying the
# value of `NextMarker` in the `marker` parameter.
# @return [Boolean]
#
# @!attribute [rw] next_marker
# If `IsTruncated` is `true`, the value of `NextMarker` identifies the
# first hosted zone in the next group of hosted zones. Submit another
# `ListHostedZones` request, and specify the value of `NextMarker`
# from the response in the `marker` parameter.
#
# This element is present only if `IsTruncated` is `true`.
# @return [String]
#
# @!attribute [rw] max_items
# The value that you specified for the `maxitems` parameter in the
# call to `ListHostedZones` that produced the current response.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListHostedZonesResponse AWS API Documentation
#
class ListHostedZonesResponse < Struct.new(
:hosted_zones,
:marker,
:is_truncated,
:next_marker,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass ListQueryLoggingConfigsRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId",
# next_token: "PaginationToken",
# max_results: "MaxResults",
# }
#
# @!attribute [rw] hosted_zone_id
# (Optional) If you want to list the query logging configuration that
# is associated with a hosted zone, specify the ID in `HostedZoneId`.
#
# If you don't specify a hosted zone ID, `ListQueryLoggingConfigs`
# returns all of the configurations that are associated with the
# current Amazon Web Services account.
# @return [String]
#
# @!attribute [rw] next_token
# (Optional) If the current Amazon Web Services account has more than
# `MaxResults` query logging configurations, use `NextToken` to get
# the second and subsequent pages of results.
#
# For the first `ListQueryLoggingConfigs` request, omit this value.
#
# For the second and subsequent requests, get the value of `NextToken`
# from the previous response and specify that value for `NextToken` in
# the request.
# @return [String]
#
# @!attribute [rw] max_results
# (Optional) The maximum number of query logging configurations that
# you want Amazon Route 53 to return in response to the current
# request. If the current Amazon Web Services account has more than
# `MaxResults` configurations, use the value of [NextToken][1] in the
# response to get the next page of results.
#
# If you don't specify a value for `MaxResults`, Route 53 returns up
# to 100 configurations.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html#API_ListQueryLoggingConfigs_RequestSyntax
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListQueryLoggingConfigsRequest AWS API Documentation
#
class ListQueryLoggingConfigsRequest < Struct.new(
:hosted_zone_id,
:next_token,
:max_results)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] query_logging_configs
# An array that contains one [QueryLoggingConfig][1] element for each
# configuration for DNS query logging that is associated with the
# current Amazon Web Services account.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_QueryLoggingConfig.html
# @return [Array<Types::QueryLoggingConfig>]
#
# @!attribute [rw] next_token
# If a response includes the last of the query logging configurations
# that are associated with the current Amazon Web Services account,
# `NextToken` doesn't appear in the response.
#
# If a response doesn't include the last of the configurations, you
# can get more configurations by submitting another
# [ListQueryLoggingConfigs][1] request. Get the value of `NextToken`
# that Amazon Route 53 returned in the previous response and include
# it in `NextToken` in the next request.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListQueryLoggingConfigsResponse AWS API Documentation
#
class ListQueryLoggingConfigsResponse < Struct.new(
:query_logging_configs,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# A request for the resource record sets that are associated with a
# specified hosted zone.
#
# @note When making an API call, you may pass ListResourceRecordSetsRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# start_record_name: "DNSName",
# start_record_type: "SOA", # accepts SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA, DS
# start_record_identifier: "ResourceRecordSetIdentifier",
# max_items: 1,
# }
#
# @!attribute [rw] hosted_zone_id
# The ID of the hosted zone that contains the resource record sets
# that you want to list.
# @return [String]
#
# @!attribute [rw] start_record_name
# The first name in the lexicographic ordering of resource record sets
# that you want to list. If the specified record name doesn't exist,
# the results begin with the first resource record set that has a name
# greater than the value of `name`.
# @return [String]
#
# @!attribute [rw] start_record_type
# The type of resource record set to begin the record listing from.
#
# Valid values for basic resource record sets: `A` \| `AAAA` \| `CAA`
# \| `CNAME` \| `MX` \| `NAPTR` \| `NS` \| `PTR` \| `SOA` \| `SPF` \|
# `SRV` \| `TXT`
#
# Values for weighted, latency, geolocation, and failover resource
# record sets: `A` \| `AAAA` \| `CAA` \| `CNAME` \| `MX` \| `NAPTR` \|
# `PTR` \| `SPF` \| `SRV` \| `TXT`
#
# Values for alias resource record sets:
#
# * **API Gateway custom regional API or edge-optimized API**\: A
#
# * **CloudFront distribution**\: A or AAAA
#
# * **Elastic Beanstalk environment that has a regionalized
# subdomain**\: A
#
# * **Elastic Load Balancing load balancer**\: A \| AAAA
#
# * **S3 bucket**\: A
#
# * **VPC interface VPC endpoint**\: A
#
# * **Another resource record set in this hosted zone:** The type of
# the resource record set that the alias references.
#
# Constraint: Specifying `type` without specifying `name` returns an
# `InvalidInput` error.
# @return [String]
#
# @!attribute [rw] start_record_identifier
# *Resource record sets that have a routing policy other than simple:*
# If results were truncated for a given DNS name and type, specify the
# value of `NextRecordIdentifier` from the previous response to get
# the next resource record set that has the current DNS name and type.
# @return [String]
#
# @!attribute [rw] max_items
# (Optional) The maximum number of resource records sets to include in
# the response body for this request. If the response includes more
# than `maxitems` resource record sets, the value of the `IsTruncated`
# element in the response is `true`, and the values of the
# `NextRecordName` and `NextRecordType` elements in the response
# identify the first resource record set in the next group of
# `maxitems` resource record sets.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListResourceRecordSetsRequest AWS API Documentation
#
class ListResourceRecordSetsRequest < Struct.new(
:hosted_zone_id,
:start_record_name,
:start_record_type,
:start_record_identifier,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains list information for the resource record
# set.
#
# @!attribute [rw] resource_record_sets
# Information about multiple resource record sets.
# @return [Array<Types::ResourceRecordSet>]
#
# @!attribute [rw] is_truncated
# A flag that indicates whether more resource record sets remain to be
# listed. If your results were truncated, you can make a follow-up
# pagination request by using the `NextRecordName` element.
# @return [Boolean]
#
# @!attribute [rw] next_record_name
# If the results were truncated, the name of the next record in the
# list.
#
# This element is present only if `IsTruncated` is true.
# @return [String]
#
# @!attribute [rw] next_record_type
# If the results were truncated, the type of the next record in the
# list.
#
# This element is present only if `IsTruncated` is true.
# @return [String]
#
# @!attribute [rw] next_record_identifier
# *Resource record sets that have a routing policy other than simple:*
# If results were truncated for a given DNS name and type, the value
# of `SetIdentifier` for the next resource record set that has the
# current DNS name and type.
#
# For information about routing policies, see [Choosing a Routing
# Policy][1] in the *Amazon Route 53 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html
# @return [String]
#
# @!attribute [rw] max_items
# The maximum number of records you requested.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListResourceRecordSetsResponse AWS API Documentation
#
class ListResourceRecordSetsResponse < Struct.new(
:resource_record_sets,
:is_truncated,
:next_record_name,
:next_record_type,
:next_record_identifier,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A request to get a list of the reusable delegation sets that are
# associated with the current Amazon Web Services account.
#
# @note When making an API call, you may pass ListReusableDelegationSetsRequest
# data as a hash:
#
# {
# marker: "PageMarker",
# max_items: 1,
# }
#
# @!attribute [rw] marker
# If the value of `IsTruncated` in the previous response was `true`,
# you have more reusable delegation sets. To get another group, submit
# another `ListReusableDelegationSets` request.
#
# For the value of `marker`, specify the value of `NextMarker` from
# the previous response, which is the ID of the first reusable
# delegation set that Amazon Route 53 will return if you submit
# another request.
#
# If the value of `IsTruncated` in the previous response was `false`,
# there are no more reusable delegation sets to get.
# @return [String]
#
# @!attribute [rw] max_items
# The number of reusable delegation sets that you want Amazon Route 53
# to return in the response to this request. If you specify a value
# greater than 100, Route 53 returns only the first 100 reusable
# delegation sets.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListReusableDelegationSetsRequest AWS API Documentation
#
class ListReusableDelegationSetsRequest < Struct.new(
:marker,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the reusable delegation
# sets that are associated with the current Amazon Web Services account.
#
# @!attribute [rw] delegation_sets
# A complex type that contains one `DelegationSet` element for each
# reusable delegation set that was created by the current Amazon Web
# Services account.
# @return [Array<Types::DelegationSet>]
#
# @!attribute [rw] marker
# For the second and subsequent calls to `ListReusableDelegationSets`,
# `Marker` is the value that you specified for the `marker` parameter
# in the request that produced the current response.
# @return [String]
#
# @!attribute [rw] is_truncated
# A flag that indicates whether there are more reusable delegation
# sets to be listed.
# @return [Boolean]
#
# @!attribute [rw] next_marker
# If `IsTruncated` is `true`, the value of `NextMarker` identifies the
# next reusable delegation set that Amazon Route 53 will return if you
# submit another `ListReusableDelegationSets` request and specify the
# value of `NextMarker` in the `marker` parameter.
# @return [String]
#
# @!attribute [rw] max_items
# The value that you specified for the `maxitems` parameter in the
# call to `ListReusableDelegationSets` that produced the current
# response.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListReusableDelegationSetsResponse AWS API Documentation
#
class ListReusableDelegationSetsResponse < Struct.new(
:delegation_sets,
:marker,
:is_truncated,
:next_marker,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type containing information about a request for a list of
# the tags that are associated with an individual resource.
#
# @note When making an API call, you may pass ListTagsForResourceRequest
# data as a hash:
#
# {
# resource_type: "healthcheck", # required, accepts healthcheck, hostedzone
# resource_id: "TagResourceId", # required
# }
#
# @!attribute [rw] resource_type
# The type of the resource.
#
# * The resource type for health checks is `healthcheck`.
#
# * The resource type for hosted zones is `hostedzone`.
# @return [String]
#
# @!attribute [rw] resource_id
# The ID of the resource for which you want to retrieve tags.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTagsForResourceRequest AWS API Documentation
#
class ListTagsForResourceRequest < Struct.new(
:resource_type,
:resource_id)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the health checks or
# hosted zones for which you want to list tags.
#
# @!attribute [rw] resource_tag_set
# A `ResourceTagSet` containing tags associated with the specified
# resource.
# @return [Types::ResourceTagSet]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTagsForResourceResponse AWS API Documentation
#
class ListTagsForResourceResponse < Struct.new(
:resource_tag_set)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the health checks or
# hosted zones for which you want to list tags.
#
# @note When making an API call, you may pass ListTagsForResourcesRequest
# data as a hash:
#
# {
# resource_type: "healthcheck", # required, accepts healthcheck, hostedzone
# resource_ids: ["TagResourceId"], # required
# }
#
# @!attribute [rw] resource_type
# The type of the resources.
#
# * The resource type for health checks is `healthcheck`.
#
# * The resource type for hosted zones is `hostedzone`.
# @return [String]
#
# @!attribute [rw] resource_ids
# A complex type that contains the ResourceId element for each
# resource for which you want to get a list of tags.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTagsForResourcesRequest AWS API Documentation
#
class ListTagsForResourcesRequest < Struct.new(
:resource_type,
:resource_ids)
SENSITIVE = []
include Aws::Structure
end
# A complex type containing tags for the specified resources.
#
# @!attribute [rw] resource_tag_sets
# A list of `ResourceTagSet`s containing tags associated with the
# specified resources.
# @return [Array<Types::ResourceTagSet>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTagsForResourcesResponse AWS API Documentation
#
class ListTagsForResourcesResponse < Struct.new(
:resource_tag_sets)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the information about the request to list
# the traffic policies that are associated with the current Amazon Web
# Services account.
#
# @note When making an API call, you may pass ListTrafficPoliciesRequest
# data as a hash:
#
# {
# traffic_policy_id_marker: "TrafficPolicyId",
# max_items: 1,
# }
#
# @!attribute [rw] traffic_policy_id_marker
# (Conditional) For your first request to `ListTrafficPolicies`,
# don't include the `TrafficPolicyIdMarker` parameter.
#
# If you have more traffic policies than the value of `MaxItems`,
# `ListTrafficPolicies` returns only the first `MaxItems` traffic
# policies. To get the next group of policies, submit another request
# to `ListTrafficPolicies`. For the value of `TrafficPolicyIdMarker`,
# specify the value of `TrafficPolicyIdMarker` that was returned in
# the previous response.
# @return [String]
#
# @!attribute [rw] max_items
# (Optional) The maximum number of traffic policies that you want
# Amazon Route 53 to return in response to this request. If you have
# more than `MaxItems` traffic policies, the value of `IsTruncated` in
# the response is `true`, and the value of `TrafficPolicyIdMarker` is
# the ID of the first traffic policy that Route 53 will return if you
# submit another request.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTrafficPoliciesRequest AWS API Documentation
#
class ListTrafficPoliciesRequest < Struct.new(
:traffic_policy_id_marker,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the request.
#
# @!attribute [rw] traffic_policy_summaries
# A list that contains one `TrafficPolicySummary` element for each
# traffic policy that was created by the current Amazon Web Services
# account.
# @return [Array<Types::TrafficPolicySummary>]
#
# @!attribute [rw] is_truncated
# A flag that indicates whether there are more traffic policies to be
# listed. If the response was truncated, you can get the next group of
# traffic policies by submitting another `ListTrafficPolicies` request
# and specifying the value of `TrafficPolicyIdMarker` in the
# `TrafficPolicyIdMarker` request parameter.
# @return [Boolean]
#
# @!attribute [rw] traffic_policy_id_marker
# If the value of `IsTruncated` is `true`, `TrafficPolicyIdMarker` is
# the ID of the first traffic policy in the next group of `MaxItems`
# traffic policies.
# @return [String]
#
# @!attribute [rw] max_items
# The value that you specified for the `MaxItems` parameter in the
# `ListTrafficPolicies` request that produced the current response.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTrafficPoliciesResponse AWS API Documentation
#
class ListTrafficPoliciesResponse < Struct.new(
:traffic_policy_summaries,
:is_truncated,
:traffic_policy_id_marker,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A request for the traffic policy instances that you created in a
# specified hosted zone.
#
# @note When making an API call, you may pass ListTrafficPolicyInstancesByHostedZoneRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# traffic_policy_instance_name_marker: "DNSName",
# traffic_policy_instance_type_marker: "SOA", # accepts SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA, DS
# max_items: 1,
# }
#
# @!attribute [rw] hosted_zone_id
# The ID of the hosted zone that you want to list traffic policy
# instances for.
# @return [String]
#
# @!attribute [rw] traffic_policy_instance_name_marker
# If the value of `IsTruncated` in the previous response is true, you
# have more traffic policy instances. To get more traffic policy
# instances, submit another `ListTrafficPolicyInstances` request. For
# the value of `trafficpolicyinstancename`, specify the value of
# `TrafficPolicyInstanceNameMarker` from the previous response, which
# is the name of the first traffic policy instance in the next group
# of traffic policy instances.
#
# If the value of `IsTruncated` in the previous response was `false`,
# there are no more traffic policy instances to get.
# @return [String]
#
# @!attribute [rw] traffic_policy_instance_type_marker
# If the value of `IsTruncated` in the previous response is true, you
# have more traffic policy instances. To get more traffic policy
# instances, submit another `ListTrafficPolicyInstances` request. For
# the value of `trafficpolicyinstancetype`, specify the value of
# `TrafficPolicyInstanceTypeMarker` from the previous response, which
# is the type of the first traffic policy instance in the next group
# of traffic policy instances.
#
# If the value of `IsTruncated` in the previous response was `false`,
# there are no more traffic policy instances to get.
# @return [String]
#
# @!attribute [rw] max_items
# The maximum number of traffic policy instances to be included in the
# response body for this request. If you have more than `MaxItems`
# traffic policy instances, the value of the `IsTruncated` element in
# the response is `true`, and the values of `HostedZoneIdMarker`,
# `TrafficPolicyInstanceNameMarker`, and
# `TrafficPolicyInstanceTypeMarker` represent the first traffic policy
# instance that Amazon Route 53 will return if you submit another
# request.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTrafficPolicyInstancesByHostedZoneRequest AWS API Documentation
#
class ListTrafficPolicyInstancesByHostedZoneRequest < Struct.new(
:hosted_zone_id,
:traffic_policy_instance_name_marker,
:traffic_policy_instance_type_marker,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the request.
#
# @!attribute [rw] traffic_policy_instances
# A list that contains one `TrafficPolicyInstance` element for each
# traffic policy instance that matches the elements in the request.
# @return [Array<Types::TrafficPolicyInstance>]
#
# @!attribute [rw] traffic_policy_instance_name_marker
# If `IsTruncated` is `true`, `TrafficPolicyInstanceNameMarker` is the
# name of the first traffic policy instance in the next group of
# traffic policy instances.
# @return [String]
#
# @!attribute [rw] traffic_policy_instance_type_marker
# If `IsTruncated` is true, `TrafficPolicyInstanceTypeMarker` is the
# DNS type of the resource record sets that are associated with the
# first traffic policy instance in the next group of traffic policy
# instances.
# @return [String]
#
# @!attribute [rw] is_truncated
# A flag that indicates whether there are more traffic policy
# instances to be listed. If the response was truncated, you can get
# the next group of traffic policy instances by submitting another
# `ListTrafficPolicyInstancesByHostedZone` request and specifying the
# values of `HostedZoneIdMarker`, `TrafficPolicyInstanceNameMarker`,
# and `TrafficPolicyInstanceTypeMarker` in the corresponding request
# parameters.
# @return [Boolean]
#
# @!attribute [rw] max_items
# The value that you specified for the `MaxItems` parameter in the
# `ListTrafficPolicyInstancesByHostedZone` request that produced the
# current response.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTrafficPolicyInstancesByHostedZoneResponse AWS API Documentation
#
class ListTrafficPolicyInstancesByHostedZoneResponse < Struct.new(
:traffic_policy_instances,
:traffic_policy_instance_name_marker,
:traffic_policy_instance_type_marker,
:is_truncated,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the information about the request to list
# your traffic policy instances.
#
# @note When making an API call, you may pass ListTrafficPolicyInstancesByPolicyRequest
# data as a hash:
#
# {
# traffic_policy_id: "TrafficPolicyId", # required
# traffic_policy_version: 1, # required
# hosted_zone_id_marker: "ResourceId",
# traffic_policy_instance_name_marker: "DNSName",
# traffic_policy_instance_type_marker: "SOA", # accepts SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA, DS
# max_items: 1,
# }
#
# @!attribute [rw] traffic_policy_id
# The ID of the traffic policy for which you want to list traffic
# policy instances.
# @return [String]
#
# @!attribute [rw] traffic_policy_version
# The version of the traffic policy for which you want to list traffic
# policy instances. The version must be associated with the traffic
# policy that is specified by `TrafficPolicyId`.
# @return [Integer]
#
# @!attribute [rw] hosted_zone_id_marker
# If the value of `IsTruncated` in the previous response was `true`,
# you have more traffic policy instances. To get more traffic policy
# instances, submit another `ListTrafficPolicyInstancesByPolicy`
# request.
#
# For the value of `hostedzoneid`, specify the value of
# `HostedZoneIdMarker` from the previous response, which is the hosted
# zone ID of the first traffic policy instance that Amazon Route 53
# will return if you submit another request.
#
# If the value of `IsTruncated` in the previous response was `false`,
# there are no more traffic policy instances to get.
# @return [String]
#
# @!attribute [rw] traffic_policy_instance_name_marker
# If the value of `IsTruncated` in the previous response was `true`,
# you have more traffic policy instances. To get more traffic policy
# instances, submit another `ListTrafficPolicyInstancesByPolicy`
# request.
#
# For the value of `trafficpolicyinstancename`, specify the value of
# `TrafficPolicyInstanceNameMarker` from the previous response, which
# is the name of the first traffic policy instance that Amazon Route
# 53 will return if you submit another request.
#
# If the value of `IsTruncated` in the previous response was `false`,
# there are no more traffic policy instances to get.
# @return [String]
#
# @!attribute [rw] traffic_policy_instance_type_marker
# If the value of `IsTruncated` in the previous response was `true`,
# you have more traffic policy instances. To get more traffic policy
# instances, submit another `ListTrafficPolicyInstancesByPolicy`
# request.
#
# For the value of `trafficpolicyinstancetype`, specify the value of
# `TrafficPolicyInstanceTypeMarker` from the previous response, which
# is the name of the first traffic policy instance that Amazon Route
# 53 will return if you submit another request.
#
# If the value of `IsTruncated` in the previous response was `false`,
# there are no more traffic policy instances to get.
# @return [String]
#
# @!attribute [rw] max_items
# The maximum number of traffic policy instances to be included in the
# response body for this request. If you have more than `MaxItems`
# traffic policy instances, the value of the `IsTruncated` element in
# the response is `true`, and the values of `HostedZoneIdMarker`,
# `TrafficPolicyInstanceNameMarker`, and
# `TrafficPolicyInstanceTypeMarker` represent the first traffic policy
# instance that Amazon Route 53 will return if you submit another
# request.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTrafficPolicyInstancesByPolicyRequest AWS API Documentation
#
class ListTrafficPolicyInstancesByPolicyRequest < Struct.new(
:traffic_policy_id,
:traffic_policy_version,
:hosted_zone_id_marker,
:traffic_policy_instance_name_marker,
:traffic_policy_instance_type_marker,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the request.
#
# @!attribute [rw] traffic_policy_instances
# A list that contains one `TrafficPolicyInstance` element for each
# traffic policy instance that matches the elements in the request.
# @return [Array<Types::TrafficPolicyInstance>]
#
# @!attribute [rw] hosted_zone_id_marker
# If `IsTruncated` is `true`, `HostedZoneIdMarker` is the ID of the
# hosted zone of the first traffic policy instance in the next group
# of traffic policy instances.
# @return [String]
#
# @!attribute [rw] traffic_policy_instance_name_marker
# If `IsTruncated` is `true`, `TrafficPolicyInstanceNameMarker` is the
# name of the first traffic policy instance in the next group of
# `MaxItems` traffic policy instances.
# @return [String]
#
# @!attribute [rw] traffic_policy_instance_type_marker
# If `IsTruncated` is `true`, `TrafficPolicyInstanceTypeMarker` is the
# DNS type of the resource record sets that are associated with the
# first traffic policy instance in the next group of `MaxItems`
# traffic policy instances.
# @return [String]
#
# @!attribute [rw] is_truncated
# A flag that indicates whether there are more traffic policy
# instances to be listed. If the response was truncated, you can get
# the next group of traffic policy instances by calling
# `ListTrafficPolicyInstancesByPolicy` again and specifying the values
# of the `HostedZoneIdMarker`, `TrafficPolicyInstanceNameMarker`, and
# `TrafficPolicyInstanceTypeMarker` elements in the corresponding
# request parameters.
# @return [Boolean]
#
# @!attribute [rw] max_items
# The value that you specified for the `MaxItems` parameter in the
# call to `ListTrafficPolicyInstancesByPolicy` that produced the
# current response.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTrafficPolicyInstancesByPolicyResponse AWS API Documentation
#
class ListTrafficPolicyInstancesByPolicyResponse < Struct.new(
:traffic_policy_instances,
:hosted_zone_id_marker,
:traffic_policy_instance_name_marker,
:traffic_policy_instance_type_marker,
:is_truncated,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A request to get information about the traffic policy instances that
# you created by using the current Amazon Web Services account.
#
# @note When making an API call, you may pass ListTrafficPolicyInstancesRequest
# data as a hash:
#
# {
# hosted_zone_id_marker: "ResourceId",
# traffic_policy_instance_name_marker: "DNSName",
# traffic_policy_instance_type_marker: "SOA", # accepts SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA, DS
# max_items: 1,
# }
#
# @!attribute [rw] hosted_zone_id_marker
# If the value of `IsTruncated` in the previous response was `true`,
# you have more traffic policy instances. To get more traffic policy
# instances, submit another `ListTrafficPolicyInstances` request. For
# the value of `HostedZoneId`, specify the value of
# `HostedZoneIdMarker` from the previous response, which is the hosted
# zone ID of the first traffic policy instance in the next group of
# traffic policy instances.
#
# If the value of `IsTruncated` in the previous response was `false`,
# there are no more traffic policy instances to get.
# @return [String]
#
# @!attribute [rw] traffic_policy_instance_name_marker
# If the value of `IsTruncated` in the previous response was `true`,
# you have more traffic policy instances. To get more traffic policy
# instances, submit another `ListTrafficPolicyInstances` request. For
# the value of `trafficpolicyinstancename`, specify the value of
# `TrafficPolicyInstanceNameMarker` from the previous response, which
# is the name of the first traffic policy instance in the next group
# of traffic policy instances.
#
# If the value of `IsTruncated` in the previous response was `false`,
# there are no more traffic policy instances to get.
# @return [String]
#
# @!attribute [rw] traffic_policy_instance_type_marker
# If the value of `IsTruncated` in the previous response was `true`,
# you have more traffic policy instances. To get more traffic policy
# instances, submit another `ListTrafficPolicyInstances` request. For
# the value of `trafficpolicyinstancetype`, specify the value of
# `TrafficPolicyInstanceTypeMarker` from the previous response, which
# is the type of the first traffic policy instance in the next group
# of traffic policy instances.
#
# If the value of `IsTruncated` in the previous response was `false`,
# there are no more traffic policy instances to get.
# @return [String]
#
# @!attribute [rw] max_items
# The maximum number of traffic policy instances that you want Amazon
# Route 53 to return in response to a `ListTrafficPolicyInstances`
# request. If you have more than `MaxItems` traffic policy instances,
# the value of the `IsTruncated` element in the response is `true`,
# and the values of `HostedZoneIdMarker`,
# `TrafficPolicyInstanceNameMarker`, and
# `TrafficPolicyInstanceTypeMarker` represent the first traffic policy
# instance in the next group of `MaxItems` traffic policy instances.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTrafficPolicyInstancesRequest AWS API Documentation
#
class ListTrafficPolicyInstancesRequest < Struct.new(
:hosted_zone_id_marker,
:traffic_policy_instance_name_marker,
:traffic_policy_instance_type_marker,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the request.
#
# @!attribute [rw] traffic_policy_instances
# A list that contains one `TrafficPolicyInstance` element for each
# traffic policy instance that matches the elements in the request.
# @return [Array<Types::TrafficPolicyInstance>]
#
# @!attribute [rw] hosted_zone_id_marker
# If `IsTruncated` is `true`, `HostedZoneIdMarker` is the ID of the
# hosted zone of the first traffic policy instance that Route 53 will
# return if you submit another `ListTrafficPolicyInstances` request.
# @return [String]
#
# @!attribute [rw] traffic_policy_instance_name_marker
# If `IsTruncated` is `true`, `TrafficPolicyInstanceNameMarker` is the
# name of the first traffic policy instance that Route 53 will return
# if you submit another `ListTrafficPolicyInstances` request.
# @return [String]
#
# @!attribute [rw] traffic_policy_instance_type_marker
# If `IsTruncated` is `true`, `TrafficPolicyInstanceTypeMarker` is the
# DNS type of the resource record sets that are associated with the
# first traffic policy instance that Amazon Route 53 will return if
# you submit another `ListTrafficPolicyInstances` request.
# @return [String]
#
# @!attribute [rw] is_truncated
# A flag that indicates whether there are more traffic policy
# instances to be listed. If the response was truncated, you can get
# more traffic policy instances by calling
# `ListTrafficPolicyInstances` again and specifying the values of the
# `HostedZoneIdMarker`, `TrafficPolicyInstanceNameMarker`, and
# `TrafficPolicyInstanceTypeMarker` in the corresponding request
# parameters.
# @return [Boolean]
#
# @!attribute [rw] max_items
# The value that you specified for the `MaxItems` parameter in the
# call to `ListTrafficPolicyInstances` that produced the current
# response.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTrafficPolicyInstancesResponse AWS API Documentation
#
class ListTrafficPolicyInstancesResponse < Struct.new(
:traffic_policy_instances,
:hosted_zone_id_marker,
:traffic_policy_instance_name_marker,
:traffic_policy_instance_type_marker,
:is_truncated,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the information about the request to list
# your traffic policies.
#
# @note When making an API call, you may pass ListTrafficPolicyVersionsRequest
# data as a hash:
#
# {
# id: "TrafficPolicyId", # required
# traffic_policy_version_marker: "TrafficPolicyVersionMarker",
# max_items: 1,
# }
#
# @!attribute [rw] id
# Specify the value of `Id` of the traffic policy for which you want
# to list all versions.
# @return [String]
#
# @!attribute [rw] traffic_policy_version_marker
# For your first request to `ListTrafficPolicyVersions`, don't
# include the `TrafficPolicyVersionMarker` parameter.
#
# If you have more traffic policy versions than the value of
# `MaxItems`, `ListTrafficPolicyVersions` returns only the first group
# of `MaxItems` versions. To get more traffic policy versions, submit
# another `ListTrafficPolicyVersions` request. For the value of
# `TrafficPolicyVersionMarker`, specify the value of
# `TrafficPolicyVersionMarker` in the previous response.
# @return [String]
#
# @!attribute [rw] max_items
# The maximum number of traffic policy versions that you want Amazon
# Route 53 to include in the response body for this request. If the
# specified traffic policy has more than `MaxItems` versions, the
# value of `IsTruncated` in the response is `true`, and the value of
# the `TrafficPolicyVersionMarker` element is the ID of the first
# version that Route 53 will return if you submit another request.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTrafficPolicyVersionsRequest AWS API Documentation
#
class ListTrafficPolicyVersionsRequest < Struct.new(
:id,
:traffic_policy_version_marker,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the request.
#
# @!attribute [rw] traffic_policies
# A list that contains one `TrafficPolicy` element for each traffic
# policy version that is associated with the specified traffic policy.
# @return [Array<Types::TrafficPolicy>]
#
# @!attribute [rw] is_truncated
# A flag that indicates whether there are more traffic policies to be
# listed. If the response was truncated, you can get the next group of
# traffic policies by submitting another `ListTrafficPolicyVersions`
# request and specifying the value of `NextMarker` in the `marker`
# parameter.
# @return [Boolean]
#
# @!attribute [rw] traffic_policy_version_marker
# If `IsTruncated` is `true`, the value of
# `TrafficPolicyVersionMarker` identifies the first traffic policy
# that Amazon Route 53 will return if you submit another request. Call
# `ListTrafficPolicyVersions` again and specify the value of
# `TrafficPolicyVersionMarker` in the `TrafficPolicyVersionMarker`
# request parameter.
#
# This element is present only if `IsTruncated` is `true`.
# @return [String]
#
# @!attribute [rw] max_items
# The value that you specified for the `maxitems` parameter in the
# `ListTrafficPolicyVersions` request that produced the current
# response.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListTrafficPolicyVersionsResponse AWS API Documentation
#
class ListTrafficPolicyVersionsResponse < Struct.new(
:traffic_policies,
:is_truncated,
:traffic_policy_version_marker,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about that can be associated
# with your hosted zone.
#
# @note When making an API call, you may pass ListVPCAssociationAuthorizationsRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# next_token: "PaginationToken",
# max_results: "MaxResults",
# }
#
# @!attribute [rw] hosted_zone_id
# The ID of the hosted zone for which you want a list of VPCs that can
# be associated with the hosted zone.
# @return [String]
#
# @!attribute [rw] next_token
# *Optional*\: If a response includes a `NextToken` element, there are
# more VPCs that can be associated with the specified hosted zone. To
# get the next page of results, submit another request, and include
# the value of `NextToken` from the response in the `nexttoken`
# parameter in another `ListVPCAssociationAuthorizations` request.
# @return [String]
#
# @!attribute [rw] max_results
# *Optional*\: An integer that specifies the maximum number of VPCs
# that you want Amazon Route 53 to return. If you don't specify a
# value for `MaxResults`, Route 53 returns up to 50 VPCs per page.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListVPCAssociationAuthorizationsRequest AWS API Documentation
#
class ListVPCAssociationAuthorizationsRequest < Struct.new(
:hosted_zone_id,
:next_token,
:max_results)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the request.
#
# @!attribute [rw] hosted_zone_id
# The ID of the hosted zone that you can associate the listed VPCs
# with.
# @return [String]
#
# @!attribute [rw] next_token
# When the response includes a `NextToken` element, there are more
# VPCs that can be associated with the specified hosted zone. To get
# the next page of VPCs, submit another
# `ListVPCAssociationAuthorizations` request, and include the value of
# the `NextToken` element from the response in the `nexttoken` request
# parameter.
# @return [String]
#
# @!attribute [rw] vp_cs
# The list of VPCs that are authorized to be associated with the
# specified hosted zone.
# @return [Array<Types::VPC>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ListVPCAssociationAuthorizationsResponse AWS API Documentation
#
class ListVPCAssociationAuthorizationsResponse < Struct.new(
:hosted_zone_id,
:next_token,
:vp_cs)
SENSITIVE = []
include Aws::Structure
end
# A change with the specified change ID does not exist.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/NoSuchChange AWS API Documentation
#
class NoSuchChange < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# There is no CloudWatch Logs log group with the specified ARN.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/NoSuchCloudWatchLogsLogGroup AWS API Documentation
#
class NoSuchCloudWatchLogsLogGroup < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A reusable delegation set with the specified ID does not exist.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/NoSuchDelegationSet AWS API Documentation
#
class NoSuchDelegationSet < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# Amazon Route 53 doesn't support the specified geographic location.
# For a list of supported geolocation codes, see the [GeoLocation][1]
# data type.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GeoLocation.html
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/NoSuchGeoLocation AWS API Documentation
#
class NoSuchGeoLocation < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# No health check exists with the specified ID.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/NoSuchHealthCheck AWS API Documentation
#
class NoSuchHealthCheck < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# No hosted zone exists with the ID that you specified.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/NoSuchHostedZone AWS API Documentation
#
class NoSuchHostedZone < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The specified key-signing key (KSK) doesn't exist.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/NoSuchKeySigningKey AWS API Documentation
#
class NoSuchKeySigningKey < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# There is no DNS query logging configuration with the specified ID.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/NoSuchQueryLoggingConfig AWS API Documentation
#
class NoSuchQueryLoggingConfig < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# No traffic policy exists with the specified ID.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/NoSuchTrafficPolicy AWS API Documentation
#
class NoSuchTrafficPolicy < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# No traffic policy instance exists with the specified ID.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/NoSuchTrafficPolicyInstance AWS API Documentation
#
class NoSuchTrafficPolicyInstance < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# Associating the specified VPC with the specified hosted zone has not
# been authorized.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/NotAuthorizedException AWS API Documentation
#
class NotAuthorizedException < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# If Amazon Route 53 can't process a request before the next request
# arrives, it will reject subsequent requests for the same hosted zone
# and return an `HTTP 400 error` (`Bad request`). If Route 53 returns
# this error repeatedly for the same request, we recommend that you
# wait, in intervals of increasing duration, before you try the request
# again.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/PriorRequestNotComplete AWS API Documentation
#
class PriorRequestNotComplete < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# You're trying to associate a VPC with a public hosted zone. Amazon
# Route 53 doesn't support associating a VPC with a public hosted zone.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/PublicZoneVPCAssociation AWS API Documentation
#
class PublicZoneVPCAssociation < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about a configuration for DNS
# query logging.
#
# @!attribute [rw] id
# The ID for a configuration for DNS query logging.
# @return [String]
#
# @!attribute [rw] hosted_zone_id
# The ID of the hosted zone that CloudWatch Logs is logging queries
# for.
# @return [String]
#
# @!attribute [rw] cloud_watch_logs_log_group_arn
# The Amazon Resource Name (ARN) of the CloudWatch Logs log group that
# Amazon Route 53 is publishing logs to.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/QueryLoggingConfig AWS API Documentation
#
class QueryLoggingConfig < Struct.new(
:id,
:hosted_zone_id,
:cloud_watch_logs_log_group_arn)
SENSITIVE = []
include Aws::Structure
end
# You can create only one query logging configuration for a hosted zone,
# and a query logging configuration already exists for this hosted zone.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/QueryLoggingConfigAlreadyExists AWS API Documentation
#
class QueryLoggingConfigAlreadyExists < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# Information specific to the resource record.
#
# <note markdown="1"> If you're creating an alias resource record set, omit
# `ResourceRecord`.
#
# </note>
#
# @note When making an API call, you may pass ResourceRecord
# data as a hash:
#
# {
# value: "RData", # required
# }
#
# @!attribute [rw] value
# The current or new DNS record value, not to exceed 4,000 characters.
# In the case of a `DELETE` action, if the current value does not
# match the actual value, an error is returned. For descriptions about
# how to format `Value` for different record types, see [Supported DNS
# Resource Record Types][1] in the *Amazon Route 53 Developer Guide*.
#
# You can specify more than one value for all record types except
# `CNAME` and `SOA`.
#
# <note markdown="1"> If you're creating an alias resource record set, omit `Value`.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ResourceRecord AWS API Documentation
#
class ResourceRecord < Struct.new(
:value)
SENSITIVE = []
include Aws::Structure
end
# Information about the resource record set to create or delete.
#
# @note When making an API call, you may pass ResourceRecordSet
# data as a hash:
#
# {
# name: "DNSName", # required
# type: "SOA", # required, accepts SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA, DS
# set_identifier: "ResourceRecordSetIdentifier",
# weight: 1,
# region: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, cn-north-1, cn-northwest-1, ap-east-1, me-south-1, ap-south-1, af-south-1, eu-south-1
# geo_location: {
# continent_code: "GeoLocationContinentCode",
# country_code: "GeoLocationCountryCode",
# subdivision_code: "GeoLocationSubdivisionCode",
# },
# failover: "PRIMARY", # accepts PRIMARY, SECONDARY
# multi_value_answer: false,
# ttl: 1,
# resource_records: [
# {
# value: "RData", # required
# },
# ],
# alias_target: {
# hosted_zone_id: "ResourceId", # required
# dns_name: "DNSName", # required
# evaluate_target_health: false, # required
# },
# health_check_id: "HealthCheckId",
# traffic_policy_instance_id: "TrafficPolicyInstanceId",
# }
#
# @!attribute [rw] name
# For `ChangeResourceRecordSets` requests, the name of the record that
# you want to create, update, or delete. For `ListResourceRecordSets`
# responses, the name of a record in the specified hosted zone.
#
# **ChangeResourceRecordSets Only**
#
# Enter a fully qualified domain name, for example, `www.example.com`.
# You can optionally include a trailing dot. If you omit the trailing
# dot, Amazon Route 53 assumes that the domain name that you specify
# is fully qualified. This means that Route 53 treats
# `www.example.com` (without a trailing dot) and `www.example.com.`
# (with a trailing dot) as identical.
#
# For information about how to specify characters other than `a-z`,
# `0-9`, and `-` (hyphen) and how to specify internationalized domain
# names, see [DNS Domain Name Format][1] in the *Amazon Route 53
# Developer Guide*.
#
# You can use the asterisk (*) wildcard to replace the leftmost label
# in a domain name, for example, `*.example.com`. Note the following:
#
# * The * must replace the entire label. For example, you can't
# specify `*prod.example.com` or `prod*.example.com`.
#
# * The * can't replace any of the middle labels, for example,
# marketing.*.example.com.
#
# * If you include * in any position other than the leftmost label in
# a domain name, DNS treats it as an * character (ASCII 42), not as
# a wildcard.
#
# You can't use the * wildcard for resource records sets that have
# a type of NS.
#
# You can use the * wildcard as the leftmost label in a domain name,
# for example, `*.example.com`. You can't use an * for one of the
# middle labels, for example, `marketing.*.example.com`. In addition,
# the * must replace the entire label; for example, you can't
# specify `prod*.example.com`.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html
# @return [String]
#
# @!attribute [rw] type
# The DNS record type. For information about different record types
# and how data is encoded for them, see [Supported DNS Resource Record
# Types][1] in the *Amazon Route 53 Developer Guide*.
#
# Valid values for basic resource record sets: `A` \| `AAAA` \| `CAA`
# \| `CNAME` \| `DS` \|`MX` \| `NAPTR` \| `NS` \| `PTR` \| `SOA` \|
# `SPF` \| `SRV` \| `TXT`
#
# Values for weighted, latency, geolocation, and failover resource
# record sets: `A` \| `AAAA` \| `CAA` \| `CNAME` \| `MX` \| `NAPTR` \|
# `PTR` \| `SPF` \| `SRV` \| `TXT`. When creating a group of weighted,
# latency, geolocation, or failover resource record sets, specify the
# same value for all of the resource record sets in the group.
#
# Valid values for multivalue answer resource record sets: `A` \|
# `AAAA` \| `MX` \| `NAPTR` \| `PTR` \| `SPF` \| `SRV` \| `TXT`
#
# <note markdown="1"> SPF records were formerly used to verify the identity of the sender
# of email messages. However, we no longer recommend that you create
# resource record sets for which the value of `Type` is `SPF`. RFC
# 7208, *Sender Policy Framework (SPF) for Authorizing Use of Domains
# in Email, Version 1*, has been updated to say, "...\[I\]ts
# existence and mechanism defined in \[RFC4408\] have led to some
# interoperability issues. Accordingly, its use is no longer
# appropriate for SPF version 1; implementations are not to use it."
# In RFC 7208, see section 14.1, [The SPF DNS Record Type][2].
#
# </note>
#
# Values for alias resource record sets:
#
# * **Amazon API Gateway custom regional APIs and edge-optimized
# APIs:** `A`
#
# * **CloudFront distributions:** `A`
#
# If IPv6 is enabled for the distribution, create two resource
# record sets to route traffic to your distribution, one with a
# value of `A` and one with a value of `AAAA`.
#
# * **Amazon API Gateway environment that has a regionalized
# subdomain**\: `A`
#
# * **ELB load balancers:** `A` \| `AAAA`
#
# * **Amazon S3 buckets:** `A`
#
# * **Amazon Virtual Private Cloud interface VPC endpoints** `A`
#
# * **Another resource record set in this hosted zone:** Specify the
# type of the resource record set that you're creating the alias
# for. All values are supported except `NS` and `SOA`.
#
# <note markdown="1"> If you're creating an alias record that has the same name as the
# hosted zone (known as the zone apex), you can't route traffic to
# a record for which the value of `Type` is `CNAME`. This is because
# the alias record must have the same type as the record you're
# routing traffic to, and creating a CNAME record for the zone apex
# isn't supported even for an alias record.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html
# [2]: http://tools.ietf.org/html/rfc7208#section-14.1
# @return [String]
#
# @!attribute [rw] set_identifier
# *Resource record sets that have a routing policy other than simple:*
# An identifier that differentiates among multiple resource record
# sets that have the same combination of name and type, such as
# multiple weighted resource record sets named acme.example.com that
# have a type of A. In a group of resource record sets that have the
# same name and type, the value of `SetIdentifier` must be unique for
# each resource record set.
#
# For information about routing policies, see [Choosing a Routing
# Policy][1] in the *Amazon Route 53 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html
# @return [String]
#
# @!attribute [rw] weight
# *Weighted resource record sets only:* 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. Note the following:
#
# * You must specify a value for the `Weight` element for every
# weighted resource record set.
#
# * You can only specify one `ResourceRecord` per weighted resource
# record set.
#
# * You can't create latency, failover, or geolocation resource
# record sets that have the same values for the `Name` and `Type`
# elements as weighted resource record sets.
#
# * You can create a maximum of 100 weighted resource record sets that
# have the same values for the `Name` and `Type` elements.
#
# * For weighted (but not weighted alias) resource record sets, if you
# set `Weight` to `0` for a resource record set, Route 53 never
# responds to queries with the applicable value for that resource
# record set. However, if you set `Weight` to `0` for all resource
# record sets that have the same combination of DNS name and type,
# traffic is routed to all resources with equal probability.
#
# The effect of setting `Weight` to `0` is different when you
# associate health checks with weighted resource record sets. For
# more information, see [Options for Configuring Route 53
# Active-Active and Active-Passive Failover][1] in the *Amazon Route
# 53 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html
# @return [Integer]
#
# @!attribute [rw] region
# *Latency-based resource record sets only:* The Amazon EC2 Region
# where you created the resource that this resource record set refers
# to. The resource typically is an Amazon Web Services 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.
#
# <note markdown="1"> Although creating latency and latency alias resource record sets in
# a private hosted zone is allowed, it's not supported.
#
# </note>
#
# 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.
#
# Note the following:
#
# * You can only specify one `ResourceRecord` per latency resource
# record set.
#
# * You can only create one latency resource record set for each
# Amazon EC2 Region.
#
# * You aren't required to create latency resource record sets for
# all Amazon EC2 Regions. Route 53 will choose the region with the
# best latency from among the regions that you create latency
# resource record sets for.
#
# * You can't create non-latency resource record sets that have the
# same values for the `Name` and `Type` elements as latency resource
# record sets.
# @return [String]
#
# @!attribute [rw] geo_location
# *Geolocation resource record sets only:* A complex type that lets
# you control how Amazon Route 53 responds to DNS queries based on the
# geographic origin of the query. For example, if you want all queries
# from Africa to be routed to a web server with an IP address of
# `192.0.2.111`, create a resource record set with a `Type` of `A` and
# a `ContinentCode` of `AF`.
#
# <note markdown="1"> Although creating geolocation and geolocation alias resource record
# sets in a private hosted zone is allowed, it's not supported.
#
# </note>
#
# If you create separate resource record sets for overlapping
# geographic regions (for example, one resource record set for a
# continent and one for a country on the same continent), priority
# goes to the smallest geographic region. This allows you to route
# most queries for a continent to one resource and to route queries
# for a country on that continent to a different resource.
#
# You can't create two geolocation resource record sets that specify
# the same geographic location.
#
# The value `*` in the `CountryCode` element matches all geographic
# locations that aren't specified in other geolocation resource
# record sets that have the same values for the `Name` and `Type`
# elements.
#
# Geolocation works by mapping IP addresses to locations. However,
# some IP addresses aren't mapped to geographic locations, so even if
# you create geolocation resource record sets that cover all seven
# continents, Route 53 will receive some DNS queries from locations
# that it can't identify. We recommend that you create a resource
# record set for which the value of `CountryCode` is `*`. Two groups
# of queries are routed to the resource that you specify in this
# record: queries that come from locations for which you haven't
# created geolocation resource record sets and queries from IP
# addresses that aren't mapped to a location. If you don't create a
# `*` resource record set, Route 53 returns a "no answer" response
# for queries from those locations.
#
# You can't create non-geolocation resource record sets that have the
# same values for the `Name` and `Type` elements as geolocation
# resource record sets.
# @return [Types::GeoLocation]
#
# @!attribute [rw] failover
# *Failover resource record sets only:* To configure failover, you add
# the `Failover` element to two resource record sets. For one resource
# record set, you specify `PRIMARY` as the value for `Failover`; for
# the other resource record set, you specify `SECONDARY`. In addition,
# you include the `HealthCheckId` element and specify the health check
# that you want Amazon Route 53 to perform for each resource record
# set.
#
# Except where noted, the following failover behaviors assume that you
# have included the `HealthCheckId` element in both resource record
# sets:
#
# * When the primary resource record set is healthy, Route 53 responds
# to DNS queries with the applicable value from the primary resource
# record set regardless of the health of the secondary resource
# record set.
#
# * When the primary resource record set is unhealthy and the
# secondary resource record set is healthy, Route 53 responds to DNS
# queries with the applicable value from the secondary resource
# record set.
#
# * When the secondary resource record set is unhealthy, Route 53
# responds to DNS queries with the applicable value from the primary
# resource record set regardless of the health of the primary
# resource record set.
#
# * If you omit the `HealthCheckId` element for the secondary resource
# record set, and if the primary resource record set is unhealthy,
# Route 53 always responds to DNS queries with the applicable value
# from the secondary resource record set. This is true regardless of
# the health of the associated endpoint.
#
# You can't create non-failover resource record sets that have the
# same values for the `Name` and `Type` elements as failover resource
# record sets.
#
# For failover alias resource record sets, you must also include the
# `EvaluateTargetHealth` element and set the value to true.
#
# For more information about configuring failover for Route 53, see
# the following topics in the *Amazon Route 53 Developer Guide*\:
#
# * [Route 53 Health Checks and DNS Failover][1]
#
# * [Configuring Failover in a Private Hosted Zone][2]
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html
# [2]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html
# @return [String]
#
# @!attribute [rw] multi_value_answer
# *Multivalue answer resource record sets only*\: To route traffic
# approximately randomly to multiple resources, such as web servers,
# create one multivalue answer record for each resource and specify
# `true` for `MultiValueAnswer`. Note the following:
#
# * If you associate a health check with a multivalue answer resource
# record set, Amazon Route 53 responds to DNS queries with the
# corresponding IP address only when the health check is healthy.
#
# * If you don't associate a health check with a multivalue answer
# record, Route 53 always considers the record to be healthy.
#
# * Route 53 responds to DNS queries with up to eight healthy records;
# if you have eight or fewer healthy records, Route 53 responds to
# all DNS queries with all the healthy records.
#
# * If you have more than eight healthy records, Route 53 responds to
# different DNS resolvers with different combinations of healthy
# records.
#
# * When all records are unhealthy, Route 53 responds to DNS queries
# with up to eight unhealthy records.
#
# * If a resource becomes unavailable after a resolver caches a
# response, client software typically tries another of the IP
# addresses in the response.
#
# You can't create multivalue answer alias records.
# @return [Boolean]
#
# @!attribute [rw] ttl
# The resource record cache time to live (TTL), in seconds. Note the
# following:
#
# * If you're creating or updating an alias resource record set, omit
# `TTL`. Amazon Route 53 uses the value of `TTL` for the alias
# target.
#
# * If you're associating this resource record set with a health
# check (if you're adding a `HealthCheckId` element), we recommend
# that you specify a `TTL` of 60 seconds or less so clients respond
# quickly to changes in health status.
#
# * All of the resource record sets in a group of weighted resource
# record sets must have the same value for `TTL`.
#
# * If a group of weighted resource record sets includes one or more
# weighted alias resource record sets for which the alias target is
# an ELB load balancer, we recommend that you specify a `TTL` of 60
# seconds for all of the non-alias weighted resource record sets
# that have the same name and type. Values other than 60 seconds
# (the TTL for load balancers) will change the effect of the values
# that you specify for `Weight`.
# @return [Integer]
#
# @!attribute [rw] resource_records
# Information about the resource records to act upon.
#
# <note markdown="1"> If you're creating an alias resource record set, omit
# `ResourceRecords`.
#
# </note>
# @return [Array<Types::ResourceRecord>]
#
# @!attribute [rw] alias_target
# *Alias resource record sets only:* Information about the Amazon Web
# Services resource, such as a CloudFront distribution or an Amazon S3
# bucket, that you want to route traffic to.
#
# If you're creating resource records sets for a private hosted zone,
# note the following:
#
# * You can't create an alias resource record set in a private hosted
# zone to route traffic to a CloudFront distribution.
#
# * Creating geolocation alias resource record sets or latency alias
# resource record sets in a private hosted zone is unsupported.
#
# * For information about creating failover resource record sets in a
# private hosted zone, see [Configuring Failover in a Private Hosted
# Zone][1] in the *Amazon Route 53 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html
# @return [Types::AliasTarget]
#
# @!attribute [rw] health_check_id
# If you want Amazon Route 53 to return this resource record set in
# response to a DNS query only when the status of a health check is
# healthy, include the `HealthCheckId` element and specify the ID of
# the applicable health check.
#
# Route 53 determines whether a resource record set is healthy based
# on one of the following:
#
# * By periodically sending a request to the endpoint that is
# specified in the health check
#
# * By aggregating the status of a specified group of health checks
# (calculated health checks)
#
# * By determining the current state of a CloudWatch alarm (CloudWatch
# metric health checks)
#
# Route 53 doesn't check the health of the endpoint that is specified
# in the resource record set, for example, the endpoint specified by
# the IP address in the `Value` element. When you add a
# `HealthCheckId` element to a resource record set, Route 53 checks
# the health of the endpoint that you specified in the health check.
#
# For more information, see the following topics in the *Amazon Route
# 53 Developer Guide*\:
#
# * [How Amazon Route 53 Determines Whether an Endpoint Is Healthy][1]
#
# * [Route 53 Health Checks and DNS Failover][2]
#
# * [Configuring Failover in a Private Hosted Zone][3]
#
# **When to Specify HealthCheckId**
#
# Specifying a value for `HealthCheckId` is useful only when Route 53
# is choosing between two or more resource record sets to respond to a
# DNS query, and you want Route 53 to base the choice in part on the
# status of a health check. Configuring health checks makes sense only
# in the following configurations:
#
# * **Non-alias resource record sets**\: You're checking the health
# of a group of non-alias resource record sets that have the same
# routing policy, name, and type (such as multiple weighted records
# named www.example.com with a type of A) and you specify health
# check IDs for all the resource record sets.
#
# If the health check status for a resource record set is healthy,
# Route 53 includes the record among the records that it responds to
# DNS queries with.
#
# If the health check status for a resource record set is unhealthy,
# Route 53 stops responding to DNS queries using the value for that
# resource record set.
#
# If the health check status for all resource record sets in the
# group is unhealthy, Route 53 considers all resource record sets in
# the group healthy and responds to DNS queries accordingly.
#
# * **Alias resource record sets**\: You specify the following
# settings:
#
# * You set `EvaluateTargetHealth` to true for an alias resource
# record set in a group of resource record sets that have the same
# routing policy, name, and type (such as multiple weighted
# records named www.example.com with a type of A).
#
# * You configure the alias resource record set to route traffic to
# a non-alias resource record set in the same hosted zone.
#
# * You specify a health check ID for the non-alias resource record
# set.
#
# If the health check status is healthy, Route 53 considers the
# alias resource record set to be healthy and includes the alias
# record among the records that it responds to DNS queries with.
#
# If the health check status is unhealthy, Route 53 stops responding
# to DNS queries using the alias resource record set.
#
# <note markdown="1"> The alias resource record set can also route traffic to a *group*
# of non-alias resource record sets that have the same routing
# policy, name, and type. In that configuration, associate health
# checks with all of the resource record sets in the group of
# non-alias resource record sets.
#
# </note>
#
# **Geolocation Routing**
#
# For geolocation resource record sets, if an endpoint is unhealthy,
# Route 53 looks for a resource record set for the larger, associated
# geographic region. For example, suppose you have resource record
# sets for a state in the United States, for the entire United States,
# for North America, and a resource record set that has `*` for
# `CountryCode` is `*`, which applies to all locations. If the
# endpoint for the state resource record set is unhealthy, Route 53
# checks for healthy resource record sets in the following order until
# it finds a resource record set for which the endpoint is healthy:
#
# * The United States
#
# * North America
#
# * The default resource record set
#
# **Specifying the Health Check Endpoint by Domain Name**
#
# If your health checks specify the endpoint only by domain name, we
# recommend that you create a separate health check for each endpoint.
# For example, create a health check for each `HTTP` server that is
# serving content for `www.example.com`. For the value of
# `FullyQualifiedDomainName`, specify the domain name of the server
# (such as `us-east-2-www.example.com`), not the name of the resource
# record sets (`www.example.com`).
#
# Health check results will be unpredictable if you do the following:
#
# * Create a health check that has the same value for
# `FullyQualifiedDomainName` as the name of a resource record set.
#
# * Associate that health check with the resource record set.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html
# [2]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html
# [3]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html
# @return [String]
#
# @!attribute [rw] traffic_policy_instance_id
# When you create a traffic policy instance, Amazon Route 53
# automatically creates a resource record set.
# `TrafficPolicyInstanceId` is the ID of the traffic policy instance
# that Route 53 created this resource record set for.
#
# To delete the resource record set that is associated with a traffic
# policy instance, use `DeleteTrafficPolicyInstance`. Route 53 will
# delete the resource record set automatically. If you delete the
# resource record set by using `ChangeResourceRecordSets`, Route 53
# doesn't automatically delete the traffic policy instance, and
# you'll continue to be charged for it even though it's no longer in
# use.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ResourceRecordSet AWS API Documentation
#
class ResourceRecordSet < Struct.new(
:name,
:type,
:set_identifier,
:weight,
:region,
:geo_location,
:failover,
:multi_value_answer,
:ttl,
:resource_records,
:alias_target,
:health_check_id,
:traffic_policy_instance_id)
SENSITIVE = []
include Aws::Structure
end
# A complex type containing a resource and its associated tags.
#
# @!attribute [rw] resource_type
# The type of the resource.
#
# * The resource type for health checks is `healthcheck`.
#
# * The resource type for hosted zones is `hostedzone`.
# @return [String]
#
# @!attribute [rw] resource_id
# The ID for the specified resource.
# @return [String]
#
# @!attribute [rw] tags
# The tags associated with the specified resource.
# @return [Array<Types::Tag>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ResourceTagSet AWS API Documentation
#
class ResourceTagSet < Struct.new(
:resource_type,
:resource_id,
:tags)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the type of limit that you specified in
# the request and the current value for that limit.
#
# @!attribute [rw] type
# The limit that you requested:
# `MAX_ZONES_BY_REUSABLE_DELEGATION_SET`, the maximum number of hosted
# zones that you can associate with the specified reusable delegation
# set.
# @return [String]
#
# @!attribute [rw] value
# The current value for the `MAX_ZONES_BY_REUSABLE_DELEGATION_SET`
# limit.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ReusableDelegationSetLimit AWS API Documentation
#
class ReusableDelegationSetLimit < Struct.new(
:type,
:value)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the status that one Amazon Route 53
# health checker reports and the time of the health check.
#
# @!attribute [rw] status
# A description of the status of the health check endpoint as reported
# by one of the Amazon Route 53 health checkers.
# @return [String]
#
# @!attribute [rw] checked_time
# The date and time that the health checker performed the health check
# in [ISO 8601 format][1] and Coordinated Universal Time (UTC). For
# example, the value `2017-03-27T17:48:16.751Z` represents March 27,
# 2017 at 17:48:16.751 UTC.
#
#
#
# [1]: https://en.wikipedia.org/wiki/ISO_8601
# @return [Time]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/StatusReport AWS API Documentation
#
class StatusReport < Struct.new(
:status,
:checked_time)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about a tag that you want to
# add or edit for the specified health check or hosted zone.
#
# @note When making an API call, you may pass Tag
# data as a hash:
#
# {
# key: "TagKey",
# value: "TagValue",
# }
#
# @!attribute [rw] key
# The value of `Key` depends on the operation that you want to
# perform:
#
# * **Add a tag to a health check or hosted zone**\: `Key` is the name
# that you want to give the new tag.
#
# * **Edit a tag**\: `Key` is the name of the tag that you want to
# change the `Value` for.
#
# * <b> Delete a key</b>\: `Key` is the name of the tag you want to
# remove.
#
# * **Give a name to a health check**\: Edit the default `Name` tag.
# In the Amazon Route 53 console, the list of your health checks
# includes a **Name** column that lets you see the name that you've
# given to each health check.
# @return [String]
#
# @!attribute [rw] value
# The value of `Value` depends on the operation that you want to
# perform:
#
# * **Add a tag to a health check or hosted zone**\: `Value` is the
# value that you want to give the new tag.
#
# * **Edit a tag**\: `Value` is the new value that you want to assign
# the tag.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/Tag AWS API Documentation
#
class Tag < Struct.new(
:key,
:value)
SENSITIVE = []
include Aws::Structure
end
# Gets the value that Amazon Route 53 returns in response to a DNS
# request for a specified record name and type. You can optionally
# specify the IP address of a DNS resolver, an EDNS0 client subnet IP
# address, and a subnet mask.
#
# @note When making an API call, you may pass TestDNSAnswerRequest
# data as a hash:
#
# {
# hosted_zone_id: "ResourceId", # required
# record_name: "DNSName", # required
# record_type: "SOA", # required, accepts SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA, DS
# resolver_ip: "IPAddress",
# edns0_client_subnet_ip: "IPAddress",
# edns0_client_subnet_mask: "SubnetMask",
# }
#
# @!attribute [rw] hosted_zone_id
# The ID of the hosted zone that you want Amazon Route 53 to simulate
# a query for.
# @return [String]
#
# @!attribute [rw] record_name
# The name of the resource record set that you want Amazon Route 53 to
# simulate a query for.
# @return [String]
#
# @!attribute [rw] record_type
# The type of the resource record set.
# @return [String]
#
# @!attribute [rw] resolver_ip
# If you want to simulate a request from a specific DNS resolver,
# specify the IP address for that resolver. If you omit this value,
# `TestDnsAnswer` uses the IP address of a DNS resolver in the Amazon
# Web Services US East (N. Virginia) Region (`us-east-1`).
# @return [String]
#
# @!attribute [rw] edns0_client_subnet_ip
# If the resolver that you specified for resolverip supports EDNS0,
# specify the IPv4 or IPv6 address of a client in the applicable
# location, for example, `192.0.2.44` or
# `2001:db8:85a3::8a2e:370:7334`.
# @return [String]
#
# @!attribute [rw] edns0_client_subnet_mask
# If you specify an IP address for `edns0clientsubnetip`, you can
# optionally specify the number of bits of the IP address that you
# want the checking tool to include in the DNS query. For example, if
# you specify `192.0.2.44` for `edns0clientsubnetip` and `24` for
# `edns0clientsubnetmask`, the checking tool will simulate a request
# from 192.0.2.0/24. The default value is 24 bits for IPv4 addresses
# and 64 bits for IPv6 addresses.
#
# The range of valid values depends on whether `edns0clientsubnetip`
# is an IPv4 or an IPv6 address:
#
# * **IPv4**\: Specify a value between 0 and 32
#
# * **IPv6**\: Specify a value between 0 and 128
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TestDNSAnswerRequest AWS API Documentation
#
class TestDNSAnswerRequest < Struct.new(
:hosted_zone_id,
:record_name,
:record_type,
:resolver_ip,
:edns0_client_subnet_ip,
:edns0_client_subnet_mask)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response to a `TestDNSAnswer`
# request.
#
# @!attribute [rw] nameserver
# The Amazon Route 53 name server used to respond to the request.
# @return [String]
#
# @!attribute [rw] record_name
# The name of the resource record set that you submitted a request
# for.
# @return [String]
#
# @!attribute [rw] record_type
# The type of the resource record set that you submitted a request
# for.
# @return [String]
#
# @!attribute [rw] record_data
# A list that contains values that Amazon Route 53 returned for this
# resource record set.
# @return [Array<String>]
#
# @!attribute [rw] response_code
# A code that indicates whether the request is valid or not. The most
# common response code is `NOERROR`, meaning that the request is
# valid. If the response is not valid, Amazon Route 53 returns a
# response code that describes the error. For a list of possible
# response codes, see [DNS RCODES][1] on the IANA website.
#
#
#
# [1]: http://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-6
# @return [String]
#
# @!attribute [rw] protocol
# The protocol that Amazon Route 53 used to respond to the request,
# either `UDP` or `TCP`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TestDNSAnswerResponse AWS API Documentation
#
class TestDNSAnswerResponse < Struct.new(
:nameserver,
:record_name,
:record_type,
:record_data,
:response_code,
:protocol)
SENSITIVE = []
include Aws::Structure
end
# The limit on the number of requests per second was exceeded.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ThrottlingException AWS API Documentation
#
class ThrottlingException < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# This health check can't be created because the current account has
# reached the limit on the number of active health checks.
#
# For information about default limits, see [Limits][1] in the *Amazon
# Route 53 Developer Guide*.
#
# For information about how to get the current limit for an account, see
# [GetAccountLimit][2]. To request a higher limit, [create a case][3]
# with the Amazon Web Services Support Center.
#
# You have reached the maximum number of active health checks for an
# Amazon Web Services account. To request a higher limit, [create a
# case][3] with the Amazon Web Services Support Center.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html
# [3]: http://aws.amazon.com/route53-request
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TooManyHealthChecks AWS API Documentation
#
class TooManyHealthChecks < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# This operation can't be completed either because the current account
# has reached the limit on the number of hosted zones or because you've
# reached the limit on the number of hosted zones that can be associated
# with a reusable delegation set.
#
# For information about default limits, see [Limits][1] in the *Amazon
# Route 53 Developer Guide*.
#
# To get the current limit on hosted zones that can be created by an
# account, see [GetAccountLimit][2].
#
# To get the current limit on hosted zones that can be associated with a
# reusable delegation set, see [GetReusableDelegationSetLimit][3].
#
# To request a higher limit, [create a case][4] with the Amazon Web
# Services Support Center.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html
# [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetReusableDelegationSetLimit.html
# [4]: http://aws.amazon.com/route53-request
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TooManyHostedZones AWS API Documentation
#
class TooManyHostedZones < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# You've reached the limit for the number of key-signing keys (KSKs).
# Remove at least one KSK, and then try again.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TooManyKeySigningKeys AWS API Documentation
#
class TooManyKeySigningKeys < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# This traffic policy can't be created because the current account has
# reached the limit on the number of traffic policies.
#
# For information about default limits, see [Limits][1] in the *Amazon
# Route 53 Developer Guide*.
#
# To get the current limit for an account, see [GetAccountLimit][2].
#
# To request a higher limit, [create a case][3] with the Amazon Web
# Services Support Center.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html
# [3]: http://aws.amazon.com/route53-request
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TooManyTrafficPolicies AWS API Documentation
#
class TooManyTrafficPolicies < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# This traffic policy instance can't be created because the current
# account has reached the limit on the number of traffic policy
# instances.
#
# For information about default limits, see [Limits][1] in the *Amazon
# Route 53 Developer Guide*.
#
# For information about how to get the current limit for an account, see
# [GetAccountLimit][2].
#
# To request a higher limit, [create a case][3] with the Amazon Web
# Services Support Center.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html
# [3]: http://aws.amazon.com/route53-request
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TooManyTrafficPolicyInstances AWS API Documentation
#
class TooManyTrafficPolicyInstances < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# This traffic policy version can't be created because you've reached
# the limit of 1000 on the number of versions that you can create for
# the current traffic policy.
#
# To create more traffic policy versions, you can use
# [GetTrafficPolicy][1] to get the traffic policy document for a
# specified traffic policy version, and then use
# [CreateTrafficPolicy][2] to create a new traffic policy using the
# traffic policy document.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetTrafficPolicy.html
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateTrafficPolicy.html
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TooManyTrafficPolicyVersionsForCurrentPolicy AWS API Documentation
#
class TooManyTrafficPolicyVersionsForCurrentPolicy < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# You've created the maximum number of authorizations that can be
# created for the specified hosted zone. To authorize another VPC to be
# associated with the hosted zone, submit a
# `DeleteVPCAssociationAuthorization` request to remove an existing
# authorization. To get a list of existing authorizations, submit a
# `ListVPCAssociationAuthorizations` request.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TooManyVPCAssociationAuthorizations AWS API Documentation
#
class TooManyVPCAssociationAuthorizations < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains settings for a traffic policy.
#
# @!attribute [rw] id
# The ID that Amazon Route 53 assigned to a traffic policy when you
# created it.
# @return [String]
#
# @!attribute [rw] version
# The version number that Amazon Route 53 assigns to a traffic policy.
# For a new traffic policy, the value of `Version` is always 1.
# @return [Integer]
#
# @!attribute [rw] name
# The name that you specified when you created the traffic policy.
# @return [String]
#
# @!attribute [rw] type
# The DNS type of the resource record sets that Amazon Route 53
# creates when you use a traffic policy to create a traffic policy
# instance.
# @return [String]
#
# @!attribute [rw] document
# The definition of a traffic policy in JSON format. You specify the
# JSON document to use for a new traffic policy in the
# `CreateTrafficPolicy` request. For more information about the JSON
# format, see [Traffic Policy Document Format][1].
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/api-policies-traffic-policy-document-format.html
# @return [String]
#
# @!attribute [rw] comment
# The comment that you specify in the `CreateTrafficPolicy` request,
# if any.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TrafficPolicy AWS API Documentation
#
class TrafficPolicy < Struct.new(
:id,
:version,
:name,
:type,
:document,
:comment)
SENSITIVE = []
include Aws::Structure
end
# A traffic policy that has the same value for `Name` already exists.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TrafficPolicyAlreadyExists AWS API Documentation
#
class TrafficPolicyAlreadyExists < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# One or more traffic policy instances were created by using the
# specified traffic policy.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TrafficPolicyInUse AWS API Documentation
#
class TrafficPolicyInUse < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains settings for the new traffic policy
# instance.
#
# @!attribute [rw] id
# The ID that Amazon Route 53 assigned to the new traffic policy
# instance.
# @return [String]
#
# @!attribute [rw] hosted_zone_id
# The ID of the hosted zone that Amazon Route 53 created resource
# record sets in.
# @return [String]
#
# @!attribute [rw] name
# The DNS name, such as www.example.com, for which Amazon Route 53
# responds to queries by using the resource record sets that are
# associated with this traffic policy instance.
# @return [String]
#
# @!attribute [rw] ttl
# The TTL that Amazon Route 53 assigned to all of the resource record
# sets that it created in the specified hosted zone.
# @return [Integer]
#
# @!attribute [rw] state
# The value of `State` is one of the following values:
#
# Applied
#
# : Amazon Route 53 has finished creating resource record sets, and
# changes have propagated to all Route 53 edge locations.
#
# Creating
#
# : Route 53 is creating the resource record sets. Use
# `GetTrafficPolicyInstance` to confirm that the
# `CreateTrafficPolicyInstance` request completed successfully.
#
# Failed
#
# : Route 53 wasn't able to create or update the resource record
# sets. When the value of `State` is `Failed`, see `Message` for an
# explanation of what caused the request to fail.
# @return [String]
#
# @!attribute [rw] message
# If `State` is `Failed`, an explanation of the reason for the
# failure. If `State` is another value, `Message` is empty.
# @return [String]
#
# @!attribute [rw] traffic_policy_id
# The ID of the traffic policy that Amazon Route 53 used to create
# resource record sets in the specified hosted zone.
# @return [String]
#
# @!attribute [rw] traffic_policy_version
# The version of the traffic policy that Amazon Route 53 used to
# create resource record sets in the specified hosted zone.
# @return [Integer]
#
# @!attribute [rw] traffic_policy_type
# The DNS type that Amazon Route 53 assigned to all of the resource
# record sets that it created for this traffic policy instance.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TrafficPolicyInstance AWS API Documentation
#
class TrafficPolicyInstance < Struct.new(
:id,
:hosted_zone_id,
:name,
:ttl,
:state,
:message,
:traffic_policy_id,
:traffic_policy_version,
:traffic_policy_type)
SENSITIVE = []
include Aws::Structure
end
# There is already a traffic policy instance with the specified ID.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TrafficPolicyInstanceAlreadyExists AWS API Documentation
#
class TrafficPolicyInstanceAlreadyExists < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the latest version of
# one traffic policy that is associated with the current Amazon Web
# Services account.
#
# @!attribute [rw] id
# The ID that Amazon Route 53 assigned to the traffic policy when you
# created it.
# @return [String]
#
# @!attribute [rw] name
# The name that you specified for the traffic policy when you created
# it.
# @return [String]
#
# @!attribute [rw] type
# The DNS type of the resource record sets that Amazon Route 53
# creates when you use a traffic policy to create a traffic policy
# instance.
# @return [String]
#
# @!attribute [rw] latest_version
# The version number of the latest version of the traffic policy.
# @return [Integer]
#
# @!attribute [rw] traffic_policy_count
# The number of traffic policies that are associated with the current
# Amazon Web Services account.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/TrafficPolicySummary AWS API Documentation
#
class TrafficPolicySummary < Struct.new(
:id,
:name,
:type,
:latest_version,
:traffic_policy_count)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about a request to update a
# health check.
#
# @note When making an API call, you may pass UpdateHealthCheckRequest
# data as a hash:
#
# {
# health_check_id: "HealthCheckId", # required
# health_check_version: 1,
# ip_address: "IPAddress",
# port: 1,
# resource_path: "ResourcePath",
# fully_qualified_domain_name: "FullyQualifiedDomainName",
# search_string: "SearchString",
# failure_threshold: 1,
# inverted: false,
# disabled: false,
# health_threshold: 1,
# child_health_checks: ["HealthCheckId"],
# enable_sni: false,
# regions: ["us-east-1"], # accepts us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1
# alarm_identifier: {
# region: "us-east-1", # required, accepts us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-central-1, eu-west-1, eu-west-2, eu-west-3, ap-east-1, me-south-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, cn-northwest-1, cn-north-1, af-south-1, eu-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1
# name: "AlarmName", # required
# },
# insufficient_data_health_status: "Healthy", # accepts Healthy, Unhealthy, LastKnownStatus
# reset_elements: ["FullyQualifiedDomainName"], # accepts FullyQualifiedDomainName, Regions, ResourcePath, ChildHealthChecks
# }
#
# @!attribute [rw] health_check_id
# The ID for the health check for which you want detailed information.
# When you created the health check, `CreateHealthCheck` returned the
# ID in the response, in the `HealthCheckId` element.
# @return [String]
#
# @!attribute [rw] health_check_version
# A sequential counter that Amazon Route 53 sets to `1` when you
# create a health check and increments by 1 each time you update
# settings for the health check.
#
# We recommend that you use `GetHealthCheck` or `ListHealthChecks` to
# get the current value of `HealthCheckVersion` for the health check
# that you want to update, and that you include that value in your
# `UpdateHealthCheck` request. This prevents Route 53 from overwriting
# an intervening update:
#
# * If the value in the `UpdateHealthCheck` request matches the value
# of `HealthCheckVersion` in the health check, Route 53 updates the
# health check with the new settings.
#
# * If the value of `HealthCheckVersion` in the health check is
# greater, the health check was changed after you got the version
# number. Route 53 does not update the health check, and it returns
# a `HealthCheckVersionMismatch` error.
# @return [Integer]
#
# @!attribute [rw] ip_address
# The IPv4 or IPv6 IP address for the endpoint that you want Amazon
# Route 53 to perform health checks on. If you don't specify a value
# for `IPAddress`, Route 53 sends a DNS request to resolve the domain
# name that you specify in `FullyQualifiedDomainName` at the interval
# that you specify in `RequestInterval`. Using an IP address that is
# returned by DNS, Route 53 then checks the health of the endpoint.
#
# Use one of the following formats for the value of `IPAddress`\:
#
# * **IPv4 address**\: four values between 0 and 255, separated by
# periods (.), for example, `192.0.2.44`.
#
# * **IPv6 address**\: eight groups of four hexadecimal values,
# separated by colons (:), for example,
# `2001:0db8:85a3:0000:0000:abcd:0001:2345`. You can also shorten
# IPv6 addresses as described in RFC 5952, for example,
# `2001:db8:85a3::abcd:1:2345`.
#
# If the endpoint is an EC2 instance, we recommend that you create an
# Elastic IP address, associate it with your EC2 instance, and specify
# the Elastic IP address for `IPAddress`. This ensures that the IP
# address of your instance never changes. For more information, see
# the applicable documentation:
#
# * Linux: [Elastic IP Addresses (EIP)][1] in the *Amazon EC2 User
# Guide for Linux Instances*
#
# * Windows: [Elastic IP Addresses (EIP)][2] in the *Amazon EC2 User
# Guide for Windows Instances*
#
# <note markdown="1"> If a health check already has a value for `IPAddress`, you can
# change the value. However, you can't update an existing health
# check to add or remove the value of `IPAddress`.
#
# </note>
#
# For more information, see [FullyQualifiedDomainName][3].
#
# Constraints: Route 53 can't check the health of endpoints for which
# the IP address is in local, private, non-routable, or multicast
# ranges. For more information about IP addresses for which you can't
# create health checks, see the following documents:
#
# * [RFC 5735, Special Use IPv4 Addresses][4]
#
# * [RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space][5]
#
# * [RFC 5156, Special-Use IPv6 Addresses][6]
#
#
#
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-ip-addresses-eip.html
# [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName
# [4]: https://tools.ietf.org/html/rfc5735
# [5]: https://tools.ietf.org/html/rfc6598
# [6]: https://tools.ietf.org/html/rfc5156
# @return [String]
#
# @!attribute [rw] port
# The port on the endpoint that you want Amazon Route 53 to perform
# health checks on.
#
# <note markdown="1"> Don't specify a value for `Port` when you specify a value for
# `Type` of `CLOUDWATCH_METRIC` or `CALCULATED`.
#
# </note>
# @return [Integer]
#
# @!attribute [rw] resource_path
# The path that you want Amazon Route 53 to request when performing
# health checks. The path can be any value for which your endpoint
# will return an HTTP status code of 2xx or 3xx when the endpoint is
# healthy, for example the file /docs/route53-health-check.html. You
# can also include query string parameters, for example,
# `/welcome.html?language=jp&login=y`.
#
# Specify this value only if you want to change it.
# @return [String]
#
# @!attribute [rw] fully_qualified_domain_name
# Amazon Route 53 behavior depends on whether you specify a value for
# `IPAddress`.
#
# <note markdown="1"> If a health check already has a value for `IPAddress`, you can
# change the value. However, you can't update an existing health
# check to add or remove the value of `IPAddress`.
#
# </note>
#
# **If you specify a value for** `IPAddress`\:
#
# Route 53 sends health check requests to the specified IPv4 or IPv6
# address and passes the value of `FullyQualifiedDomainName` in the
# `Host` header for all health checks except TCP health checks. This
# is typically the fully qualified DNS name of the endpoint on which
# you want Route 53 to perform health checks.
#
# When Route 53 checks the health of an endpoint, here is how it
# constructs the `Host` header:
#
# * If you specify a value of `80` for `Port` and `HTTP` or
# `HTTP_STR_MATCH` for `Type`, Route 53 passes the value of
# `FullyQualifiedDomainName` to the endpoint in the `Host` header.
#
# * If you specify a value of `443` for `Port` and `HTTPS` or
# `HTTPS_STR_MATCH` for `Type`, Route 53 passes the value of
# `FullyQualifiedDomainName` to the endpoint in the `Host` header.
#
# * If you specify another value for `Port` and any value except `TCP`
# for `Type`, Route 53 passes <i>
# <code>FullyQualifiedDomainName</code>\:<code>Port</code> </i> to
# the endpoint in the `Host` header.
#
# If you don't specify a value for `FullyQualifiedDomainName`, Route
# 53 substitutes the value of `IPAddress` in the `Host` header in each
# of the above cases.
#
# **If you don't specify a value for** `IPAddress`\:
#
# If you don't specify a value for `IPAddress`, Route 53 sends a DNS
# request to the domain that you specify in `FullyQualifiedDomainName`
# at the interval you specify in `RequestInterval`. Using an IPv4
# address that is returned by DNS, Route 53 then checks the health of
# the endpoint.
#
# <note markdown="1"> If you don't specify a value for `IPAddress`, Route 53 uses only
# IPv4 to send health checks to the endpoint. If there's no resource
# record set with a type of A for the name that you specify for
# `FullyQualifiedDomainName`, the health check fails with a "DNS
# resolution failed" error.
#
# </note>
#
# If you want to check the health of weighted, latency, or failover
# resource record sets and you choose to specify the endpoint only by
# `FullyQualifiedDomainName`, we recommend that you create a separate
# health check for each endpoint. For example, create a health check
# for each HTTP server that is serving content for www.example.com.
# For the value of `FullyQualifiedDomainName`, specify the domain name
# of the server (such as `us-east-2-www.example.com`), not the name of
# the resource record sets (www.example.com).
#
# In this configuration, if the value of `FullyQualifiedDomainName`
# matches the name of the resource record sets and you then associate
# the health check with those resource record sets, health check
# results will be unpredictable.
#
# In addition, if the value of `Type` is `HTTP`, `HTTPS`,
# `HTTP_STR_MATCH`, or `HTTPS_STR_MATCH`, Route 53 passes the value of
# `FullyQualifiedDomainName` in the `Host` header, as it does when you
# specify a value for `IPAddress`. If the value of `Type` is `TCP`,
# Route 53 doesn't pass a `Host` header.
# @return [String]
#
# @!attribute [rw] search_string
# If the value of `Type` is `HTTP_STR_MATCH` or `HTTPS_STR_MATCH`, the
# string that you want Amazon Route 53 to search for in the response
# body from the specified resource. If the string appears in the
# response body, Route 53 considers the resource healthy. (You can't
# change the value of `Type` when you update a health check.)
# @return [String]
#
# @!attribute [rw] failure_threshold
# The number of consecutive health checks that an endpoint must pass
# or fail for Amazon Route 53 to change the current status of the
# endpoint from unhealthy to healthy or vice versa. For more
# information, see [How Amazon Route 53 Determines Whether an Endpoint
# Is Healthy][1] in the *Amazon Route 53 Developer Guide*.
#
# If you don't specify a value for `FailureThreshold`, the default
# value is three health checks.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html
# @return [Integer]
#
# @!attribute [rw] inverted
# Specify whether you want Amazon Route 53 to invert the status of a
# health check, for example, to consider a health check unhealthy when
# it otherwise would be considered healthy.
# @return [Boolean]
#
# @!attribute [rw] disabled
# Stops Route 53 from performing health checks. When you disable a
# health check, here's what happens:
#
# * **Health checks that check the health of endpoints:** Route 53
# stops submitting requests to your application, server, or other
# resource.
#
# * **Calculated health checks:** Route 53 stops aggregating the
# status of the referenced health checks.
#
# * **Health checks that monitor CloudWatch alarms:** Route 53 stops
# monitoring the corresponding CloudWatch metrics.
#
# After you disable a health check, Route 53 considers the status of
# the health check to always be healthy. If you configured DNS
# failover, Route 53 continues to route traffic to the corresponding
# resources. If you want to stop routing traffic to a resource, change
# the value of [Inverted][1].
#
# Charges for a health check still apply when the health check is
# disabled. For more information, see [Amazon Route 53 Pricing][2].
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-Inverted
# [2]: http://aws.amazon.com/route53/pricing/
# @return [Boolean]
#
# @!attribute [rw] health_threshold
# The number of child health checks that are associated with a
# `CALCULATED` health that Amazon Route 53 must consider healthy for
# the `CALCULATED` health check to be considered healthy. To specify
# the child health checks that you want to associate with a
# `CALCULATED` health check, use the `ChildHealthChecks` and
# `ChildHealthCheck` elements.
#
# Note the following:
#
# * If you specify a number greater than the number of child health
# checks, Route 53 always considers this health check to be
# unhealthy.
#
# * If you specify `0`, Route 53 always considers this health check to
# be healthy.
# @return [Integer]
#
# @!attribute [rw] child_health_checks
# A complex type that contains one `ChildHealthCheck` element for each
# health check that you want to associate with a `CALCULATED` health
# check.
# @return [Array<String>]
#
# @!attribute [rw] enable_sni
# Specify whether you want Amazon Route 53 to send the value of
# `FullyQualifiedDomainName` to the endpoint in the `client_hello`
# message during `TLS` negotiation. This allows the endpoint to
# respond to `HTTPS` health check requests with the applicable SSL/TLS
# certificate.
#
# Some endpoints require that HTTPS requests include the host name in
# the `client_hello` message. If you don't enable SNI, the status of
# the health check will be SSL alert `handshake_failure`. A health
# check can also have that status for other reasons. If SNI is enabled
# and you're still getting the error, check the SSL/TLS configuration
# on your endpoint and confirm that your certificate is valid.
#
# The SSL/TLS certificate on your endpoint includes a domain name in
# the `Common Name` field and possibly several more in the `Subject
# Alternative Names` field. One of the domain names in the certificate
# should match the value that you specify for
# `FullyQualifiedDomainName`. If the endpoint responds to the
# `client_hello` message with a certificate that does not include the
# domain name that you specified in `FullyQualifiedDomainName`, a
# health checker will retry the handshake. In the second attempt, the
# health checker will omit `FullyQualifiedDomainName` from the
# `client_hello` message.
# @return [Boolean]
#
# @!attribute [rw] regions
# A complex type that contains one `Region` element for each region
# that you want Amazon Route 53 health checkers to check the specified
# endpoint from.
# @return [Array<String>]
#
# @!attribute [rw] alarm_identifier
# A complex type that identifies the CloudWatch alarm that you want
# Amazon Route 53 health checkers to use to determine whether the
# specified health check is healthy.
# @return [Types::AlarmIdentifier]
#
# @!attribute [rw] insufficient_data_health_status
# When CloudWatch has insufficient data about the metric to determine
# the alarm state, the status that you want Amazon Route 53 to assign
# to the health check:
#
# * `Healthy`\: Route 53 considers the health check to be healthy.
#
# * `Unhealthy`\: Route 53 considers the health check to be unhealthy.
#
# * `LastKnownStatus`\: Route 53 uses the status of the health check
# from the last time CloudWatch had sufficient data to determine the
# alarm state. For new health checks that have no last known status,
# the default status for the health check is healthy.
# @return [String]
#
# @!attribute [rw] reset_elements
# A complex type that contains one `ResettableElementName` element for
# each element that you want to reset to the default value. Valid
# values for `ResettableElementName` include the following:
#
# * `ChildHealthChecks`\: Amazon Route 53 resets
# [ChildHealthChecks][1] to null.
#
# * `FullyQualifiedDomainName`\: Route 53 resets
# [FullyQualifiedDomainName][2]. to null.
#
# * `Regions`\: Route 53 resets the [Regions][3] list to the default
# set of regions.
#
# * `ResourcePath`\: Route 53 resets [ResourcePath][4] to null.
#
#
#
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-ChildHealthChecks
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName
# [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions
# [4]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-ResourcePath
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/UpdateHealthCheckRequest AWS API Documentation
#
class UpdateHealthCheckRequest < Struct.new(
:health_check_id,
:health_check_version,
:ip_address,
:port,
:resource_path,
:fully_qualified_domain_name,
:search_string,
:failure_threshold,
:inverted,
:disabled,
:health_threshold,
:child_health_checks,
:enable_sni,
:regions,
:alarm_identifier,
:insufficient_data_health_status,
:reset_elements)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response to the `UpdateHealthCheck`
# request.
#
# @!attribute [rw] health_check
# A complex type that contains the response to an `UpdateHealthCheck`
# request.
# @return [Types::HealthCheck]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/UpdateHealthCheckResponse AWS API Documentation
#
class UpdateHealthCheckResponse < Struct.new(
:health_check)
SENSITIVE = []
include Aws::Structure
end
# A request to update the comment for a hosted zone.
#
# @note When making an API call, you may pass UpdateHostedZoneCommentRequest
# data as a hash:
#
# {
# id: "ResourceId", # required
# comment: "ResourceDescription",
# }
#
# @!attribute [rw] id
# The ID for the hosted zone that you want to update the comment for.
# @return [String]
#
# @!attribute [rw] comment
# The new comment for the hosted zone. If you don't specify a value
# for `Comment`, Amazon Route 53 deletes the existing value of the
# `Comment` element, if any.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/UpdateHostedZoneCommentRequest AWS API Documentation
#
class UpdateHostedZoneCommentRequest < Struct.new(
:id,
:comment)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response to the
# `UpdateHostedZoneComment` request.
#
# @!attribute [rw] hosted_zone
# A complex type that contains the response to the
# `UpdateHostedZoneComment` request.
# @return [Types::HostedZone]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/UpdateHostedZoneCommentResponse AWS API Documentation
#
class UpdateHostedZoneCommentResponse < Struct.new(
:hosted_zone)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the traffic policy that
# you want to update the comment for.
#
# @note When making an API call, you may pass UpdateTrafficPolicyCommentRequest
# data as a hash:
#
# {
# id: "TrafficPolicyId", # required
# version: 1, # required
# comment: "TrafficPolicyComment", # required
# }
#
# @!attribute [rw] id
# The value of `Id` for the traffic policy that you want to update the
# comment for.
# @return [String]
#
# @!attribute [rw] version
# The value of `Version` for the traffic policy that you want to
# update the comment for.
# @return [Integer]
#
# @!attribute [rw] comment
# The new comment for the specified traffic policy and version.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/UpdateTrafficPolicyCommentRequest AWS API Documentation
#
class UpdateTrafficPolicyCommentRequest < Struct.new(
:id,
:version,
:comment)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains the response information for the traffic
# policy.
#
# @!attribute [rw] traffic_policy
# A complex type that contains settings for the specified traffic
# policy.
# @return [Types::TrafficPolicy]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/UpdateTrafficPolicyCommentResponse AWS API Documentation
#
class UpdateTrafficPolicyCommentResponse < Struct.new(
:traffic_policy)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the resource record
# sets that you want to update based on a specified traffic policy
# instance.
#
# @note When making an API call, you may pass UpdateTrafficPolicyInstanceRequest
# data as a hash:
#
# {
# id: "TrafficPolicyInstanceId", # required
# ttl: 1, # required
# traffic_policy_id: "TrafficPolicyId", # required
# traffic_policy_version: 1, # required
# }
#
# @!attribute [rw] id
# The ID of the traffic policy instance that you want to update.
# @return [String]
#
# @!attribute [rw] ttl
# The TTL that you want Amazon Route 53 to assign to all of the
# updated resource record sets.
# @return [Integer]
#
# @!attribute [rw] traffic_policy_id
# The ID of the traffic policy that you want Amazon Route 53 to use to
# update resource record sets for the specified traffic policy
# instance.
# @return [String]
#
# @!attribute [rw] traffic_policy_version
# The version of the traffic policy that you want Amazon Route 53 to
# use to update resource record sets for the specified traffic policy
# instance.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/UpdateTrafficPolicyInstanceRequest AWS API Documentation
#
class UpdateTrafficPolicyInstanceRequest < Struct.new(
:id,
:ttl,
:traffic_policy_id,
:traffic_policy_version)
SENSITIVE = []
include Aws::Structure
end
# A complex type that contains information about the resource record
# sets that Amazon Route 53 created based on a specified traffic policy.
#
# @!attribute [rw] traffic_policy_instance
# A complex type that contains settings for the updated traffic policy
# instance.
# @return [Types::TrafficPolicyInstance]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/UpdateTrafficPolicyInstanceResponse AWS API Documentation
#
class UpdateTrafficPolicyInstanceResponse < Struct.new(
:traffic_policy_instance)
SENSITIVE = []
include Aws::Structure
end
# (Private hosted zones only) A complex type that contains information
# about an Amazon VPC.
#
# @note When making an API call, you may pass VPC
# data as a hash:
#
# {
# vpc_region: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ap-east-1, me-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1, ap-southeast-1, ap-southeast-2, ap-south-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, ca-central-1, cn-north-1, af-south-1, eu-south-1
# vpc_id: "VPCId",
# }
#
# @!attribute [rw] vpc_region
# (Private hosted zones only) The region that an Amazon VPC was
# created in.
# @return [String]
#
# @!attribute [rw] vpc_id
# (Private hosted zones only) The ID of an Amazon VPC.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/VPC AWS API Documentation
#
class VPC < Struct.new(
:vpc_region,
:vpc_id)
SENSITIVE = []
include Aws::Structure
end
# The VPC that you specified is not authorized to be associated with the
# hosted zone.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/VPCAssociationAuthorizationNotFound AWS API Documentation
#
class VPCAssociationAuthorizationNotFound < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The specified VPC and hosted zone are not currently associated.
#
# @!attribute [rw] message
# The specified VPC or hosted zone weren't found.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/VPCAssociationNotFound AWS API Documentation
#
class VPCAssociationNotFound < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
end
end