Struct aws_sdk_xray::operation::put_resource_policy::PutResourcePolicyInput

#[non_exhaustive]
pub struct PutResourcePolicyInput {
    pub policy_name: Option<String>,
    pub policy_document: Option<String>,
    pub policy_revision_id: Option<String>,
    pub bypass_policy_lockout_check: Option<bool>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

policy_name: Option<String>

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

policy_document: Option<String>

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

policy_revision_id: 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.

bypass_policy_lockout_check: 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.

Implementations

impl PutResourcePolicyInput

pub fn policy_name(&self) -> Option<&str>

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

pub fn policy_document(&self) -> Option<&str>

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

pub fn policy_revision_id(&self) -> Option<&str>

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) -> 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.

impl PutResourcePolicyInput

pub fn builder() -> PutResourcePolicyInputBuilder

Creates a new builder-style object to manufacture PutResourcePolicyInput.

Trait Implementations

impl Clone for PutResourcePolicyInput

fn clone(&self) -> PutResourcePolicyInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PutResourcePolicyInput

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

Formats the value using the given formatter.

impl PartialEq for PutResourcePolicyInput

fn eq(&self, other: &PutResourcePolicyInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PutResourcePolicyInput