Struct aws_sdk_amplify::types::builders::DomainAssociationBuilder

#[non_exhaustive]
pub struct DomainAssociationBuilder { /* private fields */ }

A builder for DomainAssociation.

Implementations

impl DomainAssociationBuilder

pub fn domain_association_arn(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_domain_association_arn(self, input: Option<String>) -> Self

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

pub fn get_domain_association_arn(&self) -> &Option<String>

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

pub fn domain_name(self, input: impl Into<String>) -> Self

The name of the domain.

This field is required.

pub fn set_domain_name(self, input: Option<String>) -> Self

The name of the domain.

pub fn get_domain_name(&self) -> &Option<String>

The name of the domain.

pub fn enable_auto_sub_domain(self, input: bool) -> Self

Enables the automated creation of subdomains for branches.

This field is required.

pub fn set_enable_auto_sub_domain(self, input: Option<bool>) -> Self

Enables the automated creation of subdomains for branches.

pub fn get_enable_auto_sub_domain(&self) -> &Option<bool>

Enables the automated creation of subdomains for branches.

pub fn auto_sub_domain_creation_patterns(self, input: impl Into<String>) -> Self

Appends an item to auto_sub_domain_creation_patterns.

To override the contents of this collection use set_auto_sub_domain_creation_patterns.

Sets branch patterns for automatic subdomain creation.

pub fn set_auto_sub_domain_creation_patterns( self, input: Option<Vec<String>> ) -> Self

Sets branch patterns for automatic subdomain creation.

pub fn get_auto_sub_domain_creation_patterns(&self) -> &Option<Vec<String>>

Sets branch patterns for automatic subdomain creation.

pub fn auto_sub_domain_iam_role(self, input: impl Into<String>) -> Self

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

pub fn set_auto_sub_domain_iam_role(self, input: Option<String>) -> Self

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

pub fn get_auto_sub_domain_iam_role(&self) -> &Option<String>

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, input: DomainStatus) -> Self

The current status of the domain association.

This field is required.

pub fn set_domain_status(self, input: Option<DomainStatus>) -> Self

The current status of the domain association.

pub fn get_domain_status(&self) -> &Option<DomainStatus>

The current status of the domain association.

pub fn update_status(self, input: UpdateStatus) -> Self

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 set_update_status(self, input: Option<UpdateStatus>) -> Self

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 get_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, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_status_reason(self, input: Option<String>) -> Self

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

pub fn get_status_reason(&self) -> &Option<String>

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

pub fn certificate_verification_dns_record( self, input: impl Into<String> ) -> Self

The DNS record for certificate verification.

pub fn set_certificate_verification_dns_record( self, input: Option<String> ) -> Self

The DNS record for certificate verification.

pub fn get_certificate_verification_dns_record(&self) -> &Option<String>

The DNS record for certificate verification.

pub fn sub_domains(self, input: SubDomain) -> Self

Appends an item to sub_domains.

To override the contents of this collection use set_sub_domains.

The subdomains for the domain association.

pub fn set_sub_domains(self, input: Option<Vec<SubDomain>>) -> Self

The subdomains for the domain association.

pub fn get_sub_domains(&self) -> &Option<Vec<SubDomain>>

The subdomains for the domain association.

pub fn certificate(self, input: Certificate) -> Self

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.

pub fn set_certificate(self, input: Option<Certificate>) -> Self

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.

pub fn get_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.

pub fn build(self) -> Result<DomainAssociation, BuildError>

Consumes the builder and constructs a DomainAssociation. This method will fail if any of the following fields are not set:

• domain_association_arn
• domain_name
• enable_auto_sub_domain
• domain_status
• status_reason
• sub_domains

Trait Implementations

impl Clone for DomainAssociationBuilder

fn clone(&self) -> DomainAssociationBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DomainAssociationBuilder

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

Formats the value using the given formatter.

impl Default for DomainAssociationBuilder

fn default() -> DomainAssociationBuilder

Returns the “default value” for a type.

impl PartialEq for DomainAssociationBuilder

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