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
The domain name configuration.
Constant Summary collapse
- SENSITIVE =
[]
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.
-
#ownership_verification_certificate_arn ⇒ String
The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
-
#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.
3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3093 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_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.
3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3093 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_name ⇒ String
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3093 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_date ⇒ Time
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3093 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 ⇒ String
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.
3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3093 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_message ⇒ String
An optional text message containing detailed information about status of the domain name migration.
3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3093 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_type ⇒ String
The endpoint type.
3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3093 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_id ⇒ String
The Amazon Route 53 Hosted Zone ID of the endpoint.
3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3093 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_arn ⇒ String
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
3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3093 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_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.
3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3093 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 |