Struct aws_sdk_apigateway::output::CreateDomainNameOutput

#[non_exhaustive]
pub struct CreateDomainNameOutput {

    pub domain_name: Option<String>,
    pub certificate_name: Option<String>,
    pub certificate_arn: Option<String>,
    pub certificate_upload_date: Option<DateTime>,
    pub regional_domain_name: Option<String>,
    pub regional_hosted_zone_id: Option<String>,
    pub regional_certificate_name: Option<String>,
    pub regional_certificate_arn: Option<String>,
    pub distribution_domain_name: Option<String>,
    pub distribution_hosted_zone_id: Option<String>,
    pub endpoint_configuration: Option<EndpointConfiguration>,
    pub domain_name_status: Option<DomainNameStatus>,
    pub domain_name_status_message: Option<String>,
    pub security_policy: Option<SecurityPolicy>,
    pub tags: Option<HashMap<String, String>>,
    pub mutual_tls_authentication: Option<MutualTlsAuthentication>,
    pub ownership_verification_certificate_arn: Option<String>,
}

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

When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.

Set a Custom Host Name for an API

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

domain_name: Option<String>

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

certificate_name: Option<String>

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

certificate_arn: Option<String>

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

certificate_upload_date: Option<DateTime>

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

regional_domain_name: Option<String>

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.

regional_hosted_zone_id: Option<String>

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.

regional_certificate_name: Option<String>

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

regional_certificate_arn: Option<String>

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

distribution_domain_name: Option<String>

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.

distribution_hosted_zone_id: Option<String>

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.

endpoint_configuration: Option<EndpointConfiguration>

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

domain_name_status: Option<DomainNameStatus>

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

domain_name_status_message: Option<String>

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

security_policy: Option<SecurityPolicy>

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

tags: Option<HashMap<String, String>>

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

mutual_tls_authentication: Option<MutualTlsAuthentication>

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.

ownership_verification_certificate_arn: Option<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.

Implementations

impl CreateDomainNameOutput

pub fn domain_name(&self) -> Option<&str>

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

pub fn certificate_name(&self) -> Option<&str>

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

pub fn certificate_arn(&self) -> Option<&str>

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

pub fn certificate_upload_date(&self) -> Option<&DateTime>

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

pub fn regional_domain_name(&self) -> Option<&str>

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.

pub fn regional_hosted_zone_id(&self) -> Option<&str>

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.

pub fn regional_certificate_name(&self) -> Option<&str>

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

pub fn regional_certificate_arn(&self) -> Option<&str>

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

pub fn distribution_domain_name(&self) -> Option<&str>

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.

pub fn distribution_hosted_zone_id(&self) -> Option<&str>

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.

pub fn endpoint_configuration(&self) -> Option<&EndpointConfiguration>

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

pub fn domain_name_status(&self) -> Option<&DomainNameStatus>

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

pub fn domain_name_status_message(&self) -> Option<&str>

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

pub fn security_policy(&self) -> Option<&SecurityPolicy>

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

pub fn mutual_tls_authentication(&self) -> Option<&MutualTlsAuthentication>

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.

pub fn ownership_verification_certificate_arn(&self) -> Option<&str>

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.

impl CreateDomainNameOutput

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateDomainNameOutput

Trait Implementations

impl Clone for CreateDomainNameOutput

fn clone(&self) -> CreateDomainNameOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateDomainNameOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CreateDomainNameOutput> for CreateDomainNameOutput

fn eq(&self, other: &CreateDomainNameOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateDomainNameOutput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateDomainNameOutput