aws_sdk_ssm/operation/put_resource_policy/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::put_resource_policy::_put_resource_policy_output::PutResourcePolicyOutputBuilder;
3
4pub use crate::operation::put_resource_policy::_put_resource_policy_input::PutResourcePolicyInputBuilder;
5
6impl crate::operation::put_resource_policy::builders::PutResourcePolicyInputBuilder {
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::put_resource_policy::PutResourcePolicyOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::put_resource_policy::PutResourcePolicyError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.put_resource_policy();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `PutResourcePolicy`.
24///
25/// <p>Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.</p>
26/// <ul>
27/// <li>
28/// <p><code>OpsItemGroup</code> - The resource policy for <code>OpsItemGroup</code> enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).</p></li>
29/// <li>
30/// <p><code>Parameter</code> - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM).</p>
31/// <p>To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html">Managing parameter tiers</a>. For information about changing an existing standard parameter to an advanced parameter, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#parameter-store-advanced-parameters-enabling">Changing a standard parameter to an advanced parameter</a>.</p>
32/// <p>To share a <code>SecureString</code> parameter, it must be encrypted with a customer managed key, and you must share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed key instead. For KMS key definitions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html">KMS concepts</a> in the <i>Key Management Service Developer Guide</i>.</p><important>
33/// <p>While you can share a parameter using the Systems Manager <code>PutResourcePolicy</code> operation, we recommend using Resource Access Manager (RAM) instead. This is because using <code>PutResourcePolicy</code> requires the extra step of promoting the parameter to a standard RAM Resource Share using the RAM <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html">PromoteResourceShareCreatedFromPolicy</a> API operation. Otherwise, the parameter won't be returned by the Systems Manager <a href="https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribeParameters.html">DescribeParameters</a> API operation using the <code>--shared</code> option.</p>
34/// <p>For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html#share">Sharing a parameter</a> in the <i>Amazon Web Services Systems Manager User Guide</i></p>
35/// </important></li>
36/// </ul>
37#[derive(::std::clone::Clone, ::std::fmt::Debug)]
38pub struct PutResourcePolicyFluentBuilder {
39 handle: ::std::sync::Arc<crate::client::Handle>,
40 inner: crate::operation::put_resource_policy::builders::PutResourcePolicyInputBuilder,
41 config_override: ::std::option::Option<crate::config::Builder>,
42}
43impl
44 crate::client::customize::internal::CustomizableSend<
45 crate::operation::put_resource_policy::PutResourcePolicyOutput,
46 crate::operation::put_resource_policy::PutResourcePolicyError,
47 > for PutResourcePolicyFluentBuilder
48{
49 fn send(
50 self,
51 config_override: crate::config::Builder,
52 ) -> crate::client::customize::internal::BoxFuture<
53 crate::client::customize::internal::SendResult<
54 crate::operation::put_resource_policy::PutResourcePolicyOutput,
55 crate::operation::put_resource_policy::PutResourcePolicyError,
56 >,
57 > {
58 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
59 }
60}
61impl PutResourcePolicyFluentBuilder {
62 /// Creates a new `PutResourcePolicyFluentBuilder`.
63 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
64 Self {
65 handle,
66 inner: ::std::default::Default::default(),
67 config_override: ::std::option::Option::None,
68 }
69 }
70 /// Access the PutResourcePolicy as a reference.
71 pub fn as_input(&self) -> &crate::operation::put_resource_policy::builders::PutResourcePolicyInputBuilder {
72 &self.inner
73 }
74 /// Sends the request and returns the response.
75 ///
76 /// If an error occurs, an `SdkError` will be returned with additional details that
77 /// can be matched against.
78 ///
79 /// By default, any retryable failures will be retried twice. Retry behavior
80 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
81 /// set when configuring the client.
82 pub async fn send(
83 self,
84 ) -> ::std::result::Result<
85 crate::operation::put_resource_policy::PutResourcePolicyOutput,
86 ::aws_smithy_runtime_api::client::result::SdkError<
87 crate::operation::put_resource_policy::PutResourcePolicyError,
88 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
89 >,
90 > {
91 let input = self
92 .inner
93 .build()
94 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
95 let runtime_plugins = crate::operation::put_resource_policy::PutResourcePolicy::operation_runtime_plugins(
96 self.handle.runtime_plugins.clone(),
97 &self.handle.conf,
98 self.config_override,
99 );
100 crate::operation::put_resource_policy::PutResourcePolicy::orchestrate(&runtime_plugins, input).await
101 }
102
103 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
104 pub fn customize(
105 self,
106 ) -> crate::client::customize::CustomizableOperation<
107 crate::operation::put_resource_policy::PutResourcePolicyOutput,
108 crate::operation::put_resource_policy::PutResourcePolicyError,
109 Self,
110 > {
111 crate::client::customize::CustomizableOperation::new(self)
112 }
113 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
114 self.set_config_override(::std::option::Option::Some(config_override.into()));
115 self
116 }
117
118 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
119 self.config_override = config_override;
120 self
121 }
122 /// <p>Amazon Resource Name (ARN) of the resource to which you want to attach a policy.</p>
123 pub fn resource_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
124 self.inner = self.inner.resource_arn(input.into());
125 self
126 }
127 /// <p>Amazon Resource Name (ARN) of the resource to which you want to attach a policy.</p>
128 pub fn set_resource_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
129 self.inner = self.inner.set_resource_arn(input);
130 self
131 }
132 /// <p>Amazon Resource Name (ARN) of the resource to which you want to attach a policy.</p>
133 pub fn get_resource_arn(&self) -> &::std::option::Option<::std::string::String> {
134 self.inner.get_resource_arn()
135 }
136 /// <p>A policy you want to associate with a resource.</p>
137 pub fn policy(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
138 self.inner = self.inner.policy(input.into());
139 self
140 }
141 /// <p>A policy you want to associate with a resource.</p>
142 pub fn set_policy(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
143 self.inner = self.inner.set_policy(input);
144 self
145 }
146 /// <p>A policy you want to associate with a resource.</p>
147 pub fn get_policy(&self) -> &::std::option::Option<::std::string::String> {
148 self.inner.get_policy()
149 }
150 /// <p>The policy ID.</p>
151 pub fn policy_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
152 self.inner = self.inner.policy_id(input.into());
153 self
154 }
155 /// <p>The policy ID.</p>
156 pub fn set_policy_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
157 self.inner = self.inner.set_policy_id(input);
158 self
159 }
160 /// <p>The policy ID.</p>
161 pub fn get_policy_id(&self) -> &::std::option::Option<::std::string::String> {
162 self.inner.get_policy_id()
163 }
164 /// <p>ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.</p>
165 pub fn policy_hash(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
166 self.inner = self.inner.policy_hash(input.into());
167 self
168 }
169 /// <p>ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.</p>
170 pub fn set_policy_hash(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
171 self.inner = self.inner.set_policy_hash(input);
172 self
173 }
174 /// <p>ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.</p>
175 pub fn get_policy_hash(&self) -> &::std::option::Option<::std::string::String> {
176 self.inner.get_policy_hash()
177 }
178}