Struct aws_sdk_apigatewayv2::types::DomainNameConfiguration

#[non_exhaustive]
pub struct DomainNameConfiguration {
    pub api_gateway_domain_name: Option<String>,
    pub certificate_arn: Option<String>,
    pub certificate_name: Option<String>,
    pub certificate_upload_date: Option<DateTime>,
    pub domain_name_status: Option<DomainNameStatus>,
    pub domain_name_status_message: Option<String>,
    pub endpoint_type: Option<EndpointType>,
    pub hosted_zone_id: Option<String>,
    pub security_policy: Option<SecurityPolicy>,
    pub ownership_verification_certificate_arn: Option<String>,
}

The domain name configuration.

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.

api_gateway_domain_name: Option<String>

A domain name for the API.

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

certificate_name: Option<String>

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

certificate_upload_date: Option<DateTime>

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

domain_name_status: Option<DomainNameStatus>

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.

domain_name_status_message: Option<String>

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

endpoint_type: Option<EndpointType>

The endpoint type.

hosted_zone_id: Option<String>

The Amazon Route 53 Hosted Zone ID of the endpoint.

security_policy: Option<SecurityPolicy>

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.

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 DomainNameConfiguration

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

A domain name for the API.

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

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.

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

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

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 domain_name_status(&self) -> Option<&DomainNameStatus>

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.

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

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

pub fn endpoint_type(&self) -> Option<&EndpointType>

The endpoint type.

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

The Amazon Route 53 Hosted Zone ID of the endpoint.

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

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.

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 DomainNameConfiguration

pub fn builder() -> DomainNameConfigurationBuilder

Creates a new builder-style object to manufacture DomainNameConfiguration.

Trait Implementations

impl Clone for DomainNameConfiguration

fn clone(&self) -> DomainNameConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DomainNameConfiguration

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

Formats the value using the given formatter.

impl PartialEq for DomainNameConfiguration

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DomainNameConfiguration