1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateDomainName`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_name(impl Into<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_domain_name):<br>required: **true**<br><p>The name of the DomainName resource.</p><br>
    ///   - [`certificate_name(impl Into<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::certificate_name) / [`set_certificate_name(Option<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_certificate_name):<br>required: **false**<br><p>The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.</p><br>
    ///   - [`certificate_body(impl Into<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::certificate_body) / [`set_certificate_body(Option<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_certificate_body):<br>required: **false**<br><p>[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.</p><br>
    ///   - [`certificate_private_key(impl Into<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::certificate_private_key) / [`set_certificate_private_key(Option<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_certificate_private_key):<br>required: **false**<br><p>[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.</p><br>
    ///   - [`certificate_chain(impl Into<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::certificate_chain) / [`set_certificate_chain(Option<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_certificate_chain):<br>required: **false**<br><p>[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.</p><br>
    ///   - [`certificate_arn(impl Into<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::certificate_arn) / [`set_certificate_arn(Option<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_certificate_arn):<br>required: **false**<br><p>The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.</p><br>
    ///   - [`regional_certificate_name(impl Into<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::regional_certificate_name) / [`set_regional_certificate_name(Option<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_regional_certificate_name):<br>required: **false**<br><p>The user-friendly name of the certificate that will be used by regional endpoint for this domain name.</p><br>
    ///   - [`regional_certificate_arn(impl Into<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::regional_certificate_arn) / [`set_regional_certificate_arn(Option<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_regional_certificate_arn):<br>required: **false**<br><p>The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.</p><br>
    ///   - [`endpoint_configuration(EndpointConfiguration)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::endpoint_configuration) / [`set_endpoint_configuration(Option<EndpointConfiguration>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_endpoint_configuration):<br>required: **false**<br><p>The endpoint configuration of this DomainName showing the endpoint types of the domain name.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_tags):<br>required: **false**<br><p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p><br>
    ///   - [`security_policy(SecurityPolicy)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::security_policy) / [`set_security_policy(Option<SecurityPolicy>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_security_policy):<br>required: **false**<br><p>The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>.</p><br>
    ///   - [`mutual_tls_authentication(MutualTlsAuthenticationInput)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::mutual_tls_authentication) / [`set_mutual_tls_authentication(Option<MutualTlsAuthenticationInput>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_mutual_tls_authentication):<br>required: **false**<br><p>The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.</p><br>
    ///   - [`ownership_verification_certificate_arn(impl Into<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::ownership_verification_certificate_arn) / [`set_ownership_verification_certificate_arn(Option<String>)`](crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::set_ownership_verification_certificate_arn):<br>required: **false**<br><p>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.</p><br>
    /// - On success, responds with [`CreateDomainNameOutput`](crate::operation::create_domain_name::CreateDomainNameOutput) with field(s):
    ///   - [`domain_name(Option<String>)`](crate::operation::create_domain_name::CreateDomainNameOutput::domain_name): <p>The custom domain name as an API host name, for example, <code>my-api.example.com</code>.</p>
    ///   - [`certificate_name(Option<String>)`](crate::operation::create_domain_name::CreateDomainNameOutput::certificate_name): <p>The name of the certificate that will be used by edge-optimized endpoint for this domain name.</p>
    ///   - [`certificate_arn(Option<String>)`](crate::operation::create_domain_name::CreateDomainNameOutput::certificate_arn): <p>The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.</p>
    ///   - [`certificate_upload_date(Option<DateTime>)`](crate::operation::create_domain_name::CreateDomainNameOutput::certificate_upload_date): <p>The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.</p>
    ///   - [`regional_domain_name(Option<String>)`](crate::operation::create_domain_name::CreateDomainNameOutput::regional_domain_name): <p>The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.</p>
    ///   - [`regional_hosted_zone_id(Option<String>)`](crate::operation::create_domain_name::CreateDomainNameOutput::regional_hosted_zone_id): <p>The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.</p>
    ///   - [`regional_certificate_name(Option<String>)`](crate::operation::create_domain_name::CreateDomainNameOutput::regional_certificate_name): <p>The name of the certificate that will be used for validating the regional domain name.</p>
    ///   - [`regional_certificate_arn(Option<String>)`](crate::operation::create_domain_name::CreateDomainNameOutput::regional_certificate_arn): <p>The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.</p>
    ///   - [`distribution_domain_name(Option<String>)`](crate::operation::create_domain_name::CreateDomainNameOutput::distribution_domain_name): <p>The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.</p>
    ///   - [`distribution_hosted_zone_id(Option<String>)`](crate::operation::create_domain_name::CreateDomainNameOutput::distribution_hosted_zone_id): <p>The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is <code>Z2FDTNDATAQYW2</code> for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.</p>
    ///   - [`endpoint_configuration(Option<EndpointConfiguration>)`](crate::operation::create_domain_name::CreateDomainNameOutput::endpoint_configuration): <p>The endpoint configuration of this DomainName showing the endpoint types of the domain name.</p>
    ///   - [`domain_name_status(Option<DomainNameStatus>)`](crate::operation::create_domain_name::CreateDomainNameOutput::domain_name_status): <p>The status of the DomainName migration. The valid values are <code>AVAILABLE</code> and <code>UPDATING</code>. If the status is <code>UPDATING</code>, the domain cannot be modified further until the existing operation is complete. If it is <code>AVAILABLE</code>, the domain can be updated.</p>
    ///   - [`domain_name_status_message(Option<String>)`](crate::operation::create_domain_name::CreateDomainNameOutput::domain_name_status_message): <p>An optional text message containing detailed information about status of the DomainName migration.</p>
    ///   - [`security_policy(Option<SecurityPolicy>)`](crate::operation::create_domain_name::CreateDomainNameOutput::security_policy): <p>The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_domain_name::CreateDomainNameOutput::tags): <p>The collection of tags. Each tag element is associated with a given resource.</p>
    ///   - [`mutual_tls_authentication(Option<MutualTlsAuthentication>)`](crate::operation::create_domain_name::CreateDomainNameOutput::mutual_tls_authentication): <p>The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.</p>
    ///   - [`ownership_verification_certificate_arn(Option<String>)`](crate::operation::create_domain_name::CreateDomainNameOutput::ownership_verification_certificate_arn): <p>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.</p>
    /// - On failure, responds with [`SdkError<CreateDomainNameError>`](crate::operation::create_domain_name::CreateDomainNameError)
    pub fn create_domain_name(&self) -> crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder {
        crate::operation::create_domain_name::builders::CreateDomainNameFluentBuilder::new(self.handle.clone())
    }
}