GetDomainNameResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.apigateway.model.GetDomainNameResult

All Implemented Interfaces:: Serializable, Cloneable

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

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

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetDomainNameResult()

Constructors
Constructor and Description
`GetDomainNameResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetDomainNameResult`	`addTagsEntry(String key, String value)` Add a single Tags entry
`GetDomainNameResult`	`clearTagsEntries()` Removes all the entries added into Tags.
`GetDomainNameResult`	`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`.
`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 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.
`String`	`getSecurityPolicy()` The Transport Layer Security (TLS) version + cipher suite for this DomainName.
`Map<String,String>`	`getTags()` The collection of tags.
`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`	`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 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.
`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.
`GetDomainNameResult`	`withCertificateArn(String certificateArn)` The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name.
`GetDomainNameResult`	`withCertificateName(String certificateName)` The name of the certificate that will be used by edge-optimized endpoint for this domain name.
`GetDomainNameResult`	`withCertificateUploadDate(Date certificateUploadDate)` The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
`GetDomainNameResult`	`withDistributionDomainName(String distributionDomainName)` The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint.
`GetDomainNameResult`	`withDistributionHostedZoneId(String distributionHostedZoneId)` The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
`GetDomainNameResult`	`withDomainName(String domainName)` The custom domain name as an API host name, for example, `my-api.example.com`.
`GetDomainNameResult`	`withDomainNameStatus(DomainNameStatus domainNameStatus)` The status of the DomainName migration.
`GetDomainNameResult`	`withDomainNameStatus(String domainNameStatus)` The status of the DomainName migration.
`GetDomainNameResult`	`withDomainNameStatusMessage(String domainNameStatusMessage)` An optional text message containing detailed information about status of the DomainName migration.
`GetDomainNameResult`	`withEndpointConfiguration(EndpointConfiguration endpointConfiguration)` The endpoint configuration of this DomainName showing the endpoint types of the domain name.
`GetDomainNameResult`	`withMutualTlsAuthentication(MutualTlsAuthentication mutualTlsAuthentication)` The mutual TLS authentication configuration for a custom domain name.
`GetDomainNameResult`	`withOwnershipVerificationCertificateArn(String ownershipVerificationCertificateArn)` The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
`GetDomainNameResult`	`withRegionalCertificateArn(String regionalCertificateArn)` The reference to an AWS-managed certificate that will be used for validating the regional domain name.
`GetDomainNameResult`	`withRegionalCertificateName(String regionalCertificateName)` The name of the certificate that will be used for validating the regional domain name.
`GetDomainNameResult`	`withRegionalDomainName(String regionalDomainName)` The domain name associated with the regional endpoint for this custom domain name.
`GetDomainNameResult`	`withRegionalHostedZoneId(String regionalHostedZoneId)` The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
`GetDomainNameResult`	`withSecurityPolicy(SecurityPolicy securityPolicy)` The Transport Layer Security (TLS) version + cipher suite for this DomainName.
`GetDomainNameResult`	`withSecurityPolicy(String securityPolicy)` The Transport Layer Security (TLS) version + cipher suite for this DomainName.
`GetDomainNameResult`	`withTags(Map<String,String> tags)` The collection of tags.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - GetDomainNameResult
```
public GetDomainNameResult()
```
- 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 GetDomainNameResult 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 GetDomainNameResult 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 GetDomainNameResult 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 GetDomainNameResult 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 GetDomainNameResult 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 GetDomainNameResult 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 GetDomainNameResult 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 GetDomainNameResult 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 GetDomainNameResult 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 GetDomainNameResult 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 GetDomainNameResult 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.
  - setDomainNameStatus
```
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.
    
    Parameters:
    
    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.
    
    See Also:
    
    DomainNameStatus
  - getDomainNameStatus
```
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.
    
    Returns:
    
    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.
    
    See Also:
    
    DomainNameStatus
  - withDomainNameStatus
```
public GetDomainNameResult 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DomainNameStatus
  - withDomainNameStatus
```
public GetDomainNameResult 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DomainNameStatus
  - setDomainNameStatusMessage
```
public void setDomainNameStatusMessage(String domainNameStatusMessage)
```
    An optional text message containing detailed information about status of the DomainName migration.
    
    Parameters:
    
    domainNameStatusMessage - An optional text message containing detailed information about status of the DomainName migration.
  - getDomainNameStatusMessage
```
public String getDomainNameStatusMessage()
```
    An optional text message containing detailed information about status of the DomainName migration.
    
    Returns:
    
    An optional text message containing detailed information about status of the DomainName migration.
  - withDomainNameStatusMessage
```
public GetDomainNameResult withDomainNameStatusMessage(String domainNameStatusMessage)
```
    An optional text message containing detailed information about status of the DomainName migration.
    
    Parameters:
    
    domainNameStatusMessage - An optional text message containing detailed information about status of the DomainName migration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecurityPolicy
```
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.
    
    Parameters:
    
    securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
    
    See Also:
    
    SecurityPolicy
  - getSecurityPolicy
```
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.
    
    Returns:
    
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
    
    See Also:
    
    SecurityPolicy
  - withSecurityPolicy
```
public GetDomainNameResult 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.
    
    Parameters:
    
    securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityPolicy
  - withSecurityPolicy
```
public GetDomainNameResult 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.
    
    Parameters:
    
    securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityPolicy
  - getTags
```
public Map<String,String> getTags()
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Returns:
    
    The collection of tags. Each tag element is associated with a given resource.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Parameters:
    
    tags - The collection of tags. Each tag element is associated with a given resource.
  - withTags
```
public GetDomainNameResult withTags(Map<String,String> tags)
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Parameters:
    
    tags - The collection of tags. Each tag element is associated with a given resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public GetDomainNameResult addTagsEntry(String key,
                                        String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public GetDomainNameResult clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMutualTlsAuthentication
```
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.
    
    Parameters:
    
    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.
  - getMutualTlsAuthentication
```
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.
    
    Returns:
    
    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.
  - withMutualTlsAuthentication
```
public GetDomainNameResult 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwnershipVerificationCertificateArn
```
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.
    
    Parameters:
    
    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.
  - getOwnershipVerificationCertificateArn
```
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.
    
    Returns:
    
    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.
  - withOwnershipVerificationCertificateArn
```
public GetDomainNameResult 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.
    
    Parameters:
    
    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.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 GetDomainNameResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GetDomainNameResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetDomainNameResult

Method Detail

setDomainName

getDomainName

withDomainName

setCertificateName

getCertificateName

withCertificateName

setCertificateArn

getCertificateArn

withCertificateArn

setCertificateUploadDate

getCertificateUploadDate

withCertificateUploadDate

setRegionalDomainName

getRegionalDomainName

withRegionalDomainName

setRegionalHostedZoneId

getRegionalHostedZoneId

withRegionalHostedZoneId

setRegionalCertificateName

getRegionalCertificateName

withRegionalCertificateName

setRegionalCertificateArn

getRegionalCertificateArn

withRegionalCertificateArn

setDistributionDomainName

getDistributionDomainName

withDistributionDomainName

setDistributionHostedZoneId

getDistributionHostedZoneId

withDistributionHostedZoneId

setEndpointConfiguration

getEndpointConfiguration

withEndpointConfiguration

setDomainNameStatus

getDomainNameStatus

withDomainNameStatus

withDomainNameStatus

setDomainNameStatusMessage

getDomainNameStatusMessage

withDomainNameStatusMessage

setSecurityPolicy

getSecurityPolicy

withSecurityPolicy

withSecurityPolicy

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setMutualTlsAuthentication

getMutualTlsAuthentication

withMutualTlsAuthentication

setOwnershipVerificationCertificateArn

getOwnershipVerificationCertificateArn

withOwnershipVerificationCertificateArn

toString

equals

hashCode

clone