DomainName (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.DomainName

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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).

When you deploy an API, Amazon 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

DomainName()

Constructors
Constructor and Description
`DomainName()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DomainName`	`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`	`getDomainName()` The name of the DomainName resource.
`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.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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`	`setDomainName(String domainName)` The name of the DomainName resource.
`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.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DomainName`	`withCertificateArn(String certificateArn)` The reference to an AWS-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`	`withDomainName(String domainName)` The name of the DomainName resource.
`DomainName`	`withEndpointConfiguration(EndpointConfiguration endpointConfiguration)` The endpoint configuration of this DomainName showing the endpoint types of the domain name.
`DomainName`	`withRegionalCertificateArn(String regionalCertificateArn)` The reference to an AWS-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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DomainName
```
public DomainName()
```
- Method Detail
  - setDomainName
```
public void setDomainName(String domainName)
```
    The name of the DomainName resource.
    
    Parameters:
    
    domainName - The name of the DomainName resource.
  - getDomainName
```
public String getDomainName()
```
    The name of the DomainName resource.
    
    Returns:
    
    The name of the DomainName resource.
  - withDomainName
```
public DomainName withDomainName(String domainName)
```
    The name of the DomainName resource.
    
    Parameters:
    
    domainName - The name of the DomainName resource.
    
    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 DomainName 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 DomainName 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 DomainName 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 Amazon 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 Amazon 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 Amazon 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 Amazon API Gateway when you create a regional endpoint.
  - withRegionalDomainName
```
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 Amazon 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 Amazon API Gateway when you create a regional endpoint.
    
    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 DomainName 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 DomainName 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 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.
    
    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.
  - 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 DomainName 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 DomainName clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DomainName

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DomainName

Method Detail

setDomainName

getDomainName

withDomainName

setCertificateName

getCertificateName

withCertificateName

setCertificateArn

getCertificateArn

withCertificateArn

setCertificateUploadDate

getCertificateUploadDate

withCertificateUploadDate

setRegionalDomainName

getRegionalDomainName

withRegionalDomainName

setRegionalCertificateName

getRegionalCertificateName

withRegionalCertificateName

setRegionalCertificateArn

getRegionalCertificateArn

withRegionalCertificateArn

setDistributionDomainName

getDistributionDomainName

withDistributionDomainName

setEndpointConfiguration

getEndpointConfiguration

withEndpointConfiguration

toString

equals

hashCode

clone

marshall