Struct aws_sdk_xray::operation::put_resource_policy::builders::PutResourcePolicyFluentBuilder

pub struct PutResourcePolicyFluentBuilder { /* private fields */ }

Fluent builder constructing a request to PutResourcePolicy.

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.

Implementations

impl PutResourcePolicyFluentBuilder

pub fn as_input(&self) -> &PutResourcePolicyInputBuilder

Access the PutResourcePolicy as a reference.

pub async fn send( self ) -> Result<PutResourcePolicyOutput, SdkError<PutResourcePolicyError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<PutResourcePolicyOutput, PutResourcePolicyError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn policy_name(self, input: impl Into<String>) -> Self

The name of the resource policy. Must be unique within a specific Amazon Web Services account.

pub fn set_policy_name(self, input: Option<String>) -> Self

The name of the resource policy. Must be unique within a specific Amazon Web Services account.

pub fn get_policy_name(&self) -> &Option<String>

The name of the resource policy. Must be unique within a specific Amazon Web Services account.

pub fn policy_document(self, input: impl Into<String>) -> Self

The resource policy document, which can be up to 5kb in size.

pub fn set_policy_document(self, input: Option<String>) -> Self

The resource policy document, which can be up to 5kb in size.

pub fn get_policy_document(&self) -> &Option<String>

The resource policy document, which can be up to 5kb in size.

pub fn policy_revision_id(self, input: impl Into<String>) -> Self

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.

If the policy revision id does not match the latest revision id, the operation will fail with an InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a resource policy with the same name already exists.

pub fn set_policy_revision_id(self, input: Option<String>) -> Self

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.

If the policy revision id does not match the latest revision id, the operation will fail with an InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a resource policy with the same name already exists.

pub fn get_policy_revision_id(&self) -> &Option<String>

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.

If the policy revision id does not match the latest revision id, the operation will fail with an InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a resource policy with the same name already exists.

pub fn bypass_policy_lockout_check(self, input: bool) -> Self

A flag to indicate whether to bypass the resource policy lockout safety check.

Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.

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 PutResourcePolicy request.

The default value is false.

pub fn set_bypass_policy_lockout_check(self, input: Option<bool>) -> Self

A flag to indicate whether to bypass the resource policy lockout safety check.

Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.

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 PutResourcePolicy request.

The default value is false.

pub fn get_bypass_policy_lockout_check(&self) -> &Option<bool>

A flag to indicate whether to bypass the resource policy lockout safety check.

Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.

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 PutResourcePolicy request.

The default value is false.

Trait Implementations

impl Clone for PutResourcePolicyFluentBuilder

fn clone(&self) -> PutResourcePolicyFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PutResourcePolicyFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.