AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
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, 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",
}

The domain name configuration.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_gateway_domain_nameString

A domain name for the API.

Returns:

  • (String)


3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3506

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

#certificate_arnString

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)


3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3506

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

#certificate_nameString

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

Returns:

  • (String)


3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3506

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

#certificate_upload_dateTime

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

Returns:

  • (Time)


3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3506

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

#domain_name_statusString

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:

  • (String)


3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3506

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

#domain_name_status_messageString

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

Returns:

  • (String)


3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3506

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

#endpoint_typeString

The endpoint type.

Returns:

  • (String)


3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3506

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

#hosted_zone_idString

The Amazon Route 53 Hosted Zone ID of the endpoint.

Returns:

  • (String)


3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3506

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

#ownership_verification_certificate_arnString

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:

  • (String)


3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3506

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

#security_policyString

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)


3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3506

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