@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 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:
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, 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. |
String |
getHostedZoneId()
Alias resource records sets only: The value used depends on where you want to route traffic:
|
int |
hashCode() |
Boolean |
isEvaluateTargetHealth()
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. |
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, 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. |
void |
setHostedZoneId(String hostedZoneId)
Alias resource records sets only: The value used depends on where you want to route traffic:
|
String |
toString()
Returns a string representation of this object.
|
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, 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. |
AliasTarget |
withHostedZoneId(String hostedZoneId)
Alias resource records sets only: The value used depends on where you want to route traffic:
|
public AliasTarget()
public AliasTarget(String hostedZoneId, String dNSName)
hostedZoneId - Alias resource records sets only: The value used depends on where you want to route traffic:
Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:
For regional APIs, specify the value of regionalHostedZoneId.
For edge-optimized APIs, specify the value of distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId
using the CLI command describe-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
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 in 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:
Elastic Load Balancing endpoints and quotas 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
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 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:
Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names:
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.
The name of the record that you're creating must match a custom domain name for your API, such as
api.example.com.
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.
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.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
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.
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 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 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 in the CLI Command Reference.
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
Application and Network Load Balancers: DescribeLoadBalancers
CLI: Use describe-load-balancers to get the value of DNSName. For more
information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Specify the DNS name for your accelerator:
Global Accelerator API: To get the DNS name, use DescribeAccelerator.
CLI: To get the DNS name, use describe-accelerator.
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 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.
Specify the value of the Name element for a resource record set in the current hosted zone.
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.
public void setHostedZoneId(String hostedZoneId)
Alias resource records sets only: The value used depends on where you want to route traffic:
Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:
For regional APIs, specify the value of regionalHostedZoneId.
For edge-optimized APIs, specify the value of distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using
the CLI command describe
-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
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 in 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:
Elastic Load Balancing endpoints and quotas 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
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 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 you want to route traffic:
Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:
For regional APIs, specify the value of regionalHostedZoneId.
For edge-optimized APIs, specify the value of distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId
using the CLI command describe-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
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 in 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:
Elastic Load Balancing endpoints and quotas 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
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 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 you want to route traffic:
Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:
For regional APIs, specify the value of regionalHostedZoneId.
For edge-optimized APIs, specify the value of distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using
the CLI command describe
-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
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 in 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:
Elastic Load Balancing endpoints and quotas 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
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 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 the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:
For regional APIs, specify the value of regionalHostedZoneId.
For edge-optimized APIs, specify the value of distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the value of
HostedZoneId using the CLI command describe-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
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 in 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:
Elastic Load Balancing endpoints and quotas 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
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 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 you want to route traffic:
Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:
For regional APIs, specify the value of regionalHostedZoneId.
For edge-optimized APIs, specify the value of distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using
the CLI command describe
-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
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 in 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:
Elastic Load Balancing endpoints and quotas 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
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 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 you want to route traffic:
Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:
For regional APIs, specify the value of regionalHostedZoneId.
For edge-optimized APIs, specify the value of distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId
using the CLI command describe-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
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 in 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:
Elastic Load Balancing endpoints and quotas 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers 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 to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
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 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:
Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names:
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.
The name of the record that you're creating must match a custom domain name for your API, such as
api.example.com.
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.
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.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
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.
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 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 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 in the CLI Command Reference.
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
Application and Network Load Balancers: DescribeLoadBalancers
CLI: Use describe-load-balancers to get the value of DNSName. For more
information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Specify the DNS name for your accelerator:
Global Accelerator API: To get the DNS name, use DescribeAccelerator.
CLI: To get the DNS name, use describe-accelerator.
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 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.
Specify the value of the Name element for a resource record set in the current hosted zone.
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.
dNSName - Alias resource record sets only: The value that you specify depends on where you want to route
queries:
Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names:
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.
The name of the record that you're creating must match a custom domain name for your API, such as
api.example.com.
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.
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.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
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.
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 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 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 in the CLI Command Reference.
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
Application and Network Load Balancers: DescribeLoadBalancers
CLI: Use describe-load-balancers to get the value of DNSName. For more
information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Specify the DNS name for your accelerator:
Global Accelerator API: To get the DNS name, use DescribeAccelerator.
CLI: To get the DNS name, use describe-accelerator.
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 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.
Specify the value of the Name element for a resource record set in the current hosted zone.
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.
public String getDNSName()
Alias resource record sets only: The value that you specify depends on where you want to route queries:
Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names:
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.
The name of the record that you're creating must match a custom domain name for your API, such as
api.example.com.
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.
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.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
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.
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 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 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 in the CLI Command Reference.
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
Application and Network Load Balancers: DescribeLoadBalancers
CLI: Use describe-load-balancers to get the value of DNSName. For more
information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Specify the DNS name for your accelerator:
Global Accelerator API: To get the DNS name, use DescribeAccelerator.
CLI: To get the DNS name, use describe-accelerator.
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 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.
Specify the value of the Name element for a resource record set in the current hosted zone.
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.
Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain- names:
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.
The name of the record that you're creating must match a custom domain name for your API, such as
api.example.com.
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.
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.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
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.
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 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 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 in the CLI Command Reference.
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
Application and Network Load Balancers: DescribeLoadBalancers
CLI: Use describe-load-balancers to get the value of DNSName. For more
information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Specify the DNS name for your accelerator:
Global Accelerator API: To get the DNS name, use DescribeAccelerator.
CLI: To get the DNS name, use describe-accelerator.
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 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.
Specify the value of the Name element for a resource record set in the current hosted zone.
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.
public AliasTarget withDNSName(String dNSName)
Alias resource record sets only: The value that you specify depends on where you want to route queries:
Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names:
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.
The name of the record that you're creating must match a custom domain name for your API, such as
api.example.com.
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.
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.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
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.
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 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 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 in the CLI Command Reference.
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
Application and Network Load Balancers: DescribeLoadBalancers
CLI: Use describe-load-balancers to get the value of DNSName. For more
information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Specify the DNS name for your accelerator:
Global Accelerator API: To get the DNS name, use DescribeAccelerator.
CLI: To get the DNS name, use describe-accelerator.
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 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.
Specify the value of the Name element for a resource record set in the current hosted zone.
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.
dNSName - Alias resource record sets only: The value that you specify depends on where you want to route
queries:
Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names:
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.
The name of the record that you're creating must match a custom domain name for your API, such as
api.example.com.
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.
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.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
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.
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 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 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 in the CLI Command Reference.
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
Application and Network Load Balancers: DescribeLoadBalancers
CLI: Use describe-load-balancers to get the value of DNSName. For more
information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Specify the DNS name for your accelerator:
Global Accelerator API: To get the DNS name, use DescribeAccelerator.
CLI: To get the DNS name, use describe-accelerator.
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 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.
Specify the value of the Name element for a resource record set in the current hosted zone.
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.
public void setEvaluateTargetHealth(Boolean evaluateTargetHealth)
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:
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront
distribution.
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.
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.
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.
There are no special requirements for setting EvaluateTargetHealth to true when the
alias target is an S3 bucket.
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? in the Amazon Route 53 Developer Guide.
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, 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:
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront
distribution.
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.
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.
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.
There are no special requirements for setting EvaluateTargetHealth to true when
the alias target is an S3 bucket.
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? in the Amazon Route 53 Developer Guide.
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, 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:
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront
distribution.
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.
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.
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.
There are no special requirements for setting EvaluateTargetHealth to true when the
alias target is an S3 bucket.
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? in the Amazon Route 53 Developer Guide.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
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:
You can't set EvaluateTargetHealth to true when the alias target is a
CloudFront distribution.
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.
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.
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.
There are no special requirements for setting EvaluateTargetHealth to true when
the alias target is an S3 bucket.
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? in the Amazon Route 53 Developer Guide.
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, 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:
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront
distribution.
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.
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.
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.
There are no special requirements for setting EvaluateTargetHealth to true when the
alias target is an S3 bucket.
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? in the Amazon Route 53 Developer Guide.
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, 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:
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront
distribution.
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.
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.
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.
There are no special requirements for setting EvaluateTargetHealth to true when
the alias target is an S3 bucket.
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? in the Amazon Route 53 Developer Guide.
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, 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:
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront
distribution.
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.
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.
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.
There are no special requirements for setting EvaluateTargetHealth to true when the
alias target is an S3 bucket.
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? in the Amazon Route 53 Developer Guide.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
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:
You can't set EvaluateTargetHealth to true when the alias target is a
CloudFront distribution.
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.
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.
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.
There are no special requirements for setting EvaluateTargetHealth to true when
the alias target is an S3 bucket.
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? in the Amazon Route 53 Developer Guide.
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 ObjectObject.toString()public AliasTarget clone()