aws_sdk_xray/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>Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct PutResourcePolicyFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::put_resource_policy::builders::PutResourcePolicyInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::put_resource_policy::PutResourcePolicyOutput,
35 crate::operation::put_resource_policy::PutResourcePolicyError,
36 > for PutResourcePolicyFluentBuilder
37{
38 fn send(
39 self,
40 config_override: crate::config::Builder,
41 ) -> crate::client::customize::internal::BoxFuture<
42 crate::client::customize::internal::SendResult<
43 crate::operation::put_resource_policy::PutResourcePolicyOutput,
44 crate::operation::put_resource_policy::PutResourcePolicyError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl PutResourcePolicyFluentBuilder {
51 /// Creates a new `PutResourcePolicyFluentBuilder`.
52 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53 Self {
54 handle,
55 inner: ::std::default::Default::default(),
56 config_override: ::std::option::Option::None,
57 }
58 }
59 /// Access the PutResourcePolicy as a reference.
60 pub fn as_input(&self) -> &crate::operation::put_resource_policy::builders::PutResourcePolicyInputBuilder {
61 &self.inner
62 }
63 /// Sends the request and returns the response.
64 ///
65 /// If an error occurs, an `SdkError` will be returned with additional details that
66 /// can be matched against.
67 ///
68 /// By default, any retryable failures will be retried twice. Retry behavior
69 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70 /// set when configuring the client.
71 pub async fn send(
72 self,
73 ) -> ::std::result::Result<
74 crate::operation::put_resource_policy::PutResourcePolicyOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::put_resource_policy::PutResourcePolicyError,
77 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78 >,
79 > {
80 let input = self
81 .inner
82 .build()
83 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84 let runtime_plugins = crate::operation::put_resource_policy::PutResourcePolicy::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::put_resource_policy::PutResourcePolicy::orchestrate(&runtime_plugins, input).await
90 }
91
92 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93 pub fn customize(
94 self,
95 ) -> crate::client::customize::CustomizableOperation<
96 crate::operation::put_resource_policy::PutResourcePolicyOutput,
97 crate::operation::put_resource_policy::PutResourcePolicyError,
98 Self,
99 > {
100 crate::client::customize::CustomizableOperation::new(self)
101 }
102 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103 self.set_config_override(::std::option::Option::Some(config_override.into()));
104 self
105 }
106
107 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108 self.config_override = config_override;
109 self
110 }
111 /// <p>The name of the resource policy. Must be unique within a specific Amazon Web Services account.</p>
112 pub fn policy_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113 self.inner = self.inner.policy_name(input.into());
114 self
115 }
116 /// <p>The name of the resource policy. Must be unique within a specific Amazon Web Services account.</p>
117 pub fn set_policy_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118 self.inner = self.inner.set_policy_name(input);
119 self
120 }
121 /// <p>The name of the resource policy. Must be unique within a specific Amazon Web Services account.</p>
122 pub fn get_policy_name(&self) -> &::std::option::Option<::std::string::String> {
123 self.inner.get_policy_name()
124 }
125 /// <p>The resource policy document, which can be up to 5kb in size.</p>
126 pub fn policy_document(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127 self.inner = self.inner.policy_document(input.into());
128 self
129 }
130 /// <p>The resource policy document, which can be up to 5kb in size.</p>
131 pub fn set_policy_document(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132 self.inner = self.inner.set_policy_document(input);
133 self
134 }
135 /// <p>The resource policy document, which can be up to 5kb in size.</p>
136 pub fn get_policy_document(&self) -> &::std::option::Option<::std::string::String> {
137 self.inner.get_policy_document()
138 }
139 /// <p>Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.</p>
140 /// <p>If the policy revision id does not match the latest revision id, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception. You can also provide a <code>PolicyRevisionId</code> of 0. In this case, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception if a resource policy with the same name already exists.</p>
141 pub fn policy_revision_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
142 self.inner = self.inner.policy_revision_id(input.into());
143 self
144 }
145 /// <p>Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.</p>
146 /// <p>If the policy revision id does not match the latest revision id, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception. You can also provide a <code>PolicyRevisionId</code> of 0. In this case, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception if a resource policy with the same name already exists.</p>
147 pub fn set_policy_revision_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148 self.inner = self.inner.set_policy_revision_id(input);
149 self
150 }
151 /// <p>Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.</p>
152 /// <p>If the policy revision id does not match the latest revision id, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception. You can also provide a <code>PolicyRevisionId</code> of 0. In this case, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception if a resource policy with the same name already exists.</p>
153 pub fn get_policy_revision_id(&self) -> &::std::option::Option<::std::string::String> {
154 self.inner.get_policy_revision_id()
155 }
156 /// <p>A flag to indicate whether to bypass the resource policy lockout safety check.</p><important>
157 /// <p>Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.</p>
158 /// </important>
159 /// <p>Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent <code>PutResourcePolicy</code> request.</p>
160 /// <p>The default value is false.</p>
161 pub fn bypass_policy_lockout_check(mut self, input: bool) -> Self {
162 self.inner = self.inner.bypass_policy_lockout_check(input);
163 self
164 }
165 /// <p>A flag to indicate whether to bypass the resource policy lockout safety check.</p><important>
166 /// <p>Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.</p>
167 /// </important>
168 /// <p>Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent <code>PutResourcePolicy</code> request.</p>
169 /// <p>The default value is false.</p>
170 pub fn set_bypass_policy_lockout_check(mut self, input: ::std::option::Option<bool>) -> Self {
171 self.inner = self.inner.set_bypass_policy_lockout_check(input);
172 self
173 }
174 /// <p>A flag to indicate whether to bypass the resource policy lockout safety check.</p><important>
175 /// <p>Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.</p>
176 /// </important>
177 /// <p>Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent <code>PutResourcePolicy</code> request.</p>
178 /// <p>The default value is false.</p>
179 pub fn get_bypass_policy_lockout_check(&self) -> &::std::option::Option<bool> {
180 self.inner.get_bypass_policy_lockout_check()
181 }
182}