#[non_exhaustive]pub struct GetDomainNameOutput {Show 22 fields
pub domain_name: Option<String>,
pub domain_name_id: Option<String>,
pub domain_name_arn: Option<String>,
pub certificate_name: Option<String>,
pub certificate_arn: Option<String>,
pub certificate_upload_date: Option<DateTime>,
pub regional_domain_name: Option<String>,
pub regional_hosted_zone_id: Option<String>,
pub regional_certificate_name: Option<String>,
pub regional_certificate_arn: Option<String>,
pub distribution_domain_name: Option<String>,
pub distribution_hosted_zone_id: Option<String>,
pub endpoint_configuration: Option<EndpointConfiguration>,
pub domain_name_status: Option<DomainNameStatus>,
pub domain_name_status_message: Option<String>,
pub security_policy: Option<SecurityPolicy>,
pub tags: Option<HashMap<String, String>>,
pub mutual_tls_authentication: Option<MutualTlsAuthentication>,
pub ownership_verification_certificate_arn: Option<String>,
pub management_policy: Option<String>,
pub policy: Option<String>,
pub routing_mode: Option<RoutingMode>,
/* private fields */
}Expand description
Represents a custom domain name as a user-friendly host name of an API (RestApi).
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.domain_name: Option<String>The custom domain name as an API host name, for example, my-api.example.com.
domain_name_id: Option<String>The identifier for the domain name resource. Supported only for private custom domain names.
domain_name_arn: Option<String>The ARN of the domain name.
certificate_name: Option<String>The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
certificate_arn: Option<String>The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.
certificate_upload_date: Option<DateTime>The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.
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.
regional_certificate_name: Option<String>The name of the certificate that will be used for validating the regional domain name.
regional_certificate_arn: 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.
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.
endpoint_configuration: Option<EndpointConfiguration>The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
domain_name_status: 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.
domain_name_status_message: Option<String>An optional text message containing detailed information about status of the DomainName migration.
security_policy: Option<SecurityPolicy>The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
The collection of tags. Each tag element is associated with a given resource.
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.
ownership_verification_certificate_arn: 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.
management_policy: Option<String>A stringified JSON policy document that applies to the API Gateway Management service for this DomainName. This policy document controls access for access association sources to create domain name access associations with this DomainName. Supported only for private custom domain names.
policy: Option<String>A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.
routing_mode: Option<RoutingMode>The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.
Implementations§
Source§impl GetDomainNameOutput
impl GetDomainNameOutput
Sourcepub fn domain_name(&self) -> Option<&str>
pub fn domain_name(&self) -> Option<&str>
The custom domain name as an API host name, for example, my-api.example.com.
Sourcepub fn domain_name_id(&self) -> Option<&str>
pub fn domain_name_id(&self) -> Option<&str>
The identifier for the domain name resource. Supported only for private custom domain names.
Sourcepub fn domain_name_arn(&self) -> Option<&str>
pub fn domain_name_arn(&self) -> Option<&str>
The ARN of the domain name.
Sourcepub fn certificate_name(&self) -> Option<&str>
pub fn certificate_name(&self) -> Option<&str>
The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
Sourcepub fn certificate_arn(&self) -> Option<&str>
pub fn certificate_arn(&self) -> Option<&str>
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.
Sourcepub fn certificate_upload_date(&self) -> Option<&DateTime>
pub fn certificate_upload_date(&self) -> Option<&DateTime>
The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.
Sourcepub fn regional_domain_name(&self) -> Option<&str>
pub fn regional_domain_name(&self) -> Option<&str>
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.
Sourcepub fn regional_hosted_zone_id(&self) -> Option<&str>
pub fn regional_hosted_zone_id(&self) -> Option<&str>
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.
Sourcepub fn regional_certificate_name(&self) -> Option<&str>
pub fn regional_certificate_name(&self) -> Option<&str>
The name of the certificate that will be used for validating the regional domain name.
Sourcepub fn regional_certificate_arn(&self) -> Option<&str>
pub fn regional_certificate_arn(&self) -> Option<&str>
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.
Sourcepub fn distribution_domain_name(&self) -> Option<&str>
pub fn distribution_domain_name(&self) -> Option<&str>
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.
Sourcepub fn distribution_hosted_zone_id(&self) -> Option<&str>
pub fn distribution_hosted_zone_id(&self) -> Option<&str>
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.
Sourcepub fn endpoint_configuration(&self) -> Option<&EndpointConfiguration>
pub fn endpoint_configuration(&self) -> Option<&EndpointConfiguration>
The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
Sourcepub fn domain_name_status(&self) -> Option<&DomainNameStatus>
pub fn 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.
Sourcepub fn domain_name_status_message(&self) -> Option<&str>
pub fn domain_name_status_message(&self) -> Option<&str>
An optional text message containing detailed information about status of the DomainName migration.
Sourcepub fn security_policy(&self) -> Option<&SecurityPolicy>
pub fn 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.
The collection of tags. Each tag element is associated with a given resource.
Sourcepub fn mutual_tls_authentication(&self) -> Option<&MutualTlsAuthentication>
pub fn 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.
Sourcepub fn ownership_verification_certificate_arn(&self) -> Option<&str>
pub fn ownership_verification_certificate_arn(&self) -> Option<&str>
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.
Sourcepub fn management_policy(&self) -> Option<&str>
pub fn management_policy(&self) -> Option<&str>
A stringified JSON policy document that applies to the API Gateway Management service for this DomainName. This policy document controls access for access association sources to create domain name access associations with this DomainName. Supported only for private custom domain names.
Sourcepub fn policy(&self) -> Option<&str>
pub fn policy(&self) -> Option<&str>
A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.
Sourcepub fn routing_mode(&self) -> Option<&RoutingMode>
pub fn routing_mode(&self) -> Option<&RoutingMode>
The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.
Source§impl GetDomainNameOutput
impl GetDomainNameOutput
Sourcepub fn builder() -> GetDomainNameOutputBuilder
pub fn builder() -> GetDomainNameOutputBuilder
Creates a new builder-style object to manufacture GetDomainNameOutput.
Trait Implementations§
Source§impl Clone for GetDomainNameOutput
impl Clone for GetDomainNameOutput
Source§fn clone(&self) -> GetDomainNameOutput
fn clone(&self) -> GetDomainNameOutput
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for GetDomainNameOutput
impl Debug for GetDomainNameOutput
Source§impl PartialEq for GetDomainNameOutput
impl PartialEq for GetDomainNameOutput
Source§impl RequestId for GetDomainNameOutput
impl RequestId for GetDomainNameOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.impl StructuralPartialEq for GetDomainNameOutput
Auto Trait Implementations§
impl Freeze for GetDomainNameOutput
impl RefUnwindSafe for GetDomainNameOutput
impl Send for GetDomainNameOutput
impl Sync for GetDomainNameOutput
impl Unpin for GetDomainNameOutput
impl UnwindSafe for GetDomainNameOutput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);