Struct aws_sdk_amplify::types::DomainAssociation

#[non_exhaustive]
pub struct DomainAssociation {
    pub domain_association_arn: String,
    pub domain_name: String,
    pub enable_auto_sub_domain: bool,
    pub auto_sub_domain_creation_patterns: Option<Vec<String>>,
    pub auto_sub_domain_iam_role: Option<String>,
    pub domain_status: DomainStatus,
    pub update_status: Option<UpdateStatus>,
    pub status_reason: String,
    pub certificate_verification_dns_record: Option<String>,
    pub sub_domains: Vec<SubDomain>,
    pub certificate: Option<Certificate>,
}

Describes the association between a custom domain and an Amplify app.

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_association_arn: String

The Amazon Resource Name (ARN) for the domain association.

domain_name: String

The name of the domain.

enable_auto_sub_domain: bool

Enables the automated creation of subdomains for branches.

auto_sub_domain_creation_patterns: Option<Vec<String>>

Sets branch patterns for automatic subdomain creation.

auto_sub_domain_iam_role: Option<String>

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

domain_status: DomainStatus

The current status of the domain association.

update_status: Option<UpdateStatus>

The status of the domain update operation that is currently in progress. The following list describes the valid update states.

REQUESTING_CERTIFICATE

The certificate is in the process of being updated.

PENDING_VERIFICATION

Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

IMPORTING_CUSTOM_CERTIFICATE

Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

PENDING_DEPLOYMENT

Indicates that the subdomain or certificate changes are being propagated.

AWAITING_APP_CNAME

Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

UPDATE_COMPLETE

The certificate has been associated with a domain.

UPDATE_FAILED

The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

status_reason: String

Additional information that describes why the domain association is in the current state.

certificate_verification_dns_record: Option<String>

The DNS record for certificate verification.

sub_domains: Vec<SubDomain>

The subdomains for the domain association.

certificate: Option<Certificate>

Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.

If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.

Implementations

impl DomainAssociation

pub fn domain_association_arn(&self) -> &str

The Amazon Resource Name (ARN) for the domain association.

pub fn domain_name(&self) -> &str

The name of the domain.

pub fn enable_auto_sub_domain(&self) -> bool

Enables the automated creation of subdomains for branches.

pub fn auto_sub_domain_creation_patterns(&self) -> &[String]

Sets branch patterns for automatic subdomain creation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .auto_sub_domain_creation_patterns.is_none().

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

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

pub fn domain_status(&self) -> &DomainStatus

The current status of the domain association.

pub fn update_status(&self) -> Option<&UpdateStatus>

The status of the domain update operation that is currently in progress. The following list describes the valid update states.

REQUESTING_CERTIFICATE

The certificate is in the process of being updated.

PENDING_VERIFICATION

Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

IMPORTING_CUSTOM_CERTIFICATE

Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

PENDING_DEPLOYMENT

Indicates that the subdomain or certificate changes are being propagated.

AWAITING_APP_CNAME

Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

UPDATE_COMPLETE

The certificate has been associated with a domain.

UPDATE_FAILED

The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

pub fn status_reason(&self) -> &str

Additional information that describes why the domain association is in the current state.

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

The DNS record for certificate verification.

pub fn sub_domains(&self) -> &[SubDomain]

The subdomains for the domain association.

pub fn certificate(&self) -> Option<&Certificate>

Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.

If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.

impl DomainAssociation

pub fn builder() -> DomainAssociationBuilder

Creates a new builder-style object to manufacture DomainAssociation.

Trait Implementations

impl Clone for DomainAssociation

fn clone(&self) -> DomainAssociation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DomainAssociation

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

Formats the value using the given formatter.

impl PartialEq for DomainAssociation

fn eq(&self, other: &DomainAssociation) -> 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 DomainAssociation