aws_sdk_eks/operation/update_pod_identity_association/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_pod_identity_association::_update_pod_identity_association_output::UpdatePodIdentityAssociationOutputBuilder;
3
4pub use crate::operation::update_pod_identity_association::_update_pod_identity_association_input::UpdatePodIdentityAssociationInputBuilder;
5
6impl crate::operation::update_pod_identity_association::builders::UpdatePodIdentityAssociationInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::update_pod_identity_association::UpdatePodIdentityAssociationOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_pod_identity_association::UpdatePodIdentityAssociationError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_pod_identity_association();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdatePodIdentityAssociation`.
24///
25/// <p>Updates a EKS Pod Identity association. In an update, you can change the IAM role, the target IAM role, or <code>disableSessionTags</code>. You must change at least one of these in an update. An association can't be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or service account, you need to delete the association and then create a new association with your desired settings.</p>
26/// <p>Similar to Amazon Web Services IAM behavior, EKS Pod Identity associations are eventually consistent, and may take several seconds to be effective after the initial API call returns successfully. You must design your applications to account for these potential delays. We recommend that you don’t include association create/updates in the critical, high-availability code paths of your application. Instead, make changes in a separate initialization or setup routine that you run less frequently.</p>
27/// <p>You can set a <i>target IAM role</i> in the same or a different account for advanced scenarios. With a target role, EKS Pod Identity automatically performs two role assumptions in sequence: first assuming the role in the association that is in this account, then using those credentials to assume the target IAM role. This process provides your Pod with temporary credentials that have the permissions defined in the target role, allowing secure access to resources in another Amazon Web Services account.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct UpdatePodIdentityAssociationFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::update_pod_identity_association::builders::UpdatePodIdentityAssociationInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::update_pod_identity_association::UpdatePodIdentityAssociationOutput,
37        crate::operation::update_pod_identity_association::UpdatePodIdentityAssociationError,
38    > for UpdatePodIdentityAssociationFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::update_pod_identity_association::UpdatePodIdentityAssociationOutput,
46            crate::operation::update_pod_identity_association::UpdatePodIdentityAssociationError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl UpdatePodIdentityAssociationFluentBuilder {
53    /// Creates a new `UpdatePodIdentityAssociationFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the UpdatePodIdentityAssociation as a reference.
62    pub fn as_input(&self) -> &crate::operation::update_pod_identity_association::builders::UpdatePodIdentityAssociationInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::update_pod_identity_association::UpdatePodIdentityAssociationOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::update_pod_identity_association::UpdatePodIdentityAssociationError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::update_pod_identity_association::UpdatePodIdentityAssociation::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::update_pod_identity_association::UpdatePodIdentityAssociation::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::update_pod_identity_association::UpdatePodIdentityAssociationOutput,
99        crate::operation::update_pod_identity_association::UpdatePodIdentityAssociationError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>The name of the cluster that you want to update the association in.</p>
114    pub fn cluster_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.cluster_name(input.into());
116        self
117    }
118    /// <p>The name of the cluster that you want to update the association in.</p>
119    pub fn set_cluster_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_cluster_name(input);
121        self
122    }
123    /// <p>The name of the cluster that you want to update the association in.</p>
124    pub fn get_cluster_name(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_cluster_name()
126    }
127    /// <p>The ID of the association to be updated.</p>
128    pub fn association_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.inner = self.inner.association_id(input.into());
130        self
131    }
132    /// <p>The ID of the association to be updated.</p>
133    pub fn set_association_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_association_id(input);
135        self
136    }
137    /// <p>The ID of the association to be updated.</p>
138    pub fn get_association_id(&self) -> &::std::option::Option<::std::string::String> {
139        self.inner.get_association_id()
140    }
141    /// <p>The new IAM role to change in the association.</p>
142    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.inner = self.inner.role_arn(input.into());
144        self
145    }
146    /// <p>The new IAM role to change in the association.</p>
147    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.inner = self.inner.set_role_arn(input);
149        self
150    }
151    /// <p>The new IAM role to change in the association.</p>
152    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
153        self.inner.get_role_arn()
154    }
155    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
156    pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
157        self.inner = self.inner.client_request_token(input.into());
158        self
159    }
160    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
161    pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
162        self.inner = self.inner.set_client_request_token(input);
163        self
164    }
165    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
166    pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
167        self.inner.get_client_request_token()
168    }
169    /// <p>Disable the automatic sessions tags that are appended by EKS Pod Identity.</p>
170    /// <p>EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to Amazon Web Services resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/pod-id-abac.html#pod-id-abac-tags">List of session tags added by EKS Pod Identity</a> in the <i>Amazon EKS User Guide</i>.</p>
171    /// <p>Amazon Web Services compresses inline session policies, managed policy ARNs, and session tags into a packed binary format that has a separate limit. If you receive a <code>PackedPolicyTooLarge</code> error indicating the packed binary format has exceeded the size limit, you can attempt to reduce the size by disabling the session tags added by EKS Pod Identity.</p>
172    pub fn disable_session_tags(mut self, input: bool) -> Self {
173        self.inner = self.inner.disable_session_tags(input);
174        self
175    }
176    /// <p>Disable the automatic sessions tags that are appended by EKS Pod Identity.</p>
177    /// <p>EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to Amazon Web Services resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/pod-id-abac.html#pod-id-abac-tags">List of session tags added by EKS Pod Identity</a> in the <i>Amazon EKS User Guide</i>.</p>
178    /// <p>Amazon Web Services compresses inline session policies, managed policy ARNs, and session tags into a packed binary format that has a separate limit. If you receive a <code>PackedPolicyTooLarge</code> error indicating the packed binary format has exceeded the size limit, you can attempt to reduce the size by disabling the session tags added by EKS Pod Identity.</p>
179    pub fn set_disable_session_tags(mut self, input: ::std::option::Option<bool>) -> Self {
180        self.inner = self.inner.set_disable_session_tags(input);
181        self
182    }
183    /// <p>Disable the automatic sessions tags that are appended by EKS Pod Identity.</p>
184    /// <p>EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to Amazon Web Services resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/pod-id-abac.html#pod-id-abac-tags">List of session tags added by EKS Pod Identity</a> in the <i>Amazon EKS User Guide</i>.</p>
185    /// <p>Amazon Web Services compresses inline session policies, managed policy ARNs, and session tags into a packed binary format that has a separate limit. If you receive a <code>PackedPolicyTooLarge</code> error indicating the packed binary format has exceeded the size limit, you can attempt to reduce the size by disabling the session tags added by EKS Pod Identity.</p>
186    pub fn get_disable_session_tags(&self) -> &::std::option::Option<bool> {
187        self.inner.get_disable_session_tags()
188    }
189    /// <p>The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod.</p>
190    /// <p>When you run applications on Amazon EKS, your application might need to access Amazon Web Services resources from a different role that exists in the same or different Amazon Web Services account. For example, your application running in “Account A” might need to access resources, such as buckets in “Account B” or within “Account A” itself. You can create a association to access Amazon Web Services resources in “Account B” by creating two IAM roles: a role in “Account A” and a role in “Account B” (which can be the same or different account), each with the necessary trust and permission policies. After you provide these roles in the <i>IAM role</i> and <i>Target IAM role</i> fields, EKS will perform role chaining to ensure your application gets the required permissions. This means Role A will assume Role B, allowing your Pods to securely access resources like S3 buckets in the target account.</p>
191    pub fn target_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
192        self.inner = self.inner.target_role_arn(input.into());
193        self
194    }
195    /// <p>The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod.</p>
196    /// <p>When you run applications on Amazon EKS, your application might need to access Amazon Web Services resources from a different role that exists in the same or different Amazon Web Services account. For example, your application running in “Account A” might need to access resources, such as buckets in “Account B” or within “Account A” itself. You can create a association to access Amazon Web Services resources in “Account B” by creating two IAM roles: a role in “Account A” and a role in “Account B” (which can be the same or different account), each with the necessary trust and permission policies. After you provide these roles in the <i>IAM role</i> and <i>Target IAM role</i> fields, EKS will perform role chaining to ensure your application gets the required permissions. This means Role A will assume Role B, allowing your Pods to securely access resources like S3 buckets in the target account.</p>
197    pub fn set_target_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
198        self.inner = self.inner.set_target_role_arn(input);
199        self
200    }
201    /// <p>The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod.</p>
202    /// <p>When you run applications on Amazon EKS, your application might need to access Amazon Web Services resources from a different role that exists in the same or different Amazon Web Services account. For example, your application running in “Account A” might need to access resources, such as buckets in “Account B” or within “Account A” itself. You can create a association to access Amazon Web Services resources in “Account B” by creating two IAM roles: a role in “Account A” and a role in “Account B” (which can be the same or different account), each with the necessary trust and permission policies. After you provide these roles in the <i>IAM role</i> and <i>Target IAM role</i> fields, EKS will perform role chaining to ensure your application gets the required permissions. This means Role A will assume Role B, allowing your Pods to securely access resources like S3 buckets in the target account.</p>
203    pub fn get_target_role_arn(&self) -> &::std::option::Option<::std::string::String> {
204        self.inner.get_target_role_arn()
205    }
206}