com.amazonaws.services.apigateway.model

Class UpdateDomainNameResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.apigateway.model.UpdateDomainNameResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateDomainNameResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Represents a custom domain name as a user-friendly host name of an API (RestApi).

When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.

Set a Custom Host Name for an API

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateDomainNameResult()

Method Summary

Modifier and Type	Method and Description
UpdateDomainNameResult	clone()
boolean	equals(Object obj)
String	getCertificateArn() The reference to an AWS-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.
EndpointConfiguration	getEndpointConfiguration() The endpoint configuration of this DomainName showing the endpoint types of the domain name.
String	getRegionalCertificateArn() The reference to an AWS-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.
int	hashCode()
void	setCertificateArn(String certificateArn) The reference to an AWS-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	setEndpointConfiguration(EndpointConfiguration endpointConfiguration) The endpoint configuration of this DomainName showing the endpoint types of the domain name.
void	setRegionalCertificateArn(String regionalCertificateArn) The reference to an AWS-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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateDomainNameResult	withCertificateArn(String certificateArn) The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name.
UpdateDomainNameResult	withCertificateName(String certificateName) The name of the certificate that will be used by edge-optimized endpoint for this domain name.
UpdateDomainNameResult	withCertificateUploadDate(Date certificateUploadDate) The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
UpdateDomainNameResult	withDistributionDomainName(String distributionDomainName) The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint.
UpdateDomainNameResult	withDistributionHostedZoneId(String distributionHostedZoneId) The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
UpdateDomainNameResult	withDomainName(String domainName) The custom domain name as an API host name, for example, my-api.example.com.
UpdateDomainNameResult	withEndpointConfiguration(EndpointConfiguration endpointConfiguration) The endpoint configuration of this DomainName showing the endpoint types of the domain name.
UpdateDomainNameResult	withRegionalCertificateArn(String regionalCertificateArn) The reference to an AWS-managed certificate that will be used for validating the regional domain name.
UpdateDomainNameResult	withRegionalCertificateName(String regionalCertificateName) The name of the certificate that will be used for validating the regional domain name.
UpdateDomainNameResult	withRegionalDomainName(String regionalDomainName) The domain name associated with the regional endpoint for this custom domain name.
UpdateDomainNameResult	withRegionalHostedZoneId(String regionalHostedZoneId) The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateDomainNameResult

public UpdateDomainNameResult()

Method Detail

setDomainName

public void setDomainName(String domainName)

The custom domain name as an API host name, for example, my-api.example.com.

Parameters:

domainName - The custom domain name as an API host name, for example, my-api.example.com.

getDomainName

public String getDomainName()

The custom domain name as an API host name, for example, my-api.example.com.

Returns:

The custom domain name as an API host name, for example, my-api.example.com.

withDomainName

public UpdateDomainNameResult withDomainName(String domainName)

The custom domain name as an API host name, for example, my-api.example.com.

Parameters:

domainName - The custom domain name as an API host name, for example, my-api.example.com.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCertificateName

public void setCertificateName(String certificateName)

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Parameters:

certificateName - The name of the certificate that will be used by edge-optimized endpoint for this domain name.

getCertificateName

public String getCertificateName()

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Returns:

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

withCertificateName

public UpdateDomainNameResult withCertificateName(String certificateName)

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Parameters:

certificateName - The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCertificateArn

public void setCertificateArn(String certificateArn)

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Parameters:

certificateArn - The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

getCertificateArn

public String getCertificateArn()

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Returns:

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

withCertificateArn

public UpdateDomainNameResult withCertificateArn(String certificateArn)

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Parameters:

certificateArn - The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCertificateUploadDate

public void setCertificateUploadDate(Date certificateUploadDate)

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Parameters:

certificateUploadDate - The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

getCertificateUploadDate

public Date getCertificateUploadDate()

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Returns:

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

withCertificateUploadDate

public UpdateDomainNameResult withCertificateUploadDate(Date certificateUploadDate)

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Parameters:

certificateUploadDate - The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRegionalDomainName

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.

Parameters:

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.

getRegionalDomainName

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.

Returns:

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.

withRegionalDomainName

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRegionalHostedZoneId

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.

Parameters:

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.

getRegionalHostedZoneId

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.

Returns:

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.

withRegionalHostedZoneId

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRegionalCertificateName

public void setRegionalCertificateName(String regionalCertificateName)

The name of the certificate that will be used for validating the regional domain name.

Parameters:

regionalCertificateName - The name of the certificate that will be used for validating the regional domain name.

getRegionalCertificateName

public String getRegionalCertificateName()

The name of the certificate that will be used for validating the regional domain name.

Returns:

The name of the certificate that will be used for validating the regional domain name.

withRegionalCertificateName

public UpdateDomainNameResult withRegionalCertificateName(String regionalCertificateName)

The name of the certificate that will be used for validating the regional domain name.

Parameters:

regionalCertificateName - The name of the certificate that will be used for validating the regional domain name.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRegionalCertificateArn

public void setRegionalCertificateArn(String regionalCertificateArn)

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Parameters:

regionalCertificateArn - The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

getRegionalCertificateArn

public String getRegionalCertificateArn()

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Returns:

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

withRegionalCertificateArn

public UpdateDomainNameResult withRegionalCertificateArn(String regionalCertificateArn)

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Parameters:

regionalCertificateArn - The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDistributionDomainName

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.

Parameters:

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.

getDistributionDomainName

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.

Returns:

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.

withDistributionDomainName

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDistributionHostedZoneId

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.

Parameters:

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.

getDistributionHostedZoneId

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.

Returns:

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.

withDistributionHostedZoneId

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndpointConfiguration

public void setEndpointConfiguration(EndpointConfiguration endpointConfiguration)

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Parameters:

endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.

getEndpointConfiguration

public EndpointConfiguration getEndpointConfiguration()

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Returns:

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

withEndpointConfiguration

public UpdateDomainNameResult withEndpointConfiguration(EndpointConfiguration endpointConfiguration)

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Parameters:

endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateDomainNameResult clone()

Overrides:

clone in class Object