@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AliasTarget extends Object implements Serializable, Cloneable
Alias resource record sets only: Information about the CloudFront distribution, Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set that you're redirecting queries to. The Elastic Beanstalk environment must have a regionalized subdomain.
When creating resource record sets for a private hosted zone, note the following:
Resource record sets can't be created for CloudFront distributions in a private hosted zone.
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.
Constructor and Description |
---|
AliasTarget()
Default constructor for AliasTarget object.
|
AliasTarget(String hostedZoneId,
String dNSName)
Constructs a new AliasTarget object.
|
Modifier and Type | Method and Description |
---|---|
AliasTarget |
clone() |
boolean |
equals(Object obj) |
String |
getDNSName()
Alias resource record sets only: The value that you specify depends on where you want to route queries:
|
Boolean |
getEvaluateTargetHealth()
Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set the value
of
EvaluateTargetHealth to true for the resource record set or sets in an alias,
weighted alias, latency alias, or failover alias resource record set, and if you specify a value for
HealthCheck$Id for every resource record set that is referenced by these alias resource
record sets, the alias resource record sets inherit the health of the referenced resource record sets. |
String |
getHostedZoneId()
Alias resource records sets only: The value used depends on where the queries are routed:
|
int |
hashCode() |
Boolean |
isEvaluateTargetHealth()
Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set the value
of
EvaluateTargetHealth to true for the resource record set or sets in an alias,
weighted alias, latency alias, or failover alias resource record set, and if you specify a value for
HealthCheck$Id for every resource record set that is referenced by these alias resource
record sets, the alias resource record sets inherit the health of the referenced resource record sets. |
void |
setDNSName(String dNSName)
Alias resource record sets only: The value that you specify depends on where you want to route queries:
|
void |
setEvaluateTargetHealth(Boolean evaluateTargetHealth)
Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set the value
of
EvaluateTargetHealth to true for the resource record set or sets in an alias,
weighted alias, latency alias, or failover alias resource record set, and if you specify a value for
HealthCheck$Id for every resource record set that is referenced by these alias resource
record sets, the alias resource record sets inherit the health of the referenced resource record sets. |
void |
setHostedZoneId(String hostedZoneId)
Alias resource records sets only: The value used depends on where the queries are routed:
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
AliasTarget |
withDNSName(String dNSName)
Alias resource record sets only: The value that you specify depends on where you want to route queries:
|
AliasTarget |
withEvaluateTargetHealth(Boolean evaluateTargetHealth)
Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set the value
of
EvaluateTargetHealth to true for the resource record set or sets in an alias,
weighted alias, latency alias, or failover alias resource record set, and if you specify a value for
HealthCheck$Id for every resource record set that is referenced by these alias resource
record sets, the alias resource record sets inherit the health of the referenced resource record sets. |
AliasTarget |
withHostedZoneId(String hostedZoneId)
Alias resource records sets only: The value used depends on where the queries are routed:
|
public AliasTarget()
public AliasTarget(String hostedZoneId, String dNSName)
hostedZoneId
- Alias resource records sets only: The value used depends on where the queries are routed:
Specify Z2FDTNDATAQYW2
.
Alias resource record sets for CloudFront can't be created in a private zone.
Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the Amazon Web Services General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab. Use the same process to get the value of DNS name. (You specify the value of DNS name for AliasTarget$DNSName.)
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
CanonicalHostedZoneNameId
and DNSName
. (You specify the value of
DNSName
for AliasTarget$DNSName.) For more information, see the applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of CanonicalHostedZoneNameID
and DNSName
. (You specify the
value of DNSName
for AliasTarget$DNSName.)
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon Simple Storage Service Website Endpoints in the Amazon Web Services General Reference.
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.)
dNSName
- Alias resource record sets only: The value that you specify depends on where you want to route
queries:
A 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) in the Amazon CloudFront Developer Guide.
Elastic Beanstalk environment: Specify the CNAME
attribute for the environment. (The
environment must have a regionalized domain name.) You can use the following methods to get the value of
the CNAME attribute:
AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.
Elastic Beanstalk API: Use the DescribeEnvironments
action to get the value of the
CNAME
attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.
AWS CLI: Use the describe-environments
command to get the value of the CNAME
attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.
An ELB load balancer: Specify the DNS name that is associated with the load balancer. Get the DNS
name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values
for HostedZoneId
and DNSName
. If you get one value from the console and the
other value from the API or the CLI, creating the resource record set will fail.
AWS Management Console: Go to the EC2 page, click 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.) Use the same process to get the value of the Hosted zone field. See AliasTarget$HostedZoneId.
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
DNSName
and CanonicalHostedZoneNameId
. (You specify the value of
CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.) For more information, see the
applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use describe-load-balancers
to get the value of DNSName
and
CanonicalHostedZoneNameId
. (You specify the value of CanonicalHostedZoneNameId
for
AliasTarget$HostedZoneId.)
An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon
S3 website endpoint in which you created the bucket, for example, s3-website-us-east-1.amazonaws.com
. For more information about valid values, see the table Amazon Simple Storage Service
(S3) Website Endpoints in the Amazon Web Services General Reference. For more information about
using S3 buckets for websites, see Getting Started with
Amazon Route 53 in the Amazon Route 53 Developer Guide.
Another Amazon Route 53 resource record set: Specify the value of the Name
element for
a resource record set in the current hosted zone.
public void setHostedZoneId(String hostedZoneId)
Alias resource records sets only: The value used depends on where the queries are routed:
Specify Z2FDTNDATAQYW2
.
Alias resource record sets for CloudFront can't be created in a private zone.
Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the Amazon Web Services General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab. Use the same process to get the value of DNS name. (You specify the value of DNS name for AliasTarget$DNSName.)
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
CanonicalHostedZoneNameId
and DNSName
. (You specify the value of DNSName
for AliasTarget$DNSName.) For more information, see the applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of CanonicalHostedZoneNameID
and DNSName
. (You specify the value of
DNSName
for AliasTarget$DNSName.)
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon Simple Storage Service Website Endpoints in the Amazon Web Services General Reference.
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.)
hostedZoneId
- Alias resource records sets only: The value used depends on where the queries are routed:
Specify Z2FDTNDATAQYW2
.
Alias resource record sets for CloudFront can't be created in a private zone.
Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the Amazon Web Services General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab. Use the same process to get the value of DNS name. (You specify the value of DNS name for AliasTarget$DNSName.)
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
CanonicalHostedZoneNameId
and DNSName
. (You specify the value of
DNSName
for AliasTarget$DNSName.) For more information, see the applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of CanonicalHostedZoneNameID
and DNSName
. (You specify the
value of DNSName
for AliasTarget$DNSName.)
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon Simple Storage Service Website Endpoints in the Amazon Web Services General Reference.
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.)
public String getHostedZoneId()
Alias resource records sets only: The value used depends on where the queries are routed:
Specify Z2FDTNDATAQYW2
.
Alias resource record sets for CloudFront can't be created in a private zone.
Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the Amazon Web Services General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab. Use the same process to get the value of DNS name. (You specify the value of DNS name for AliasTarget$DNSName.)
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
CanonicalHostedZoneNameId
and DNSName
. (You specify the value of DNSName
for AliasTarget$DNSName.) For more information, see the applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of CanonicalHostedZoneNameID
and DNSName
. (You specify the value of
DNSName
for AliasTarget$DNSName.)
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon Simple Storage Service Website Endpoints in the Amazon Web Services General Reference.
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.)
Specify Z2FDTNDATAQYW2
.
Alias resource record sets for CloudFront can't be created in a private zone.
Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the Amazon Web Services General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab. Use the same process to get the value of DNS name. (You specify the value of DNS name for AliasTarget$DNSName.)
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
CanonicalHostedZoneNameId
and DNSName
. (You specify the value of
DNSName
for AliasTarget$DNSName.) For more information, see the applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of CanonicalHostedZoneNameID
and DNSName
. (You specify the
value of DNSName
for AliasTarget$DNSName.)
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon Simple Storage Service Website Endpoints in the Amazon Web Services General Reference.
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.)
public AliasTarget withHostedZoneId(String hostedZoneId)
Alias resource records sets only: The value used depends on where the queries are routed:
Specify Z2FDTNDATAQYW2
.
Alias resource record sets for CloudFront can't be created in a private zone.
Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the Amazon Web Services General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab. Use the same process to get the value of DNS name. (You specify the value of DNS name for AliasTarget$DNSName.)
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
CanonicalHostedZoneNameId
and DNSName
. (You specify the value of DNSName
for AliasTarget$DNSName.) For more information, see the applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of CanonicalHostedZoneNameID
and DNSName
. (You specify the value of
DNSName
for AliasTarget$DNSName.)
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon Simple Storage Service Website Endpoints in the Amazon Web Services General Reference.
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.)
hostedZoneId
- Alias resource records sets only: The value used depends on where the queries are routed:
Specify Z2FDTNDATAQYW2
.
Alias resource record sets for CloudFront can't be created in a private zone.
Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the Amazon Web Services General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab. Use the same process to get the value of DNS name. (You specify the value of DNS name for AliasTarget$DNSName.)
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
CanonicalHostedZoneNameId
and DNSName
. (You specify the value of
DNSName
for AliasTarget$DNSName.) For more information, see the applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of CanonicalHostedZoneNameID
and DNSName
. (You specify the
value of DNSName
for AliasTarget$DNSName.)
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon Simple Storage Service Website Endpoints in the Amazon Web Services General Reference.
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.)
public void setDNSName(String dNSName)
Alias resource record sets only: The value that you specify depends on where you want to route queries:
A 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) in the Amazon CloudFront Developer Guide.
Elastic Beanstalk environment: Specify the CNAME
attribute for the environment. (The
environment must have a regionalized domain name.) You can use the following methods to get the value of the
CNAME attribute:
AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.
Elastic Beanstalk API: Use the DescribeEnvironments
action to get the value of the
CNAME
attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.
AWS CLI: Use the describe-environments
command to get the value of the CNAME
attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.
An ELB load balancer: Specify the DNS name that is associated with the load balancer. Get the DNS name by
using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for
HostedZoneId
and DNSName
. If you get one value from the console and the other value
from the API or the CLI, creating the resource record set will fail.
AWS Management Console: Go to the EC2 page, click 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.) Use the same process to get the value of the Hosted zone field. See AliasTarget$HostedZoneId.
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
DNSName
and CanonicalHostedZoneNameId
. (You specify the value of
CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.) For more information, see the
applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of DNSName
and CanonicalHostedZoneNameId
. (You specify the value of
CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.)
An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3
website endpoint in which you created the bucket, for example, s3-website-us-east-1.amazonaws.com
.
For more information about valid values, see the table Amazon Simple Storage Service (S3)
Website Endpoints in the Amazon Web Services General Reference. For more information about using S3
buckets for websites, see Getting Started with Amazon
Route 53 in the Amazon Route 53 Developer Guide.
Another Amazon Route 53 resource record set: Specify the value of the Name
element for a
resource record set in the current hosted zone.
dNSName
- Alias resource record sets only: The value that you specify depends on where you want to route
queries:
A 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) in the Amazon CloudFront Developer Guide.
Elastic Beanstalk environment: Specify the CNAME
attribute for the environment. (The
environment must have a regionalized domain name.) You can use the following methods to get the value of
the CNAME attribute:
AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.
Elastic Beanstalk API: Use the DescribeEnvironments
action to get the value of the
CNAME
attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.
AWS CLI: Use the describe-environments
command to get the value of the
CNAME
attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.
An ELB load balancer: Specify the DNS name that is associated with the load balancer. Get the DNS
name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values
for HostedZoneId
and DNSName
. If you get one value from the console and the
other value from the API or the CLI, creating the resource record set will fail.
AWS Management Console: Go to the EC2 page, click 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.) Use the same process to get the value of the Hosted zone field. See AliasTarget$HostedZoneId.
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
DNSName
and CanonicalHostedZoneNameId
. (You specify the value of
CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.) For more information, see the
applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of DNSName
and CanonicalHostedZoneNameId
. (You specify the
value of CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.)
An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon
S3 website endpoint in which you created the bucket, for example,
s3-website-us-east-1.amazonaws.com
. For more information about valid values, see the table Amazon Simple Storage Service
(S3) Website Endpoints in the Amazon Web Services General Reference. For more information about
using S3 buckets for websites, see Getting Started with
Amazon Route 53 in the Amazon Route 53 Developer Guide.
Another Amazon Route 53 resource record set: Specify the value of the Name
element for
a resource record set in the current hosted zone.
public String getDNSName()
Alias resource record sets only: The value that you specify depends on where you want to route queries:
A 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) in the Amazon CloudFront Developer Guide.
Elastic Beanstalk environment: Specify the CNAME
attribute for the environment. (The
environment must have a regionalized domain name.) You can use the following methods to get the value of the
CNAME attribute:
AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.
Elastic Beanstalk API: Use the DescribeEnvironments
action to get the value of the
CNAME
attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.
AWS CLI: Use the describe-environments
command to get the value of the CNAME
attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.
An ELB load balancer: Specify the DNS name that is associated with the load balancer. Get the DNS name by
using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for
HostedZoneId
and DNSName
. If you get one value from the console and the other value
from the API or the CLI, creating the resource record set will fail.
AWS Management Console: Go to the EC2 page, click 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.) Use the same process to get the value of the Hosted zone field. See AliasTarget$HostedZoneId.
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
DNSName
and CanonicalHostedZoneNameId
. (You specify the value of
CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.) For more information, see the
applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of DNSName
and CanonicalHostedZoneNameId
. (You specify the value of
CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.)
An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3
website endpoint in which you created the bucket, for example, s3-website-us-east-1.amazonaws.com
.
For more information about valid values, see the table Amazon Simple Storage Service (S3)
Website Endpoints in the Amazon Web Services General Reference. For more information about using S3
buckets for websites, see Getting Started with Amazon
Route 53 in the Amazon Route 53 Developer Guide.
Another Amazon Route 53 resource record set: Specify the value of the Name
element for a
resource record set in the current hosted zone.
A 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) in the Amazon CloudFront Developer Guide.
Elastic Beanstalk environment: Specify the CNAME
attribute for the environment. (The
environment must have a regionalized domain name.) You can use the following methods to get the value of
the CNAME attribute:
AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.
Elastic Beanstalk API: Use the DescribeEnvironments
action to get the value of the
CNAME
attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.
AWS CLI: Use the describe-environments
command to get the value of the
CNAME
attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.
An ELB load balancer: Specify the DNS name that is associated with the load balancer. Get the DNS
name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values
for HostedZoneId
and DNSName
. If you get one value from the console and the
other value from the API or the CLI, creating the resource record set will fail.
AWS Management Console: Go to the EC2 page, click 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.) Use the same process to get the value of the Hosted zone field. See AliasTarget$HostedZoneId.
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
DNSName
and CanonicalHostedZoneNameId
. (You specify the value of
CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.) For more information, see
the applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of DNSName
and CanonicalHostedZoneNameId
. (You specify the
value of CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.)
An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon
S3 website endpoint in which you created the bucket, for example,
s3-website-us-east-1.amazonaws.com
. For more information about valid values, see the table
Amazon Simple Storage Service
(S3) Website Endpoints in the Amazon Web Services General Reference. For more information
about using S3 buckets for websites, see Getting Started with
Amazon Route 53 in the Amazon Route 53 Developer Guide.
Another Amazon Route 53 resource record set: Specify the value of the Name
element
for a resource record set in the current hosted zone.
public AliasTarget withDNSName(String dNSName)
Alias resource record sets only: The value that you specify depends on where you want to route queries:
A 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) in the Amazon CloudFront Developer Guide.
Elastic Beanstalk environment: Specify the CNAME
attribute for the environment. (The
environment must have a regionalized domain name.) You can use the following methods to get the value of the
CNAME attribute:
AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.
Elastic Beanstalk API: Use the DescribeEnvironments
action to get the value of the
CNAME
attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.
AWS CLI: Use the describe-environments
command to get the value of the CNAME
attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.
An ELB load balancer: Specify the DNS name that is associated with the load balancer. Get the DNS name by
using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for
HostedZoneId
and DNSName
. If you get one value from the console and the other value
from the API or the CLI, creating the resource record set will fail.
AWS Management Console: Go to the EC2 page, click 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.) Use the same process to get the value of the Hosted zone field. See AliasTarget$HostedZoneId.
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
DNSName
and CanonicalHostedZoneNameId
. (You specify the value of
CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.) For more information, see the
applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of DNSName
and CanonicalHostedZoneNameId
. (You specify the value of
CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.)
An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3
website endpoint in which you created the bucket, for example, s3-website-us-east-1.amazonaws.com
.
For more information about valid values, see the table Amazon Simple Storage Service (S3)
Website Endpoints in the Amazon Web Services General Reference. For more information about using S3
buckets for websites, see Getting Started with Amazon
Route 53 in the Amazon Route 53 Developer Guide.
Another Amazon Route 53 resource record set: Specify the value of the Name
element for a
resource record set in the current hosted zone.
dNSName
- Alias resource record sets only: The value that you specify depends on where you want to route
queries:
A 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) in the Amazon CloudFront Developer Guide.
Elastic Beanstalk environment: Specify the CNAME
attribute for the environment. (The
environment must have a regionalized domain name.) You can use the following methods to get the value of
the CNAME attribute:
AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.
Elastic Beanstalk API: Use the DescribeEnvironments
action to get the value of the
CNAME
attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.
AWS CLI: Use the describe-environments
command to get the value of the
CNAME
attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.
An ELB load balancer: Specify the DNS name that is associated with the load balancer. Get the DNS
name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values
for HostedZoneId
and DNSName
. If you get one value from the console and the
other value from the API or the CLI, creating the resource record set will fail.
AWS Management Console: Go to the EC2 page, click 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.) Use the same process to get the value of the Hosted zone field. See AliasTarget$HostedZoneId.
Elastic Load Balancing API: Use DescribeLoadBalancers
to get the value of
DNSName
and CanonicalHostedZoneNameId
. (You specify the value of
CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.) For more information, see the
applicable guide:
Classic Load Balancer: DescribeLoadBalancers
Application Load Balancer: DescribeLoadBalancers
AWS CLI: Use
describe-load-balancers
to get the value of DNSName
and CanonicalHostedZoneNameId
. (You specify the
value of CanonicalHostedZoneNameId
for AliasTarget$HostedZoneId.)
An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon
S3 website endpoint in which you created the bucket, for example,
s3-website-us-east-1.amazonaws.com
. For more information about valid values, see the table Amazon Simple Storage Service
(S3) Website Endpoints in the Amazon Web Services General Reference. For more information about
using S3 buckets for websites, see Getting Started with
Amazon Route 53 in the Amazon Route 53 Developer Guide.
Another Amazon Route 53 resource record set: Specify the value of the Name
element for
a resource record set in the current hosted zone.
public void setEvaluateTargetHealth(Boolean evaluateTargetHealth)
Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set the value
of EvaluateTargetHealth
to true
for the resource record set or sets in an alias,
weighted alias, latency alias, or failover alias resource record set, and if you specify a value for
HealthCheck$Id
for every resource record set that is referenced by these alias resource
record sets, the alias resource record sets inherit the health of the referenced resource record sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.
Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)
Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.
Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.
Note the following:
You can't set EvaluateTargetHealth
to true
when the alias target is a CloudFront
distribution.
If the AWS resource that you specify in AliasTarget
is a resource record set or a group of resource
record sets (for example, a group of weighted resource record sets), but it is not another alias resource record
set, we recommend that you associate a health check with all of the resource record sets in the alias target.For
more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
If you specify an Elastic Beanstalk environment in HostedZoneId
and DNSName
, and if 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 EC2 instance.) If you set EvaluateTargetHealth
to true
and
either no EC2 instances are healthy or the load balancer itself is unhealthy, Amazon Route 53 routes queries to
other available resources that are healthy, if any.
If the environment contains a single EC2 instance, there are no special requirements.
If you specify an ELB load balancer in AliasTarget
, Elastic Load Balancing routes queries
only to the healthy EC2 instances that are registered with the load balancer. If no EC2 instances are healthy or
if the load balancer itself is unhealthy, and if EvaluateTargetHealth
is true for the corresponding
alias resource record set, Amazon Route 53 routes queries to other resources. When you create a load balancer,
you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but
they perform a similar function. Do not create Amazon Route 53 health checks for the EC2 instances that you
register with an ELB load balancer.
For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.
We recommend that you set EvaluateTargetHealth
to true only when you have enough idle capacity to
handle the failure of one or more endpoints.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
evaluateTargetHealth
- Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set
the value of EvaluateTargetHealth
to true
for the resource record set or sets in
an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a value
for HealthCheck$Id
for every resource record set that is referenced by these alias
resource record sets, the alias resource record sets inherit the health of the referenced resource record
sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.
Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)
Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.
Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.
Note the following:
You can't set EvaluateTargetHealth
to true
when the alias target is a CloudFront
distribution.
If the AWS resource that you specify in AliasTarget
is a resource record set or a group of
resource record sets (for example, a group of weighted resource record sets), but it is not another alias
resource record set, we recommend that you associate a health check with all of the resource record sets
in the alias target.For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
If you specify an Elastic Beanstalk environment in HostedZoneId
and DNSName
, and
if 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 EC2 instance.) If you set
EvaluateTargetHealth
to true
and either no EC2 instances are healthy or the load
balancer itself is unhealthy, Amazon Route 53 routes queries to other available resources that are
healthy, if any.
If the environment contains a single EC2 instance, there are no special requirements.
If you specify an ELB load balancer in AliasTarget
, Elastic Load Balancing routes
queries only to the healthy EC2 instances that are registered with the load balancer. If no EC2 instances
are healthy or if the load balancer itself is unhealthy, and if EvaluateTargetHealth
is true
for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When
you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not
Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health
checks for the EC2 instances that you register with an ELB load balancer.
For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.
We recommend that you set EvaluateTargetHealth
to true only when you have enough idle
capacity to handle the failure of one or more endpoints.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
public Boolean getEvaluateTargetHealth()
Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set the value
of EvaluateTargetHealth
to true
for the resource record set or sets in an alias,
weighted alias, latency alias, or failover alias resource record set, and if you specify a value for
HealthCheck$Id
for every resource record set that is referenced by these alias resource
record sets, the alias resource record sets inherit the health of the referenced resource record sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.
Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)
Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.
Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.
Note the following:
You can't set EvaluateTargetHealth
to true
when the alias target is a CloudFront
distribution.
If the AWS resource that you specify in AliasTarget
is a resource record set or a group of resource
record sets (for example, a group of weighted resource record sets), but it is not another alias resource record
set, we recommend that you associate a health check with all of the resource record sets in the alias target.For
more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
If you specify an Elastic Beanstalk environment in HostedZoneId
and DNSName
, and if 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 EC2 instance.) If you set EvaluateTargetHealth
to true
and
either no EC2 instances are healthy or the load balancer itself is unhealthy, Amazon Route 53 routes queries to
other available resources that are healthy, if any.
If the environment contains a single EC2 instance, there are no special requirements.
If you specify an ELB load balancer in AliasTarget
, Elastic Load Balancing routes queries
only to the healthy EC2 instances that are registered with the load balancer. If no EC2 instances are healthy or
if the load balancer itself is unhealthy, and if EvaluateTargetHealth
is true for the corresponding
alias resource record set, Amazon Route 53 routes queries to other resources. When you create a load balancer,
you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but
they perform a similar function. Do not create Amazon Route 53 health checks for the EC2 instances that you
register with an ELB load balancer.
For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.
We recommend that you set EvaluateTargetHealth
to true only when you have enough idle capacity to
handle the failure of one or more endpoints.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
EvaluateTargetHealth
to true
for the resource record set or sets
in an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a
value for HealthCheck$Id
for every resource record set that is referenced by these
alias resource record sets, the alias resource record sets inherit the health of the referenced resource
record sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.
Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)
Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.
Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.
Note the following:
You can't set EvaluateTargetHealth
to true
when the alias target is a
CloudFront distribution.
If the AWS resource that you specify in AliasTarget
is a resource record set or a group of
resource record sets (for example, a group of weighted resource record sets), but it is not another alias
resource record set, we recommend that you associate a health check with all of the resource record sets
in the alias target.For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
If you specify an Elastic Beanstalk environment in HostedZoneId
and DNSName
,
and if 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 EC2 instance.) If you set
EvaluateTargetHealth
to true
and either no EC2 instances are healthy or the
load balancer itself is unhealthy, Amazon Route 53 routes queries to other available resources that are
healthy, if any.
If the environment contains a single EC2 instance, there are no special requirements.
If you specify an ELB load balancer in AliasTarget
, Elastic Load Balancing routes
queries only to the healthy EC2 instances that are registered with the load balancer. If no EC2 instances
are healthy or if the load balancer itself is unhealthy, and if EvaluateTargetHealth
is true
for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When
you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not
Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health
checks for the EC2 instances that you register with an ELB load balancer.
For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.
We recommend that you set EvaluateTargetHealth
to true only when you have enough idle
capacity to handle the failure of one or more endpoints.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
public AliasTarget withEvaluateTargetHealth(Boolean evaluateTargetHealth)
Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set the value
of EvaluateTargetHealth
to true
for the resource record set or sets in an alias,
weighted alias, latency alias, or failover alias resource record set, and if you specify a value for
HealthCheck$Id
for every resource record set that is referenced by these alias resource
record sets, the alias resource record sets inherit the health of the referenced resource record sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.
Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)
Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.
Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.
Note the following:
You can't set EvaluateTargetHealth
to true
when the alias target is a CloudFront
distribution.
If the AWS resource that you specify in AliasTarget
is a resource record set or a group of resource
record sets (for example, a group of weighted resource record sets), but it is not another alias resource record
set, we recommend that you associate a health check with all of the resource record sets in the alias target.For
more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
If you specify an Elastic Beanstalk environment in HostedZoneId
and DNSName
, and if 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 EC2 instance.) If you set EvaluateTargetHealth
to true
and
either no EC2 instances are healthy or the load balancer itself is unhealthy, Amazon Route 53 routes queries to
other available resources that are healthy, if any.
If the environment contains a single EC2 instance, there are no special requirements.
If you specify an ELB load balancer in AliasTarget
, Elastic Load Balancing routes queries
only to the healthy EC2 instances that are registered with the load balancer. If no EC2 instances are healthy or
if the load balancer itself is unhealthy, and if EvaluateTargetHealth
is true for the corresponding
alias resource record set, Amazon Route 53 routes queries to other resources. When you create a load balancer,
you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but
they perform a similar function. Do not create Amazon Route 53 health checks for the EC2 instances that you
register with an ELB load balancer.
For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.
We recommend that you set EvaluateTargetHealth
to true only when you have enough idle capacity to
handle the failure of one or more endpoints.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
evaluateTargetHealth
- Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set
the value of EvaluateTargetHealth
to true
for the resource record set or sets in
an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a value
for HealthCheck$Id
for every resource record set that is referenced by these alias
resource record sets, the alias resource record sets inherit the health of the referenced resource record
sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.
Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)
Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.
Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.
Note the following:
You can't set EvaluateTargetHealth
to true
when the alias target is a CloudFront
distribution.
If the AWS resource that you specify in AliasTarget
is a resource record set or a group of
resource record sets (for example, a group of weighted resource record sets), but it is not another alias
resource record set, we recommend that you associate a health check with all of the resource record sets
in the alias target.For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
If you specify an Elastic Beanstalk environment in HostedZoneId
and DNSName
, and
if 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 EC2 instance.) If you set
EvaluateTargetHealth
to true
and either no EC2 instances are healthy or the load
balancer itself is unhealthy, Amazon Route 53 routes queries to other available resources that are
healthy, if any.
If the environment contains a single EC2 instance, there are no special requirements.
If you specify an ELB load balancer in AliasTarget
, Elastic Load Balancing routes
queries only to the healthy EC2 instances that are registered with the load balancer. If no EC2 instances
are healthy or if the load balancer itself is unhealthy, and if EvaluateTargetHealth
is true
for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When
you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not
Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health
checks for the EC2 instances that you register with an ELB load balancer.
For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.
We recommend that you set EvaluateTargetHealth
to true only when you have enough idle
capacity to handle the failure of one or more endpoints.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
public Boolean isEvaluateTargetHealth()
Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set the value
of EvaluateTargetHealth
to true
for the resource record set or sets in an alias,
weighted alias, latency alias, or failover alias resource record set, and if you specify a value for
HealthCheck$Id
for every resource record set that is referenced by these alias resource
record sets, the alias resource record sets inherit the health of the referenced resource record sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.
Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)
Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.
Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.
Note the following:
You can't set EvaluateTargetHealth
to true
when the alias target is a CloudFront
distribution.
If the AWS resource that you specify in AliasTarget
is a resource record set or a group of resource
record sets (for example, a group of weighted resource record sets), but it is not another alias resource record
set, we recommend that you associate a health check with all of the resource record sets in the alias target.For
more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
If you specify an Elastic Beanstalk environment in HostedZoneId
and DNSName
, and if 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 EC2 instance.) If you set EvaluateTargetHealth
to true
and
either no EC2 instances are healthy or the load balancer itself is unhealthy, Amazon Route 53 routes queries to
other available resources that are healthy, if any.
If the environment contains a single EC2 instance, there are no special requirements.
If you specify an ELB load balancer in AliasTarget
, Elastic Load Balancing routes queries
only to the healthy EC2 instances that are registered with the load balancer. If no EC2 instances are healthy or
if the load balancer itself is unhealthy, and if EvaluateTargetHealth
is true for the corresponding
alias resource record set, Amazon Route 53 routes queries to other resources. When you create a load balancer,
you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but
they perform a similar function. Do not create Amazon Route 53 health checks for the EC2 instances that you
register with an ELB load balancer.
For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.
We recommend that you set EvaluateTargetHealth
to true only when you have enough idle capacity to
handle the failure of one or more endpoints.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
EvaluateTargetHealth
to true
for the resource record set or sets
in an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a
value for HealthCheck$Id
for every resource record set that is referenced by these
alias resource record sets, the alias resource record sets inherit the health of the referenced resource
record sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.
Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)
Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.
Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.
Note the following:
You can't set EvaluateTargetHealth
to true
when the alias target is a
CloudFront distribution.
If the AWS resource that you specify in AliasTarget
is a resource record set or a group of
resource record sets (for example, a group of weighted resource record sets), but it is not another alias
resource record set, we recommend that you associate a health check with all of the resource record sets
in the alias target.For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
If you specify an Elastic Beanstalk environment in HostedZoneId
and DNSName
,
and if 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 EC2 instance.) If you set
EvaluateTargetHealth
to true
and either no EC2 instances are healthy or the
load balancer itself is unhealthy, Amazon Route 53 routes queries to other available resources that are
healthy, if any.
If the environment contains a single EC2 instance, there are no special requirements.
If you specify an ELB load balancer in AliasTarget
, Elastic Load Balancing routes
queries only to the healthy EC2 instances that are registered with the load balancer. If no EC2 instances
are healthy or if the load balancer itself is unhealthy, and if EvaluateTargetHealth
is true
for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When
you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not
Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health
checks for the EC2 instances that you register with an ELB load balancer.
For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.
We recommend that you set EvaluateTargetHealth
to true only when you have enough idle
capacity to handle the failure of one or more endpoints.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
public String toString()
toString
in class Object
Object.toString()
public AliasTarget clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.