Struct aws_sdk_apigateway::client::fluent_builders::CreateDomainName

pub struct CreateDomainName { /* private fields */ }

Fluent builder constructing a request to CreateDomainName.

Creates a new domain name.

Implementations

impl CreateDomainName

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateDomainName, AwsResponseRetryClassifier>, SdkError<CreateDomainNameError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateDomainNameOutput, SdkError<CreateDomainNameError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

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

The name of the DomainName resource.

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

The name of the DomainName resource.

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

The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.

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

The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.

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

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

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

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

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

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

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

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

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

[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.

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

[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.

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

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

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

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

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

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

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

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

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

The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.

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

The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.

pub fn endpoint_configuration(self, input: EndpointConfiguration) -> Self

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

pub fn set_endpoint_configuration(
    self,
    input: Option<EndpointConfiguration>
) -> Self

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

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 aws:. The tag value can be up to 256 characters.

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

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 aws:. The tag value can be up to 256 characters.

pub fn security_policy(self, input: SecurityPolicy) -> Self

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

pub fn set_security_policy(self, input: Option<SecurityPolicy>) -> Self

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

pub fn mutual_tls_authentication(
    self,
    input: MutualTlsAuthenticationInput
) -> Self

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.

pub fn set_mutual_tls_authentication(
    self,
    input: Option<MutualTlsAuthenticationInput>
) -> Self

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.

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

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.

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

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.

Trait Implementations

impl Clone for CreateDomainName

fn clone(&self) -> CreateDomainName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDomainName

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

Formats the value using the given formatter.