Struct aws_sdk_secretsmanager::operation::put_resource_policy::builders::PutResourcePolicyFluentBuilder

pub struct PutResourcePolicyFluentBuilder { /* private fields */ }

Fluent builder constructing a request to PutResourcePolicy.

Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager

For information about attaching a policy in the console, see Attach a permissions policy to a secret.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:PutResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

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 secret_id(self, input: impl Into<String>) -> Self

The ARN or name of the secret to attach the resource-based policy.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

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

The ARN or name of the secret to attach the resource-based policy.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

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

The ARN or name of the secret to attach the resource-based policy.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

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

A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.

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

A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.

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

A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.

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

Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren't blocked.

Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:

• Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)

• Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)

To review permissions to your secrets, see Determine who has permissions to your secrets.

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

Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren't blocked.

Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:

• Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)

• Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)

To review permissions to your secrets, see Determine who has permissions to your secrets.

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

Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren't blocked.

Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:

• Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)

• Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)

To review permissions to your secrets, see Determine who has permissions to your secrets.

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.