Class: Aws::APIGateway::Types::CreateDomainNameRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::CreateDomainNameRequest
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
A request to create a new domain name.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#certificate_arn ⇒ String
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name.
-
#certificate_body ⇒ String
[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
-
#certificate_chain ⇒ String
[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name.
-
#certificate_name ⇒ String
The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
-
#certificate_private_key ⇒ String
[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
-
#domain_name ⇒ String
The name of the DomainName resource.
-
#endpoint_configuration ⇒ Types::EndpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
-
#mutual_tls_authentication ⇒ Types::MutualTlsAuthenticationInput
The mutual TLS authentication configuration for a custom domain name.
-
#ownership_verification_certificate_arn ⇒ String
The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
-
#regional_certificate_arn ⇒ String
The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name.
-
#regional_certificate_name ⇒ String
The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
-
#security_policy ⇒ String
The Transport Layer Security (TLS) version + cipher suite for this DomainName.
-
#tags ⇒ Hash<String,String>
The key-value map of strings.
Instance Attribute Details
#certificate_arn ⇒ String
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :ownership_verification_certificate_arn) SENSITIVE = [] include Aws::Structure end |
#certificate_body ⇒ String
[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :ownership_verification_certificate_arn) SENSITIVE = [] include Aws::Structure end |
#certificate_chain ⇒ String
[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :ownership_verification_certificate_arn) SENSITIVE = [] include Aws::Structure end |
#certificate_name ⇒ String
The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :ownership_verification_certificate_arn) SENSITIVE = [] include Aws::Structure end |
#certificate_private_key ⇒ String
[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :ownership_verification_certificate_arn) SENSITIVE = [] include Aws::Structure end |
#domain_name ⇒ String
The name of the DomainName resource.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :ownership_verification_certificate_arn) SENSITIVE = [] include Aws::Structure end |
#endpoint_configuration ⇒ Types::EndpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :ownership_verification_certificate_arn) SENSITIVE = [] include Aws::Structure end |
#mutual_tls_authentication ⇒ Types::MutualTlsAuthenticationInput
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :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.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :ownership_verification_certificate_arn) SENSITIVE = [] include Aws::Structure end |
#regional_certificate_arn ⇒ String
The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :ownership_verification_certificate_arn) SENSITIVE = [] include Aws::Structure end |
#regional_certificate_name ⇒ String
The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :ownership_verification_certificate_arn) SENSITIVE = [] include Aws::Structure end |
#security_policy ⇒ String
The Transport Layer Security (TLS) version + cipher suite for this
DomainName. The valid values are TLS_1_0
and TLS_1_2
.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :ownership_verification_certificate_arn) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must
not start with aws:
. The tag value can be up to 256 characters.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 859 class CreateDomainNameRequest < Struct.new( :domain_name, :certificate_name, :certificate_body, :certificate_private_key, :certificate_chain, :certificate_arn, :regional_certificate_name, :regional_certificate_arn, :endpoint_configuration, :tags, :security_policy, :mutual_tls_authentication, :ownership_verification_certificate_arn) SENSITIVE = [] include Aws::Structure end |