class Amazonite::ApiGateway::DomainName

Overview

Represents a custom domain name as a user-friendly host name of an API (RestApi).

Included Modules

Defined in:

api_gateway/domain_name.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(domain_name : String | Nil = nil, domain_name_id : String | Nil = nil, domain_name_arn : String | Nil = nil, certificate_name : String | Nil = nil, certificate_arn : String | Nil = nil, certificate_upload_date : Time | Nil = nil, regional_domain_name : String | Nil = nil, regional_hosted_zone_id : String | Nil = nil, regional_certificate_name : String | Nil = nil, regional_certificate_arn : String | Nil = nil, distribution_domain_name : String | Nil = nil, distribution_hosted_zone_id : String | Nil = nil, endpoint_configuration : EndpointConfiguration | Nil = nil, domain_name_status : DomainNameStatus | Nil = nil, domain_name_status_message : String | Nil = nil, security_policy : SecurityPolicy | Nil = nil, endpoint_access_mode : EndpointAccessMode | Nil = nil, tags : Hash(String, String) | Nil = nil, mutual_tls_authentication : MutualTlsAuthentication | Nil = nil, ownership_verification_certificate_arn : String | Nil = nil, management_policy : 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_name : String | Nil #

The 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 name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.


[View source]
def certificate_upload_date : Time | Nil #

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


[View source]
def certificate_upload_date=(certificate_upload_date : Time | Nil) #

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


[View source]
def distribution_domain_name : String | Nil #

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.


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

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.


[View source]
def distribution_hosted_zone_id : String | Nil #

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.


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

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.


[View source]
def domain_name : String | Nil #

The custom domain name as an API host name, for example, my-api.example.com.


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

The custom domain name as an API host name, for example, my-api.example.com.


[View source]
def domain_name_arn : String | Nil #

The ARN of the domain name.


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

The ARN of the domain name.


[View source]
def domain_name_id : String | Nil #

The identifier for the domain name resource. Supported only for private custom domain names.


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

The identifier for the domain name resource. Supported only for private custom domain names.


[View source]
def domain_name_status : DomainNameStatus | Nil #

The status of the DomainName 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.


[View source]
def domain_name_status=(domain_name_status : DomainNameStatus | Nil) #

The status of the DomainName 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.


[View source]
def domain_name_status_message : String | Nil #

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


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

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


[View source]
def endpoint_access_mode : EndpointAccessMode | Nil #

The endpoint access mode of the DomainName.


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

The endpoint access mode of the DomainName.


[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 management_policy : String | Nil #

A stringified JSON policy document that applies to the API Gateway Management service for this DomainName. This policy document controls access for access association sources to create domain name access associations with this DomainName. Supported only for private custom domain names.


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

A stringified JSON policy document that applies to the API Gateway Management service for this DomainName. This policy document controls access for access association sources to create domain name access associations with this DomainName. Supported only for private custom domain names.


[View source]
def mutual_tls_authentication : MutualTlsAuthentication | Nil #

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.


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

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.


[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 for validating the regional 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 for validating the regional domain name. Certificate Manager is the only supported source.


[View source]
def regional_certificate_name : String | Nil #

The name of the certificate that will be used for validating the regional domain name.


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

The name of the certificate that will be used for validating the regional domain name.


[View source]
def regional_domain_name : String | Nil #

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.


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

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.


[View source]
def regional_hosted_zone_id : String | Nil #

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.


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

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.


[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 collection of tags. Each tag element is associated with a given resource.


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

The collection of tags. Each tag element is associated with a given resource.


[View source]
def validate! : Nil #

[View source]