Struct rusoto_apigateway::DomainName

pub struct DomainName {

    pub certificate_arn: Option<String>,
    pub certificate_name: Option<String>,
    pub certificate_upload_date: Option<f64>,
    pub distribution_domain_name: Option<String>,
    pub distribution_hosted_zone_id: Option<String>,
    pub domain_name: Option<String>,
    pub domain_name_status: Option<String>,
    pub domain_name_status_message: Option<String>,
    pub endpoint_configuration: Option<EndpointConfiguration>,
    pub mutual_tls_authentication: Option<MutualTlsAuthentication>,
    pub regional_certificate_arn: Option<String>,
    pub regional_certificate_name: Option<String>,
    pub regional_domain_name: Option<String>,
    pub regional_hosted_zone_id: Option<String>,
    pub security_policy: Option<String>,
    pub tags: Option<HashMap<String, String>>,
}

Represents a custom domain name as a user-friendly host name of an API (RestApi).

When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.

Set a Custom Host Name for an API

Fields

certificate_arn: Option<String>

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.

certificate_name: Option<String>

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

certificate_upload_date: Option<f64>

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

distribution_domain_name: 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.

distribution_hosted_zone_id: 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.

domain_name: Option<String>

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

domain_name_status: Option<String>

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.

domain_name_status_message: Option<String>

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

endpoint_configuration: Option<EndpointConfiguration>

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

mutual_tls_authentication: 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.

regional_certificate_arn: Option<String>

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

regional_certificate_name: Option<String>

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

regional_domain_name: 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.

regional_hosted_zone_id: 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.

security_policy: Option<String>

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

tags: Option<HashMap<String, String>>

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

Trait Implementations

impl Clone for DomainName

fn clone(&self) -> DomainName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DomainName

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

Formats the value using the given formatter.

impl Default for DomainName

fn default() -> DomainName

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DomainName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<DomainName> for DomainName

fn eq(&self, other: &DomainName) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DomainName) -> bool

This method tests for !=.

impl StructuralPartialEq for DomainName