You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ApiGatewayV2::Types::DomainNameConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::ApiGatewayV2::Types::DomainNameConfiguration
- Defined in:
- (unknown)
Overview
When passing DomainNameConfiguration as input to an Aws::Client method, you can use a vanilla 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.
Instance Attribute Summary collapse
-
#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.
#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.
#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. 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.
Possible values:
- AVAILABLE
- UPDATING
#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.
Possible values:
- REGIONAL
- EDGE
#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. The valid values are TLS_1_0 and TLS_1_2.
Possible values:
- TLS_1_0
- TLS_1_2