aws_sdk_apprunner/client/
associate_custom_domain.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 [`AssociateCustomDomain`](crate::operation::associate_custom_domain::builders::AssociateCustomDomainFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`service_arn(impl Into<String>)`](crate::operation::associate_custom_domain::builders::AssociateCustomDomainFluentBuilder::service_arn) / [`set_service_arn(Option<String>)`](crate::operation::associate_custom_domain::builders::AssociateCustomDomainFluentBuilder::set_service_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.</p><br>
7    ///   - [`domain_name(impl Into<String>)`](crate::operation::associate_custom_domain::builders::AssociateCustomDomainFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::associate_custom_domain::builders::AssociateCustomDomainFluentBuilder::set_domain_name):<br>required: **true**<br><p>A custom domain endpoint to associate. Specify a root domain (for example, <code>example.com</code>), a subdomain (for example, <code>login.example.com</code> or <code>admin.login.example.com</code>), or a wildcard (for example, <code>*.example.com</code>).</p><br>
8    ///   - [`enable_www_subdomain(bool)`](crate::operation::associate_custom_domain::builders::AssociateCustomDomainFluentBuilder::enable_www_subdomain) / [`set_enable_www_subdomain(Option<bool>)`](crate::operation::associate_custom_domain::builders::AssociateCustomDomainFluentBuilder::set_enable_www_subdomain):<br>required: **false**<br><p>Set to <code>true</code> to associate the subdomain <code>www.<i>DomainName</i> </code> with the App Runner service in addition to the base domain.</p> <p>Default: <code>true</code></p><br>
9    /// - On success, responds with [`AssociateCustomDomainOutput`](crate::operation::associate_custom_domain::AssociateCustomDomainOutput) with field(s):
10    ///   - [`dns_target(String)`](crate::operation::associate_custom_domain::AssociateCustomDomainOutput::dns_target): <p>The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.</p>
11    ///   - [`service_arn(String)`](crate::operation::associate_custom_domain::AssociateCustomDomainOutput::service_arn): <p>The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.</p>
12    ///   - [`custom_domain(Option<CustomDomain>)`](crate::operation::associate_custom_domain::AssociateCustomDomainOutput::custom_domain): <p>A description of the domain name that's being associated.</p>
13    ///   - [`vpc_dns_targets(Vec::<VpcDnsTarget>)`](crate::operation::associate_custom_domain::AssociateCustomDomainOutput::vpc_dns_targets): <p>DNS Target records for the custom domains of this Amazon VPC.</p>
14    /// - On failure, responds with [`SdkError<AssociateCustomDomainError>`](crate::operation::associate_custom_domain::AssociateCustomDomainError)
15    pub fn associate_custom_domain(&self) -> crate::operation::associate_custom_domain::builders::AssociateCustomDomainFluentBuilder {
16        crate::operation::associate_custom_domain::builders::AssociateCustomDomainFluentBuilder::new(self.handle.clone())
17    }
18}