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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

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
  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
}

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 AWS-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

  The status of the 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.

• #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 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3184

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,
  :security_policy)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_arn ⇒ String

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:

• (String)

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

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,
  :security_policy)
  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 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3184

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,
  :security_policy)
  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 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3184

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,
  :security_policy)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name_status ⇒ String

The status of the domain name 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:

• (String)

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

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,
  :security_policy)
  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 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3184

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,
  :security_policy)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_type ⇒ String

The endpoint type.

Returns:

• (String)

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

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,
  :security_policy)
  SENSITIVE = []
  include Aws::Structure
end

#hosted_zone_id ⇒ String

The Amazon Route 53 Hosted Zone ID of the endpoint.

Returns:

• (String)

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

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,
  :security_policy)
  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 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3184

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,
  :security_policy)
  SENSITIVE = []
  include Aws::Structure
end