Struct aws_sdk_apigateway::operation::get_domain_name::builders::GetDomainNameOutputBuilder

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

A builder for GetDomainNameOutput.

Implementations

impl GetDomainNameOutputBuilder

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

The custom domain name as an API host name, for example, my-api.example.com.

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

The custom domain name as an API host name, for example, my-api.example.com.

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

The custom domain name as an API host name, for example, my-api.example.com.

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

The 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 name of the certificate that will be used by edge-optimized endpoint for this domain name.

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

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

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

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.

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

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.

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

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.

pub fn certificate_upload_date(self, input: DateTime) -> Self

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

pub fn set_certificate_upload_date(self, input: Option<DateTime>) -> Self

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

pub fn get_certificate_upload_date(&self) -> &Option<DateTime>

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

The name of the certificate that will be used for validating the regional domain name.

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

The name of the certificate that will be used for validating the regional domain name.

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

The name of the certificate that will be used for validating the regional domain name.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

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

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

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

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

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 get_endpoint_configuration(&self) -> &Option<EndpointConfiguration>

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

pub fn domain_name_status(self, input: DomainNameStatus) -> Self

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

pub fn set_domain_name_status(self, input: Option<DomainNameStatus>) -> Self

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

pub fn get_domain_name_status(&self) -> &Option<DomainNameStatus>

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

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

An optional text message containing detailed information about status of the DomainName migration.

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

An optional text message containing detailed information about status of the DomainName migration.

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

An optional text message containing detailed information about status of the DomainName migration.

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 get_security_policy(&self) -> &Option<SecurityPolicy>

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

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 collection of tags. Each tag element is associated with a given resource.

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

The collection of tags. Each tag element is associated with a given resource.

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

The collection of tags. Each tag element is associated with a given resource.

pub fn mutual_tls_authentication(self, input: MutualTlsAuthentication) -> 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<MutualTlsAuthentication> ) -> 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 get_mutual_tls_authentication(&self) -> &Option<MutualTlsAuthentication>

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.

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

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 build(self) -> GetDomainNameOutput

Consumes the builder and constructs a GetDomainNameOutput.

Trait Implementations

impl Clone for GetDomainNameOutputBuilder

fn clone(&self) -> GetDomainNameOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetDomainNameOutputBuilder

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

Formats the value using the given formatter.

impl Default for GetDomainNameOutputBuilder

fn default() -> GetDomainNameOutputBuilder

Returns the “default value” for a type.

impl PartialEq for GetDomainNameOutputBuilder

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