aws_sdk_networkfirewall/client/describe_container_association.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 [`DescribeContainerAssociation`](crate::operation::describe_container_association::builders::DescribeContainerAssociationFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`container_association_name(impl Into<String>)`](crate::operation::describe_container_association::builders::DescribeContainerAssociationFluentBuilder::container_association_name) / [`set_container_association_name(Option<String>)`](crate::operation::describe_container_association::builders::DescribeContainerAssociationFluentBuilder::set_container_association_name):<br>required: **false**<br><p>The descriptive name of the container association.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
7 /// - [`container_association_arn(impl Into<String>)`](crate::operation::describe_container_association::builders::DescribeContainerAssociationFluentBuilder::container_association_arn) / [`set_container_association_arn(Option<String>)`](crate::operation::describe_container_association::builders::DescribeContainerAssociationFluentBuilder::set_container_association_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the container association.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
8 /// - On success, responds with [`DescribeContainerAssociationOutput`](crate::operation::describe_container_association::DescribeContainerAssociationOutput) with field(s):
9 /// - [`container_association_name(Option<String>)`](crate::operation::describe_container_association::DescribeContainerAssociationOutput::container_association_name): <p>The descriptive name of the container association.</p>
10 /// - [`container_association_arn(Option<String>)`](crate::operation::describe_container_association::DescribeContainerAssociationOutput::container_association_arn): <p>The Amazon Resource Name (ARN) of the container association.</p>
11 /// - [`description(Option<String>)`](crate::operation::describe_container_association::DescribeContainerAssociationOutput::description): <p>A description of the container association.</p>
12 /// - [`r#type(Option<ContainerMonitoringType>)`](crate::operation::describe_container_association::DescribeContainerAssociationOutput::type): <p>The container type. Valid values:</p> <ul> <li> <p><code>ECS</code> - Amazon Elastic Container Service</p></li> <li> <p><code>EKS</code> - Amazon Elastic Kubernetes Service</p></li> </ul>
13 /// - [`container_monitoring_configurations(Option<Vec::<ContainerMonitoringConfiguration>>)`](crate::operation::describe_container_association::DescribeContainerAssociationOutput::container_monitoring_configurations): <p>The monitoring configurations for the container association.</p>
14 /// - [`status(Option<ContainerAssociationStatus>)`](crate::operation::describe_container_association::DescribeContainerAssociationOutput::status): <p>The current status of the container association.</p>
15 /// - [`resolved_cidr_count(Option<i32>)`](crate::operation::describe_container_association::DescribeContainerAssociationOutput::resolved_cidr_count): <p>The number of CIDR blocks resolved from the monitored containers.</p>
16 /// - [`last_updated_time(Option<DateTime>)`](crate::operation::describe_container_association::DescribeContainerAssociationOutput::last_updated_time): <p>The most recent time that Network Firewall updated the container association.</p>
17 /// - [`tags(Option<Vec::<Tag>>)`](crate::operation::describe_container_association::DescribeContainerAssociationOutput::tags): <p>The key:value pairs to associate with the resource.</p>
18 /// - [`update_token(Option<String>)`](crate::operation::describe_container_association::DescribeContainerAssociationOutput::update_token): <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request.</p> <p>To make changes to the container association, you provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the container association again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.</p>
19 /// - On failure, responds with [`SdkError<DescribeContainerAssociationError>`](crate::operation::describe_container_association::DescribeContainerAssociationError)
20 pub fn describe_container_association(
21 &self,
22 ) -> crate::operation::describe_container_association::builders::DescribeContainerAssociationFluentBuilder {
23 crate::operation::describe_container_association::builders::DescribeContainerAssociationFluentBuilder::new(self.handle.clone())
24 }
25}