aws_sdk_amplify/client/
create_domain_association.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateDomainAssociation`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`app_id(impl Into<String>)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::set_app_id):<br>required: **true**<br><p>The unique ID for an Amplify app.</p><br>
7    ///   - [`domain_name(impl Into<String>)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::set_domain_name):<br>required: **true**<br><p>The domain name for the domain association.</p><br>
8    ///   - [`enable_auto_sub_domain(bool)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::enable_auto_sub_domain) / [`set_enable_auto_sub_domain(Option<bool>)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::set_enable_auto_sub_domain):<br>required: **false**<br><p>Enables the automated creation of subdomains for branches.</p><br>
9    ///   - [`sub_domain_settings(SubDomainSetting)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::sub_domain_settings) / [`set_sub_domain_settings(Option<Vec::<SubDomainSetting>>)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::set_sub_domain_settings):<br>required: **true**<br><p>The setting for the subdomain.</p><br>
10    ///   - [`auto_sub_domain_creation_patterns(impl Into<String>)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::auto_sub_domain_creation_patterns) / [`set_auto_sub_domain_creation_patterns(Option<Vec::<String>>)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::set_auto_sub_domain_creation_patterns):<br>required: **false**<br><p>Sets the branch patterns for automatic subdomain creation.</p><br>
11    ///   - [`auto_sub_domain_iam_role(impl Into<String>)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::auto_sub_domain_iam_role) / [`set_auto_sub_domain_iam_role(Option<String>)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::set_auto_sub_domain_iam_role):<br>required: **false**<br><p>The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.</p><br>
12    ///   - [`certificate_settings(CertificateSettings)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::certificate_settings) / [`set_certificate_settings(Option<CertificateSettings>)`](crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::set_certificate_settings):<br>required: **false**<br><p>The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.</p><br>
13    /// - On success, responds with [`CreateDomainAssociationOutput`](crate::operation::create_domain_association::CreateDomainAssociationOutput) with field(s):
14    ///   - [`domain_association(Option<DomainAssociation>)`](crate::operation::create_domain_association::CreateDomainAssociationOutput::domain_association): <p>Describes the structure of a domain association, which associates a custom domain with an Amplify app.</p>
15    /// - On failure, responds with [`SdkError<CreateDomainAssociationError>`](crate::operation::create_domain_association::CreateDomainAssociationError)
16    pub fn create_domain_association(&self) -> crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder {
17        crate::operation::create_domain_association::builders::CreateDomainAssociationFluentBuilder::new(self.handle.clone())
18    }
19}