Class: Aws::ApiGatewayV2::Types::DomainNameConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::ApiGatewayV2::Types::DomainNameConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-apigatewayv2/types.rb

Overview

The domain name configuration.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #api_gateway_domain_name ⇒ String

  A domain name for the API.

• #certificate_arn ⇒ String

  An Amazon Web Services-managed certificate that will be used by the edge-optimized endpoint for this domain name.

• #certificate_name ⇒ String

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

• #certificate_upload_date ⇒ Time

  The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

• #domain_name_status ⇒ String

  Identifies the status of a domain name migration.

• #domain_name_status_message ⇒ String

  An optional text message containing detailed information about status of the domain name migration.

• #endpoint_type ⇒ String

  The endpoint type.

• #hosted_zone_id ⇒ String

  The Amazon Route 53 Hosted Zone ID of the endpoint.

• #ip_address_type ⇒ String

  The IP address types that can invoke the domain name.

• #ownership_verification_certificate_arn ⇒ String

  The Amazon resource name (ARN) for the public certificate issued by Certificate Manager.

• #security_policy ⇒ String

  The Transport Layer Security (TLS) version of the security policy for this domain name.

Instance Attribute Details

#api_gateway_domain_name ⇒ String

A domain name for the API.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 4055

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :domain_name_status,
  :domain_name_status_message,
  :endpoint_type,
  :hosted_zone_id,
  :ip_address_type,
  :security_policy,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_arn ⇒ String

An Amazon Web Services-managed certificate that will be used by the edge-optimized endpoint for this domain name. Amazon Web Services Certificate Manager is the only supported source.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 4055

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :domain_name_status,
  :domain_name_status_message,
  :endpoint_type,
  :hosted_zone_id,
  :ip_address_type,
  :security_policy,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 4055

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :domain_name_status,
  :domain_name_status_message,
  :endpoint_type,
  :hosted_zone_id,
  :ip_address_type,
  :security_policy,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_upload_date ⇒ Time

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Returns:

• (Time)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 4055

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :domain_name_status,
  :domain_name_status_message,
  :endpoint_type,
  :hosted_zone_id,
  :ip_address_type,
  :security_policy,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name_status ⇒ String

Identifies the status of a domain name migration. Statuses can have a value of AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, or PENDING_OWNERSHIP VERIFICATION. A domain can be modified if its status is AVAILABLE. If the domain’s status is UPDATING, you must wait until the current operation is complete.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 4055

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :domain_name_status,
  :domain_name_status_message,
  :endpoint_type,
  :hosted_zone_id,
  :ip_address_type,
  :security_policy,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name_status_message ⇒ String

An optional text message containing detailed information about status of the domain name migration.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 4055

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :domain_name_status,
  :domain_name_status_message,
  :endpoint_type,
  :hosted_zone_id,
  :ip_address_type,
  :security_policy,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_type ⇒ String

The endpoint type.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 4055

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :domain_name_status,
  :domain_name_status_message,
  :endpoint_type,
  :hosted_zone_id,
  :ip_address_type,
  :security_policy,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#hosted_zone_id ⇒ String

The Amazon Route 53 Hosted Zone ID of the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 4055

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :domain_name_status,
  :domain_name_status_message,
  :endpoint_type,
  :hosted_zone_id,
  :ip_address_type,
  :security_policy,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ String

The IP address types that can invoke the domain name. Use ipv4 to allow only IPv4 addresses to invoke your domain name, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your domain name.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 4055

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :domain_name_status,
  :domain_name_status_message,
  :endpoint_type,
  :hosted_zone_id,
  :ip_address_type,
  :security_policy,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#ownership_verification_certificate_arn ⇒ String

The Amazon resource name (ARN) for the public certificate issued by Certificate Manager. This ARN is used to validate custom domain ownership. It’s required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 4055

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :domain_name_status,
  :domain_name_status_message,
  :endpoint_type,
  :hosted_zone_id,
  :ip_address_type,
  :security_policy,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#security_policy ⇒ String

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:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 4055

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :domain_name_status,
  :domain_name_status_message,
  :endpoint_type,
  :hosted_zone_id,
  :ip_address_type,
  :security_policy,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end