Struct aws_sdk_cloudwatchlogs::operation::put_account_policy::builders::PutAccountPolicyInputBuilder
source · #[non_exhaustive]pub struct PutAccountPolicyInputBuilder { /* private fields */ }
Expand description
A builder for PutAccountPolicyInput
.
Implementations§
source§impl PutAccountPolicyInputBuilder
impl PutAccountPolicyInputBuilder
sourcepub fn policy_name(self, input: impl Into<String>) -> Self
pub fn policy_name(self, input: impl Into<String>) -> Self
A name for the policy. This must be unique within the account.
This field is required.sourcepub fn set_policy_name(self, input: Option<String>) -> Self
pub fn set_policy_name(self, input: Option<String>) -> Self
A name for the policy. This must be unique within the account.
sourcepub fn get_policy_name(&self) -> &Option<String>
pub fn get_policy_name(&self) -> &Option<String>
A name for the policy. This must be unique within the account.
sourcepub fn policy_document(self, input: impl Into<String>) -> Self
pub fn policy_document(self, input: impl Into<String>) -> Self
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 set_policy_document(self, input: Option<String>) -> Self
pub fn set_policy_document(self, input: Option<String>) -> Self
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 get_policy_document(&self) -> &Option<String>
pub fn get_policy_document(&self) -> &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.
sourcepub fn policy_type(self, input: PolicyType) -> Self
pub fn policy_type(self, input: PolicyType) -> Self
The type of policy that you're creating or updating.
This field is required.sourcepub fn set_policy_type(self, input: Option<PolicyType>) -> Self
pub fn set_policy_type(self, input: Option<PolicyType>) -> Self
The type of policy that you're creating or updating.
sourcepub fn get_policy_type(&self) -> &Option<PolicyType>
pub fn get_policy_type(&self) -> &Option<PolicyType>
The type of policy that you're creating or updating.
sourcepub fn scope(self, input: Scope) -> Self
pub fn scope(self, input: Scope) -> Self
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 set_scope(self, input: Option<Scope>) -> Self
pub fn set_scope(self, input: Option<Scope>) -> Self
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 get_scope(&self) -> &Option<Scope>
pub fn get_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, input: impl Into<String>) -> Self
pub fn selection_criteria(self, input: impl Into<String>) -> Self
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
.
sourcepub fn set_selection_criteria(self, input: Option<String>) -> Self
pub fn set_selection_criteria(self, input: Option<String>) -> Self
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
.
sourcepub fn get_selection_criteria(&self) -> &Option<String>
pub fn get_selection_criteria(&self) -> &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
.
sourcepub fn build(self) -> Result<PutAccountPolicyInput, BuildError>
pub fn build(self) -> Result<PutAccountPolicyInput, BuildError>
Consumes the builder and constructs a PutAccountPolicyInput
.
source§impl PutAccountPolicyInputBuilder
impl PutAccountPolicyInputBuilder
sourcepub async fn send_with(
self,
client: &Client,
) -> Result<PutAccountPolicyOutput, SdkError<PutAccountPolicyError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<PutAccountPolicyOutput, SdkError<PutAccountPolicyError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for PutAccountPolicyInputBuilder
impl Clone for PutAccountPolicyInputBuilder
source§fn clone(&self) -> PutAccountPolicyInputBuilder
fn clone(&self) -> PutAccountPolicyInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PutAccountPolicyInputBuilder
impl Debug for PutAccountPolicyInputBuilder
source§impl Default for PutAccountPolicyInputBuilder
impl Default for PutAccountPolicyInputBuilder
source§fn default() -> PutAccountPolicyInputBuilder
fn default() -> PutAccountPolicyInputBuilder
source§impl PartialEq for PutAccountPolicyInputBuilder
impl PartialEq for PutAccountPolicyInputBuilder
source§fn eq(&self, other: &PutAccountPolicyInputBuilder) -> bool
fn eq(&self, other: &PutAccountPolicyInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for PutAccountPolicyInputBuilder
Auto Trait Implementations§
impl Freeze for PutAccountPolicyInputBuilder
impl RefUnwindSafe for PutAccountPolicyInputBuilder
impl Send for PutAccountPolicyInputBuilder
impl Sync for PutAccountPolicyInputBuilder
impl Unpin for PutAccountPolicyInputBuilder
impl UnwindSafe for PutAccountPolicyInputBuilder
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