Package software.amazon.awssdk.services.apigatewayv2.model

Interface DomainNameConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DomainNameConfiguration.Builder,DomainNameConfiguration>, SdkBuilder<DomainNameConfiguration.Builder,DomainNameConfiguration>, SdkPojo
Enclosing class:
DomainNameConfiguration
public static interface DomainNameConfiguration.Builder extends SdkPojo, CopyableBuilder<DomainNameConfiguration.Builder,DomainNameConfiguration>

  • Method Details

    • apiGatewayDomainName

      DomainNameConfiguration.Builder apiGatewayDomainName(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.

    • certificateArn

      DomainNameConfiguration.Builder certificateArn(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.

    • certificateName

      DomainNameConfiguration.Builder certificateName(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.

    • certificateUploadDate

      DomainNameConfiguration.Builder certificateUploadDate(Instant 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.

    • domainNameStatus

      DomainNameConfiguration.Builder domainNameStatus(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

      DomainNameConfiguration.Builder domainNameStatus(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:

    • domainNameStatusMessage

      DomainNameConfiguration.Builder domainNameStatusMessage(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.

    • endpointType

      DomainNameConfiguration.Builder endpointType(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

      DomainNameConfiguration.Builder endpointType(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:

    • hostedZoneId

      DomainNameConfiguration.Builder hostedZoneId(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.

    • securityPolicy

      DomainNameConfiguration.Builder securityPolicy(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

      DomainNameConfiguration.Builder securityPolicy(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:

    • ownershipVerificationCertificateArn

      DomainNameConfiguration.Builder ownershipVerificationCertificateArn(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.