class Amazonite::ApiGateway::CreateDomainNameRequest

Overview

A request to create a new domain name.

Included Modules

Defined in:

api_gateway/create_domain_name_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(domain_name : String, certificate_name : String | Nil = nil, certificate_body : String | Nil = nil, certificate_private_key : String | Nil = nil, certificate_chain : String | Nil = nil, certificate_arn : String | Nil = nil, regional_certificate_name : String | Nil = nil, regional_certificate_arn : String | Nil = nil, endpoint_configuration : EndpointConfiguration | Nil = nil, tags : Hash(String, String) | Nil = nil, security_policy : SecurityPolicy | Nil = nil, endpoint_access_mode : EndpointAccessMode | Nil = nil, mutual_tls_authentication : MutualTlsAuthenticationInput | Nil = nil, ownership_verification_certificate_arn : String | Nil = nil, policy : String | Nil = nil, routing_mode : RoutingMode | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def certificate_arn : String | Nil #

The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.


[View source]
def certificate_arn=(certificate_arn : String | Nil) #

The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.


[View source]
def certificate_body : String | Nil #

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint or private endpoint for this domain name provided by your certificate authority.


[View source]
def certificate_body=(certificate_body : String | Nil) #

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint or private endpoint for this domain name provided by your certificate authority.


[View source]
def certificate_chain : String | Nil #

[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.


[View source]
def certificate_chain=(certificate_chain : String | Nil) #

[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.


[View source]
def certificate_name : String | Nil #

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


[View source]
def certificate_name=(certificate_name : String | Nil) #

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


[View source]
def certificate_private_key : String | Nil #

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.


[View source]
def certificate_private_key=(certificate_private_key : String | Nil) #

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.


[View source]
def domain_name : String #

The name of the DomainName resource.


[View source]
def domain_name=(domain_name : String) #

The name of the DomainName resource.


[View source]
def endpoint_access_mode : EndpointAccessMode | Nil #

The endpoint access mode of the DomainName. Only available for DomainNames that use security policies that start with SecurityPolicy_.


[View source]
def endpoint_access_mode=(endpoint_access_mode : EndpointAccessMode | Nil) #

The endpoint access mode of the DomainName. Only available for DomainNames that use security policies that start with SecurityPolicy_.


[View source]
def endpoint_configuration : EndpointConfiguration | Nil #

The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.


[View source]
def endpoint_configuration=(endpoint_configuration : EndpointConfiguration | Nil) #

The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def mutual_tls_authentication : MutualTlsAuthenticationInput | Nil #

[View source]
def mutual_tls_authentication=(mutual_tls_authentication : MutualTlsAuthenticationInput | Nil) #

[View source]
def ownership_verification_certificate_arn : String | Nil #

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.


[View source]
def ownership_verification_certificate_arn=(ownership_verification_certificate_arn : String | Nil) #

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.


[View source]
def policy : String | Nil #

A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.


[View source]
def policy=(policy : String | Nil) #

A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.


[View source]
def regional_certificate_arn : String | Nil #

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.


[View source]
def regional_certificate_arn=(regional_certificate_arn : String | Nil) #

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.


[View source]
def regional_certificate_name : String | Nil #

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


[View source]
def regional_certificate_name=(regional_certificate_name : String | Nil) #

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


[View source]
def routing_mode : RoutingMode | Nil #

The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.


[View source]
def routing_mode=(routing_mode : RoutingMode | Nil) #

The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.


[View source]
def security_policy : SecurityPolicy | Nil #

The Transport Layer Security (TLS) version + cipher suite for this DomainName.


[View source]
def security_policy=(security_policy : SecurityPolicy | Nil) #

The Transport Layer Security (TLS) version + cipher suite for this DomainName.


[View source]
def tags : Hash(String, String) | Nil #

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.


[View source]
def tags=(tags : Hash(String, String) | Nil) #

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.


[View source]
def validate! : Nil #

[View source]