1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct PutResourcePolicyInput {
/// <p>The ARN or name of the secret to attach the resource-based policy.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
pub secret_id: ::std::option::Option<::std::string::String>,
/// <p>A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions policy examples</a>.</p>
pub resource_policy: ::std::option::Option<::std::string::String>,
/// <p>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.</p><important>
/// <p>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:</p>
/// <ul>
/// <li>
/// <p>Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)</p></li>
/// <li>
/// <p>Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)</p></li>
/// </ul>
/// <p>To review permissions to your secrets, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html">Determine who has permissions to your secrets</a>.</p>
/// </important>
pub block_public_policy: ::std::option::Option<bool>,
}
impl PutResourcePolicyInput {
/// <p>The ARN or name of the secret to attach the resource-based policy.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
pub fn secret_id(&self) -> ::std::option::Option<&str> {
self.secret_id.as_deref()
}
/// <p>A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions policy examples</a>.</p>
pub fn resource_policy(&self) -> ::std::option::Option<&str> {
self.resource_policy.as_deref()
}
/// <p>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.</p><important>
/// <p>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:</p>
/// <ul>
/// <li>
/// <p>Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)</p></li>
/// <li>
/// <p>Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)</p></li>
/// </ul>
/// <p>To review permissions to your secrets, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html">Determine who has permissions to your secrets</a>.</p>
/// </important>
pub fn block_public_policy(&self) -> ::std::option::Option<bool> {
self.block_public_policy
}
}
impl PutResourcePolicyInput {
/// Creates a new builder-style object to manufacture [`PutResourcePolicyInput`](crate::operation::put_resource_policy::PutResourcePolicyInput).
pub fn builder() -> crate::operation::put_resource_policy::builders::PutResourcePolicyInputBuilder {
crate::operation::put_resource_policy::builders::PutResourcePolicyInputBuilder::default()
}
}
/// A builder for [`PutResourcePolicyInput`](crate::operation::put_resource_policy::PutResourcePolicyInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct PutResourcePolicyInputBuilder {
pub(crate) secret_id: ::std::option::Option<::std::string::String>,
pub(crate) resource_policy: ::std::option::Option<::std::string::String>,
pub(crate) block_public_policy: ::std::option::Option<bool>,
}
impl PutResourcePolicyInputBuilder {
/// <p>The ARN or name of the secret to attach the resource-based policy.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
/// This field is required.
pub fn secret_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.secret_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN or name of the secret to attach the resource-based policy.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
pub fn set_secret_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.secret_id = input;
self
}
/// <p>The ARN or name of the secret to attach the resource-based policy.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
pub fn get_secret_id(&self) -> &::std::option::Option<::std::string::String> {
&self.secret_id
}
/// <p>A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions policy examples</a>.</p>
/// This field is required.
pub fn resource_policy(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.resource_policy = ::std::option::Option::Some(input.into());
self
}
/// <p>A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions policy examples</a>.</p>
pub fn set_resource_policy(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.resource_policy = input;
self
}
/// <p>A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions policy examples</a>.</p>
pub fn get_resource_policy(&self) -> &::std::option::Option<::std::string::String> {
&self.resource_policy
}
/// <p>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.</p><important>
/// <p>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:</p>
/// <ul>
/// <li>
/// <p>Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)</p></li>
/// <li>
/// <p>Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)</p></li>
/// </ul>
/// <p>To review permissions to your secrets, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html">Determine who has permissions to your secrets</a>.</p>
/// </important>
pub fn block_public_policy(mut self, input: bool) -> Self {
self.block_public_policy = ::std::option::Option::Some(input);
self
}
/// <p>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.</p><important>
/// <p>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:</p>
/// <ul>
/// <li>
/// <p>Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)</p></li>
/// <li>
/// <p>Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)</p></li>
/// </ul>
/// <p>To review permissions to your secrets, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html">Determine who has permissions to your secrets</a>.</p>
/// </important>
pub fn set_block_public_policy(mut self, input: ::std::option::Option<bool>) -> Self {
self.block_public_policy = input;
self
}
/// <p>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.</p><important>
/// <p>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:</p>
/// <ul>
/// <li>
/// <p>Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)</p></li>
/// <li>
/// <p>Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)</p></li>
/// </ul>
/// <p>To review permissions to your secrets, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html">Determine who has permissions to your secrets</a>.</p>
/// </important>
pub fn get_block_public_policy(&self) -> &::std::option::Option<bool> {
&self.block_public_policy
}
/// Consumes the builder and constructs a [`PutResourcePolicyInput`](crate::operation::put_resource_policy::PutResourcePolicyInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::put_resource_policy::PutResourcePolicyInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::put_resource_policy::PutResourcePolicyInput {
secret_id: self.secret_id,
resource_policy: self.resource_policy,
block_public_policy: self.block_public_policy,
})
}
}