@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DomainName extends Object implements Serializable, Cloneable, StructuredPojo
Represents a custom domain name as a user-friendly host name of an API (RestApi).
Constructor and Description |
---|
DomainName() |
Modifier and Type | Method and Description |
---|---|
DomainName |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
DomainName |
clearTagsEntries()
Removes all the entries added into Tags.
|
DomainName |
clone() |
boolean |
equals(Object obj) |
String |
getCertificateArn()
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this
domain name.
|
String |
getCertificateName()
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
|
Date |
getCertificateUploadDate()
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
|
String |
getDistributionDomainName()
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an
edge-optimized endpoint.
|
String |
getDistributionHostedZoneId()
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
|
String |
getDomainName()
The custom domain name as an API host name, for example,
my-api.example.com . |
String |
getDomainNameStatus()
The status of the DomainName migration.
|
String |
getDomainNameStatusMessage()
An optional text message containing detailed information about status of the DomainName migration.
|
EndpointConfiguration |
getEndpointConfiguration()
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
|
MutualTlsAuthentication |
getMutualTlsAuthentication()
The mutual TLS authentication configuration for a custom domain name.
|
String |
getOwnershipVerificationCertificateArn()
The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
|
String |
getRegionalCertificateArn()
The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain
name.
|
String |
getRegionalCertificateName()
The name of the certificate that will be used for validating the regional domain name.
|
String |
getRegionalDomainName()
The domain name associated with the regional endpoint for this custom domain name.
|
String |
getRegionalHostedZoneId()
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
|
String |
getSecurityPolicy()
The Transport Layer Security (TLS) version + cipher suite for this DomainName.
|
Map<String,String> |
getTags()
The collection of tags.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCertificateArn(String certificateArn)
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this
domain name.
|
void |
setCertificateName(String certificateName)
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
|
void |
setCertificateUploadDate(Date certificateUploadDate)
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
|
void |
setDistributionDomainName(String distributionDomainName)
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an
edge-optimized endpoint.
|
void |
setDistributionHostedZoneId(String distributionHostedZoneId)
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
|
void |
setDomainName(String domainName)
The custom domain name as an API host name, for example,
my-api.example.com . |
void |
setDomainNameStatus(String domainNameStatus)
The status of the DomainName migration.
|
void |
setDomainNameStatusMessage(String domainNameStatusMessage)
An optional text message containing detailed information about status of the DomainName migration.
|
void |
setEndpointConfiguration(EndpointConfiguration endpointConfiguration)
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
|
void |
setMutualTlsAuthentication(MutualTlsAuthentication mutualTlsAuthentication)
The mutual TLS authentication configuration for a custom domain name.
|
void |
setOwnershipVerificationCertificateArn(String ownershipVerificationCertificateArn)
The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
|
void |
setRegionalCertificateArn(String regionalCertificateArn)
The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain
name.
|
void |
setRegionalCertificateName(String regionalCertificateName)
The name of the certificate that will be used for validating the regional domain name.
|
void |
setRegionalDomainName(String regionalDomainName)
The domain name associated with the regional endpoint for this custom domain name.
|
void |
setRegionalHostedZoneId(String regionalHostedZoneId)
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
|
void |
setSecurityPolicy(String securityPolicy)
The Transport Layer Security (TLS) version + cipher suite for this DomainName.
|
void |
setTags(Map<String,String> tags)
The collection of tags.
|
String |
toString()
Returns a string representation of this object.
|
DomainName |
withCertificateArn(String certificateArn)
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this
domain name.
|
DomainName |
withCertificateName(String certificateName)
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
|
DomainName |
withCertificateUploadDate(Date certificateUploadDate)
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
|
DomainName |
withDistributionDomainName(String distributionDomainName)
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an
edge-optimized endpoint.
|
DomainName |
withDistributionHostedZoneId(String distributionHostedZoneId)
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
|
DomainName |
withDomainName(String domainName)
The custom domain name as an API host name, for example,
my-api.example.com . |
DomainName |
withDomainNameStatus(DomainNameStatus domainNameStatus)
The status of the DomainName migration.
|
DomainName |
withDomainNameStatus(String domainNameStatus)
The status of the DomainName migration.
|
DomainName |
withDomainNameStatusMessage(String domainNameStatusMessage)
An optional text message containing detailed information about status of the DomainName migration.
|
DomainName |
withEndpointConfiguration(EndpointConfiguration endpointConfiguration)
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
|
DomainName |
withMutualTlsAuthentication(MutualTlsAuthentication mutualTlsAuthentication)
The mutual TLS authentication configuration for a custom domain name.
|
DomainName |
withOwnershipVerificationCertificateArn(String ownershipVerificationCertificateArn)
The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
|
DomainName |
withRegionalCertificateArn(String regionalCertificateArn)
The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain
name.
|
DomainName |
withRegionalCertificateName(String regionalCertificateName)
The name of the certificate that will be used for validating the regional domain name.
|
DomainName |
withRegionalDomainName(String regionalDomainName)
The domain name associated with the regional endpoint for this custom domain name.
|
DomainName |
withRegionalHostedZoneId(String regionalHostedZoneId)
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
|
DomainName |
withSecurityPolicy(SecurityPolicy securityPolicy)
The Transport Layer Security (TLS) version + cipher suite for this DomainName.
|
DomainName |
withSecurityPolicy(String securityPolicy)
The Transport Layer Security (TLS) version + cipher suite for this DomainName.
|
DomainName |
withTags(Map<String,String> tags)
The collection of tags.
|
public void setDomainName(String domainName)
The custom domain name as an API host name, for example, my-api.example.com
.
domainName
- The custom domain name as an API host name, for example, my-api.example.com
.public String getDomainName()
The custom domain name as an API host name, for example, my-api.example.com
.
my-api.example.com
.public DomainName withDomainName(String domainName)
The custom domain name as an API host name, for example, my-api.example.com
.
domainName
- The custom domain name as an API host name, for example, my-api.example.com
.public void setCertificateName(String certificateName)
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
certificateName
- The name of the certificate that will be used by edge-optimized endpoint for this domain name.public String getCertificateName()
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
public DomainName withCertificateName(String certificateName)
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
certificateName
- The name of the certificate that will be used by edge-optimized endpoint for this domain name.public void setCertificateArn(String certificateArn)
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.
certificateArn
- The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint
for this domain name. Certificate Manager is the only supported source.public String getCertificateArn()
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.
public DomainName withCertificateArn(String certificateArn)
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.
certificateArn
- The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint
for this domain name. Certificate Manager is the only supported source.public void setCertificateUploadDate(Date certificateUploadDate)
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
certificateUploadDate
- The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was
uploaded.public Date getCertificateUploadDate()
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
public DomainName withCertificateUploadDate(Date certificateUploadDate)
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
certificateUploadDate
- The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was
uploaded.public void setRegionalDomainName(String regionalDomainName)
The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
regionalDomainName
- The domain name associated with the regional endpoint for this custom domain name. You set up this
association by adding a DNS record that points the custom domain name to this regional domain name. The
regional domain name is returned by API Gateway when you create a regional endpoint.public String getRegionalDomainName()
The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
public DomainName withRegionalDomainName(String regionalDomainName)
The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
regionalDomainName
- The domain name associated with the regional endpoint for this custom domain name. You set up this
association by adding a DNS record that points the custom domain name to this regional domain name. The
regional domain name is returned by API Gateway when you create a regional endpoint.public void setRegionalHostedZoneId(String regionalHostedZoneId)
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
regionalHostedZoneId
- The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set
up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.public String getRegionalHostedZoneId()
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
public DomainName withRegionalHostedZoneId(String regionalHostedZoneId)
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
regionalHostedZoneId
- The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set
up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.public void setRegionalCertificateName(String regionalCertificateName)
The name of the certificate that will be used for validating the regional domain name.
regionalCertificateName
- The name of the certificate that will be used for validating the regional domain name.public String getRegionalCertificateName()
The name of the certificate that will be used for validating the regional domain name.
public DomainName withRegionalCertificateName(String regionalCertificateName)
The name of the certificate that will be used for validating the regional domain name.
regionalCertificateName
- The name of the certificate that will be used for validating the regional domain name.public void setRegionalCertificateArn(String regionalCertificateArn)
The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
regionalCertificateArn
- The reference to an Amazon Web Services-managed certificate that will be used for validating the regional
domain name. Certificate Manager is the only supported source.public String getRegionalCertificateArn()
The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
public DomainName withRegionalCertificateArn(String regionalCertificateArn)
The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
regionalCertificateArn
- The reference to an Amazon Web Services-managed certificate that will be used for validating the regional
domain name. Certificate Manager is the only supported source.public void setDistributionDomainName(String distributionDomainName)
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
distributionDomainName
- The domain name of the Amazon CloudFront distribution associated with this custom domain name for an
edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain
name to this distribution name. For more information about CloudFront distributions, see the Amazon
CloudFront documentation.public String getDistributionDomainName()
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
public DomainName withDistributionDomainName(String distributionDomainName)
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
distributionDomainName
- The domain name of the Amazon CloudFront distribution associated with this custom domain name for an
edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain
name to this distribution name. For more information about CloudFront distributions, see the Amazon
CloudFront documentation.public void setDistributionHostedZoneId(String distributionHostedZoneId)
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain Name
and AWS Regions and Endpoints for API Gateway.
distributionHostedZoneId
- The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain
Name and AWS Regions and Endpoints for API Gateway.public String getDistributionHostedZoneId()
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain Name
and AWS Regions and Endpoints for API Gateway.
Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom
Domain Name and AWS Regions and Endpoints for API Gateway.public DomainName withDistributionHostedZoneId(String distributionHostedZoneId)
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain Name
and AWS Regions and Endpoints for API Gateway.
distributionHostedZoneId
- The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain
Name and AWS Regions and Endpoints for API Gateway.public void setEndpointConfiguration(EndpointConfiguration endpointConfiguration)
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
endpointConfiguration
- The endpoint configuration of this DomainName showing the endpoint types of the domain name.public EndpointConfiguration getEndpointConfiguration()
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
public DomainName withEndpointConfiguration(EndpointConfiguration endpointConfiguration)
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
endpointConfiguration
- The endpoint configuration of this DomainName showing the endpoint types of the domain name.public void setDomainNameStatus(String domainNameStatus)
The status of the DomainName migration. The valid values are AVAILABLE
and UPDATING
. If
the status is UPDATING
, the domain cannot be modified further until the existing operation is
complete. If it is AVAILABLE
, the domain can be updated.
domainNameStatus
- The status of the DomainName migration. The valid values are AVAILABLE
and
UPDATING
. If the status is UPDATING
, the domain cannot be modified further until
the existing operation is complete. If it is AVAILABLE
, the domain can be updated.DomainNameStatus
public String getDomainNameStatus()
The status of the DomainName migration. The valid values are AVAILABLE
and UPDATING
. If
the status is UPDATING
, the domain cannot be modified further until the existing operation is
complete. If it is AVAILABLE
, the domain can be updated.
AVAILABLE
and
UPDATING
. If the status is UPDATING
, the domain cannot be modified further
until the existing operation is complete. If it is AVAILABLE
, the domain can be updated.DomainNameStatus
public DomainName withDomainNameStatus(String domainNameStatus)
The status of the DomainName migration. The valid values are AVAILABLE
and UPDATING
. If
the status is UPDATING
, the domain cannot be modified further until the existing operation is
complete. If it is AVAILABLE
, the domain can be updated.
domainNameStatus
- The status of the DomainName migration. The valid values are AVAILABLE
and
UPDATING
. If the status is UPDATING
, the domain cannot be modified further until
the existing operation is complete. If it is AVAILABLE
, the domain can be updated.DomainNameStatus
public DomainName withDomainNameStatus(DomainNameStatus domainNameStatus)
The status of the DomainName migration. The valid values are AVAILABLE
and UPDATING
. If
the status is UPDATING
, the domain cannot be modified further until the existing operation is
complete. If it is AVAILABLE
, the domain can be updated.
domainNameStatus
- The status of the DomainName migration. The valid values are AVAILABLE
and
UPDATING
. If the status is UPDATING
, the domain cannot be modified further until
the existing operation is complete. If it is AVAILABLE
, the domain can be updated.DomainNameStatus
public void setDomainNameStatusMessage(String domainNameStatusMessage)
An optional text message containing detailed information about status of the DomainName migration.
domainNameStatusMessage
- An optional text message containing detailed information about status of the DomainName migration.public String getDomainNameStatusMessage()
An optional text message containing detailed information about status of the DomainName migration.
public DomainName withDomainNameStatusMessage(String domainNameStatusMessage)
An optional text message containing detailed information about status of the DomainName migration.
domainNameStatusMessage
- An optional text message containing detailed information about status of the DomainName migration.public void setSecurityPolicy(String securityPolicy)
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
and TLS_1_2
.
securityPolicy
- The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
and TLS_1_2
.SecurityPolicy
public String getSecurityPolicy()
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
and TLS_1_2
.
TLS_1_0
and TLS_1_2
.SecurityPolicy
public DomainName withSecurityPolicy(String securityPolicy)
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
and TLS_1_2
.
securityPolicy
- The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
and TLS_1_2
.SecurityPolicy
public DomainName withSecurityPolicy(SecurityPolicy securityPolicy)
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
and TLS_1_2
.
securityPolicy
- The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
and TLS_1_2
.SecurityPolicy
public Map<String,String> getTags()
The collection of tags. Each tag element is associated with a given resource.
public void setTags(Map<String,String> tags)
The collection of tags. Each tag element is associated with a given resource.
tags
- The collection of tags. Each tag element is associated with a given resource.public DomainName withTags(Map<String,String> tags)
The collection of tags. Each tag element is associated with a given resource.
tags
- The collection of tags. Each tag element is associated with a given resource.public DomainName addTagsEntry(String key, String value)
public DomainName clearTagsEntries()
public void setMutualTlsAuthentication(MutualTlsAuthentication mutualTlsAuthentication)
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
mutualTlsAuthentication
- The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs
two-way authentication between the client and the server. Clients must present a trusted certificate to
access your API.public MutualTlsAuthentication getMutualTlsAuthentication()
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
public DomainName withMutualTlsAuthentication(MutualTlsAuthentication mutualTlsAuthentication)
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
mutualTlsAuthentication
- The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs
two-way authentication between the client and the server. Clients must present a trusted certificate to
access your API.public void setOwnershipVerificationCertificateArn(String ownershipVerificationCertificateArn)
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
ownershipVerificationCertificateArn
- The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required
when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the
regionalCertificateArn.public String getOwnershipVerificationCertificateArn()
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
public DomainName withOwnershipVerificationCertificateArn(String ownershipVerificationCertificateArn)
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
ownershipVerificationCertificateArn
- The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required
when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the
regionalCertificateArn.public String toString()
toString
in class Object
Object.toString()
public DomainName clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.