#[non_exhaustive]pub struct PutAccountPolicyInput {
pub policy_name: Option<String>,
pub policy_document: Option<String>,
pub policy_type: Option<PolicyType>,
pub scope: Option<Scope>,
pub selection_criteria: Option<String>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.policy_name: Option<String>
A name for the policy. This must be unique within the account.
policy_document: Option<String>
Specify the policy, in JSON.
Data protection policy
A data protection policy must include two JSON blocks:
-
The first block must include both a
DataIdentifer
array and anOperation
property with anAudit
action. TheDataIdentifer
array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask.The
Operation
property with anAudit
action is required to find the sensitive data terms. ThisAudit
action must contain aFindingsDestination
object. You can optionally use thatFindingsDestination
object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Firehose streams, and S3 buckets, they must already exist. -
The second block must include both a
DataIdentifer
array and anOperation
property with anDeidentify
action. TheDataIdentifer
array must exactly match theDataIdentifer
array in the first block of the policy.The
Operation
property with theDeidentify
action is what actually masks the data, and it must contain the"MaskConfig": {}
object. The"MaskConfig": {}
object must be empty.
For an example data protection policy, see the Examples section on this page.
The contents of the two DataIdentifer
arrays must match exactly.
In addition to the two JSON blocks, the policyDocument
can also include Name
, Description
, and Version
fields. The Name
is different than the operation's policyName
parameter, and is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.
The JSON specified in policyDocument
can be up to 30,720 characters long.
Subscription filter policy
A subscription filter policy can include the following attributes in a JSON block:
-
DestinationArn The ARN of the destination to deliver log events to. Supported destinations are:
-
An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
-
An Firehose data stream in the same account as the subscription policy, for same-account delivery.
-
A Lambda function in the same account as the subscription policy, for same-account delivery.
-
A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
-
-
RoleArn The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.
-
FilterPattern A filter pattern for subscribing to a filtered stream of log events.
-
DistributionThe method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to
Random
for a more even distribution. This property is only applicable when the destination is an Kinesis Data Streams data stream.
policy_type: Option<PolicyType>
The type of policy that you're creating or updating.
scope: Option<Scope>
Currently the only valid value for this parameter is ALL
, which specifies that the data protection policy applies to all log groups in the account. If you omit this parameter, the default of ALL
is used.
selection_criteria: Option<String>
Use this parameter to apply the subscription filter policy to a subset of log groups in the account. Currently, the only supported filter is LogGroupName NOT IN \[\]
. The selectionCriteria
string can be up to 25KB in length. The length is determined by using its UTF-8 bytes.
Using the selectionCriteria
parameter is useful to help prevent infinite loops. For more information, see Log recursion prevention.
Specifing selectionCriteria
is valid only when you specify SUBSCRIPTION_FILTER_POLICY
for policyType
.
Implementations§
source§impl PutAccountPolicyInput
impl PutAccountPolicyInput
sourcepub fn policy_name(&self) -> Option<&str>
pub fn policy_name(&self) -> Option<&str>
A name for the policy. This must be unique within the account.
sourcepub fn policy_document(&self) -> Option<&str>
pub fn policy_document(&self) -> Option<&str>
Specify the policy, in JSON.
Data protection policy
A data protection policy must include two JSON blocks:
-
The first block must include both a
DataIdentifer
array and anOperation
property with anAudit
action. TheDataIdentifer
array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask.The
Operation
property with anAudit
action is required to find the sensitive data terms. ThisAudit
action must contain aFindingsDestination
object. You can optionally use thatFindingsDestination
object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Firehose streams, and S3 buckets, they must already exist. -
The second block must include both a
DataIdentifer
array and anOperation
property with anDeidentify
action. TheDataIdentifer
array must exactly match theDataIdentifer
array in the first block of the policy.The
Operation
property with theDeidentify
action is what actually masks the data, and it must contain the"MaskConfig": {}
object. The"MaskConfig": {}
object must be empty.
For an example data protection policy, see the Examples section on this page.
The contents of the two DataIdentifer
arrays must match exactly.
In addition to the two JSON blocks, the policyDocument
can also include Name
, Description
, and Version
fields. The Name
is different than the operation's policyName
parameter, and is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.
The JSON specified in policyDocument
can be up to 30,720 characters long.
Subscription filter policy
A subscription filter policy can include the following attributes in a JSON block:
-
DestinationArn The ARN of the destination to deliver log events to. Supported destinations are:
-
An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
-
An Firehose data stream in the same account as the subscription policy, for same-account delivery.
-
A Lambda function in the same account as the subscription policy, for same-account delivery.
-
A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
-
-
RoleArn The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.
-
FilterPattern A filter pattern for subscribing to a filtered stream of log events.
-
DistributionThe method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to
Random
for a more even distribution. This property is only applicable when the destination is an Kinesis Data Streams data stream.
sourcepub fn policy_type(&self) -> Option<&PolicyType>
pub fn policy_type(&self) -> Option<&PolicyType>
The type of policy that you're creating or updating.
sourcepub fn scope(&self) -> Option<&Scope>
pub fn scope(&self) -> Option<&Scope>
Currently the only valid value for this parameter is ALL
, which specifies that the data protection policy applies to all log groups in the account. If you omit this parameter, the default of ALL
is used.
sourcepub fn selection_criteria(&self) -> Option<&str>
pub fn selection_criteria(&self) -> Option<&str>
Use this parameter to apply the subscription filter policy to a subset of log groups in the account. Currently, the only supported filter is LogGroupName NOT IN \[\]
. The selectionCriteria
string can be up to 25KB in length. The length is determined by using its UTF-8 bytes.
Using the selectionCriteria
parameter is useful to help prevent infinite loops. For more information, see Log recursion prevention.
Specifing selectionCriteria
is valid only when you specify SUBSCRIPTION_FILTER_POLICY
for policyType
.
source§impl PutAccountPolicyInput
impl PutAccountPolicyInput
sourcepub fn builder() -> PutAccountPolicyInputBuilder
pub fn builder() -> PutAccountPolicyInputBuilder
Creates a new builder-style object to manufacture PutAccountPolicyInput
.
Trait Implementations§
source§impl Clone for PutAccountPolicyInput
impl Clone for PutAccountPolicyInput
source§fn clone(&self) -> PutAccountPolicyInput
fn clone(&self) -> PutAccountPolicyInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PutAccountPolicyInput
impl Debug for PutAccountPolicyInput
source§impl PartialEq for PutAccountPolicyInput
impl PartialEq for PutAccountPolicyInput
source§fn eq(&self, other: &PutAccountPolicyInput) -> bool
fn eq(&self, other: &PutAccountPolicyInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for PutAccountPolicyInput
Auto Trait Implementations§
impl Freeze for PutAccountPolicyInput
impl RefUnwindSafe for PutAccountPolicyInput
impl Send for PutAccountPolicyInput
impl Sync for PutAccountPolicyInput
impl Unpin for PutAccountPolicyInput
impl UnwindSafe for PutAccountPolicyInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more