DomainNameConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigatewayv2.model.DomainNameConfiguration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DomainNameConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

The domain name configuration.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

DomainNameConfiguration()

Constructors
Constructor and Description
`DomainNameConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DomainNameConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApiGatewayDomainName()` A domain name for the API.
`String`	`getCertificateArn()` An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name.
`String`	`getCertificateName()` The user-friendly name of the certificate that will be used by the 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`	`getDomainNameStatus()` The status of the domain name migration.
`String`	`getDomainNameStatusMessage()` An optional text message containing detailed information about status of the domain name migration.
`String`	`getEndpointType()` The endpoint type.
`String`	`getHostedZoneId()` The Amazon Route 53 Hosted Zone ID of the endpoint.
`String`	`getOwnershipVerificationCertificateArn()` The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
`String`	`getSecurityPolicy()` The Transport Layer Security (TLS) version of the security policy for this domain name.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApiGatewayDomainName(String apiGatewayDomainName)` A domain name for the API.
`void`	`setCertificateArn(String certificateArn)` An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name.
`void`	`setCertificateName(String certificateName)` The user-friendly name of the certificate that will be used by the 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`	`setDomainNameStatus(String domainNameStatus)` The status of the domain name migration.
`void`	`setDomainNameStatusMessage(String domainNameStatusMessage)` An optional text message containing detailed information about status of the domain name migration.
`void`	`setEndpointType(String endpointType)` The endpoint type.
`void`	`setHostedZoneId(String hostedZoneId)` The Amazon Route 53 Hosted Zone ID of the endpoint.
`void`	`setOwnershipVerificationCertificateArn(String ownershipVerificationCertificateArn)` The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
`void`	`setSecurityPolicy(String securityPolicy)` The Transport Layer Security (TLS) version of the security policy for this domain name.
`String`	`toString()` Returns a string representation of this object.
`DomainNameConfiguration`	`withApiGatewayDomainName(String apiGatewayDomainName)` A domain name for the API.
`DomainNameConfiguration`	`withCertificateArn(String certificateArn)` An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name.
`DomainNameConfiguration`	`withCertificateName(String certificateName)` The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
`DomainNameConfiguration`	`withCertificateUploadDate(Date certificateUploadDate)` The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
`DomainNameConfiguration`	`withDomainNameStatus(DomainNameStatus domainNameStatus)` The status of the domain name migration.
`DomainNameConfiguration`	`withDomainNameStatus(String domainNameStatus)` The status of the domain name migration.
`DomainNameConfiguration`	`withDomainNameStatusMessage(String domainNameStatusMessage)` An optional text message containing detailed information about status of the domain name migration.
`DomainNameConfiguration`	`withEndpointType(EndpointType endpointType)` The endpoint type.
`DomainNameConfiguration`	`withEndpointType(String endpointType)` The endpoint type.
`DomainNameConfiguration`	`withHostedZoneId(String hostedZoneId)` The Amazon Route 53 Hosted Zone ID of the endpoint.
`DomainNameConfiguration`	`withOwnershipVerificationCertificateArn(String ownershipVerificationCertificateArn)` The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
`DomainNameConfiguration`	`withSecurityPolicy(SecurityPolicy securityPolicy)` The Transport Layer Security (TLS) version of the security policy for this domain name.
`DomainNameConfiguration`	`withSecurityPolicy(String securityPolicy)` The Transport Layer Security (TLS) version of the security policy for this domain name.

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

- Constructor Detail
  - DomainNameConfiguration
```
public DomainNameConfiguration()
```
- Method Detail
  - setApiGatewayDomainName
```
public void setApiGatewayDomainName(String apiGatewayDomainName)
```
    A domain name for the API.
    
    Parameters:
    
    apiGatewayDomainName - A domain name for the API.
  - getApiGatewayDomainName
```
public String getApiGatewayDomainName()
```
    A domain name for the API.
    
    Returns:
    
    A domain name for the API.
  - withApiGatewayDomainName
```
public DomainNameConfiguration withApiGatewayDomainName(String apiGatewayDomainName)
```
    A domain name for the API.
    
    Parameters:
    
    apiGatewayDomainName - A domain name for the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCertificateArn
```
public void setCertificateArn(String certificateArn)
```
    An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    
    Parameters:
    
    certificateArn - An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
  - getCertificateArn
```
public String getCertificateArn()
```
    An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    
    Returns:
    
    An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
  - withCertificateArn
```
public DomainNameConfiguration withCertificateArn(String certificateArn)
```
    An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    
    Parameters:
    
    certificateArn - An AWS-managed certificate that will be used by the 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.
  - setCertificateName
```
public void setCertificateName(String certificateName)
```
    The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
    
    Parameters:
    
    certificateName - The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
  - getCertificateName
```
public String getCertificateName()
```
    The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
    
    Returns:
    
    The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
  - withCertificateName
```
public DomainNameConfiguration withCertificateName(String certificateName)
```
    The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
    
    Parameters:
    
    certificateName - The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
    
    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 DomainNameConfiguration 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.
  - setDomainNameStatus
```
public void setDomainNameStatus(String domainNameStatus)
```
    The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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 domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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 domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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 domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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 DomainNameConfiguration withDomainNameStatus(String domainNameStatus)
```
    The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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 domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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 DomainNameConfiguration withDomainNameStatus(DomainNameStatus domainNameStatus)
```
    The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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 domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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 domain name migration.
    
    Parameters:
    
    domainNameStatusMessage - An optional text message containing detailed information about status of the domain name migration.
  - getDomainNameStatusMessage
```
public String getDomainNameStatusMessage()
```
    An optional text message containing detailed information about status of the domain name migration.
    
    Returns:
    
    An optional text message containing detailed information about status of the domain name migration.
  - withDomainNameStatusMessage
```
public DomainNameConfiguration withDomainNameStatusMessage(String domainNameStatusMessage)
```
    An optional text message containing detailed information about status of the domain name migration.
    
    Parameters:
    
    domainNameStatusMessage - An optional text message containing detailed information about status of the domain name migration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointType
```
public void setEndpointType(String endpointType)
```
    The endpoint type.
    
    Parameters:
    
    endpointType - The endpoint type.
    
    See Also:
    
    EndpointType
  - getEndpointType
```
public String getEndpointType()
```
    The endpoint type.
    
    Returns:
    
    The endpoint type.
    
    See Also:
    
    EndpointType
  - withEndpointType
```
public DomainNameConfiguration withEndpointType(String endpointType)
```
    The endpoint type.
    
    Parameters:
    
    endpointType - The endpoint type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointType
  - withEndpointType
```
public DomainNameConfiguration withEndpointType(EndpointType endpointType)
```
    The endpoint type.
    
    Parameters:
    
    endpointType - The endpoint type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointType
  - setHostedZoneId
```
public void setHostedZoneId(String hostedZoneId)
```
    The Amazon Route 53 Hosted Zone ID of the endpoint.
    
    Parameters:
    
    hostedZoneId - The Amazon Route 53 Hosted Zone ID of the endpoint.
  - getHostedZoneId
```
public String getHostedZoneId()
```
    The Amazon Route 53 Hosted Zone ID of the endpoint.
    
    Returns:
    
    The Amazon Route 53 Hosted Zone ID of the endpoint.
  - withHostedZoneId
```
public DomainNameConfiguration withHostedZoneId(String hostedZoneId)
```
    The Amazon Route 53 Hosted Zone ID of the endpoint.
    
    Parameters:
    
    hostedZoneId - The Amazon Route 53 Hosted Zone ID of the endpoint.
    
    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 of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
    
    Parameters:
    
    securityPolicy - The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
    
    See Also:
    
    SecurityPolicy
  - getSecurityPolicy
```
public String getSecurityPolicy()
```
    The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
    
    Returns:
    
    The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
    
    See Also:
    
    SecurityPolicy
  - withSecurityPolicy
```
public DomainNameConfiguration withSecurityPolicy(String securityPolicy)
```
    The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
    
    Parameters:
    
    securityPolicy - The Transport Layer Security (TLS) version of the security policy for this domain name. 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 DomainNameConfiguration withSecurityPolicy(SecurityPolicy securityPolicy)
```
    The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
    
    Parameters:
    
    securityPolicy - The Transport Layer Security (TLS) version of the security policy for this domain name. 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
  - 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 DomainNameConfiguration 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 DomainNameConfiguration 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.

AWS SDK for Java 1.x API Reference - 1.12.772

Class DomainNameConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DomainNameConfiguration

Method Detail

setApiGatewayDomainName

getApiGatewayDomainName

withApiGatewayDomainName

setCertificateArn

getCertificateArn

withCertificateArn

setCertificateName

getCertificateName

withCertificateName

setCertificateUploadDate

getCertificateUploadDate

withCertificateUploadDate

setDomainNameStatus

getDomainNameStatus

withDomainNameStatus

withDomainNameStatus

setDomainNameStatusMessage

getDomainNameStatusMessage

withDomainNameStatusMessage

setEndpointType

getEndpointType

withEndpointType

withEndpointType

setHostedZoneId

getHostedZoneId

withHostedZoneId

setSecurityPolicy

getSecurityPolicy

withSecurityPolicy

withSecurityPolicy

setOwnershipVerificationCertificateArn

getOwnershipVerificationCertificateArn

withOwnershipVerificationCertificateArn

toString

equals

hashCode

clone

marshall