class Aws::ApiGatewayV2::Types::DomainNameConfiguration

The domain name configuration.

@note When making an API call, you may pass DomainNameConfiguration

data as a hash:

    {
      api_gateway_domain_name: "__string",
      certificate_arn: "Arn",
      certificate_name: "StringWithLengthBetween1And128",
      certificate_upload_date: Time.now,
      domain_name_status: "AVAILABLE", # accepts AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, PENDING_OWNERSHIP_VERIFICATION
      domain_name_status_message: "__string",
      endpoint_type: "REGIONAL", # accepts REGIONAL, EDGE
      hosted_zone_id: "__string",
      security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
      ownership_verification_certificate_arn: "Arn",
    }

@!attribute [rw] api_gateway_domain_name

A domain name for the API.
@return [String]

@!attribute [rw] certificate_arn

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.
@return [String]

@!attribute [rw] certificate_name

The user-friendly name of the certificate that will be used by the
edge-optimized endpoint for this domain name.
@return [String]

@!attribute [rw] certificate_upload_date

The timestamp when the certificate that was used by edge-optimized
endpoint for this domain name was uploaded.
@return [Time]

@!attribute [rw] domain_name_status

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.
@return [String]

@!attribute [rw] domain_name_status_message

An optional text message containing detailed information about
status of the domain name migration.
@return [String]

@!attribute [rw] endpoint_type

The endpoint type.
@return [String]

@!attribute [rw] hosted_zone_id

The Amazon Route 53 Hosted Zone ID of the endpoint.
@return [String]

@!attribute [rw] security_policy

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.
@return [String]

@!attribute [rw] ownership_verification_certificate_arn

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
@return [String]

Constants

SENSITIVE