Skip to main content

aws_sdk_securityagent/client/
describe_private_connection.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribePrivateConnection`](crate::operation::describe_private_connection::builders::DescribePrivateConnectionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`private_connection_name(impl Into<String>)`](crate::operation::describe_private_connection::builders::DescribePrivateConnectionFluentBuilder::private_connection_name) / [`set_private_connection_name(Option<String>)`](crate::operation::describe_private_connection::builders::DescribePrivateConnectionFluentBuilder::set_private_connection_name):<br>required: **true**<br><p>The name of the private connection to describe.</p><br>
7    /// - On success, responds with [`DescribePrivateConnectionOutput`](crate::operation::describe_private_connection::DescribePrivateConnectionOutput) with field(s):
8    ///   - [`name(String)`](crate::operation::describe_private_connection::DescribePrivateConnectionOutput::name): <p>The name of the private connection.</p>
9    ///   - [`r#type(PrivateConnectionType)`](crate::operation::describe_private_connection::DescribePrivateConnectionOutput::type): <p>The type of the private connection, indicating whether it is service-managed or self-managed.</p>
10    ///   - [`status(PrivateConnectionStatus)`](crate::operation::describe_private_connection::DescribePrivateConnectionOutput::status): <p>The current status of the private connection.</p>
11    ///   - [`resource_gateway_id(Option<String>)`](crate::operation::describe_private_connection::DescribePrivateConnectionOutput::resource_gateway_id): <p>The identifier or ARN of the VPC Lattice resource gateway.</p>
12    ///   - [`host_address(Option<String>)`](crate::operation::describe_private_connection::DescribePrivateConnectionOutput::host_address): <p>The IP address or DNS name of the target resource.</p>
13    ///   - [`vpc_id(Option<String>)`](crate::operation::describe_private_connection::DescribePrivateConnectionOutput::vpc_id): <p>The identifier of the VPC the resource gateway is created in.</p>
14    ///   - [`resource_configuration_id(Option<String>)`](crate::operation::describe_private_connection::DescribePrivateConnectionOutput::resource_configuration_id): <p>The identifier or ARN of the VPC Lattice resource configuration.</p>
15    ///   - [`certificate_expiry_time(Option<DateTime>)`](crate::operation::describe_private_connection::DescribePrivateConnectionOutput::certificate_expiry_time): <p>The date and time the connection's certificate expires, in UTC format.</p>
16    ///   - [`dns_resolution(Option<ResourceConfigDnsResolution>)`](crate::operation::describe_private_connection::DescribePrivateConnectionOutput::dns_resolution): <p>The DNS resolution mode for the resource gateway.</p>
17    ///   - [`failure_message(Option<String>)`](crate::operation::describe_private_connection::DescribePrivateConnectionOutput::failure_message): <p>A message describing why the private connection entered a failed state, if applicable.</p>
18    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_private_connection::DescribePrivateConnectionOutput::tags): <p>The tags attached to the private connection.</p>
19    /// - On failure, responds with [`SdkError<DescribePrivateConnectionError>`](crate::operation::describe_private_connection::DescribePrivateConnectionError)
20    pub fn describe_private_connection(&self) -> crate::operation::describe_private_connection::builders::DescribePrivateConnectionFluentBuilder {
21        crate::operation::describe_private_connection::builders::DescribePrivateConnectionFluentBuilder::new(self.handle.clone())
22    }
23}