Class CfnAccountPolicyProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAccountPolicyProps>
- Enclosing interface:
CfnAccountPolicyProps
CfnAccountPolicyProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.policyDocument
(String policyDocument) Sets the value ofCfnAccountPolicyProps.getPolicyDocument()
policyName
(String policyName) Sets the value ofCfnAccountPolicyProps.getPolicyName()
policyType
(String policyType) Sets the value ofCfnAccountPolicyProps.getPolicyType()
Sets the value ofCfnAccountPolicyProps.getScope()
selectionCriteria
(String selectionCriteria) Sets the value ofCfnAccountPolicyProps.getSelectionCriteria()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
policyDocument
Sets the value ofCfnAccountPolicyProps.getPolicyDocument()
- Parameters:
policyDocument
- Specify the policy, in JSON. This parameter is required. Data protection policyA 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.The contents of the two
DataIdentifer
arrays must match exactly.In addition to the two JSON blocks, the
policyDocument
can also includeName
,Description
, andVersion
fields. TheName
is different than the operation'spolicyName
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.
- Distribution The 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.
- The first block must include both a
- Returns:
this
-
policyName
Sets the value ofCfnAccountPolicyProps.getPolicyName()
- Parameters:
policyName
- A name for the policy. This parameter is required. This must be unique within the account.- Returns:
this
-
policyType
Sets the value ofCfnAccountPolicyProps.getPolicyType()
- Parameters:
policyType
- The type of policy that you're creating or updating. This parameter is required.- Returns:
this
-
scope
Sets the value ofCfnAccountPolicyProps.getScope()
- Parameters:
scope
- Currently the only valid value for this parameter isALL
, which specifies that the policy applies to all log groups in the account. If you omit this parameter, the default ofALL
is used. To scope down a subscription filter policy to a subset of log groups, use theselectionCriteria
parameter.- Returns:
this
-
selectionCriteria
Sets the value ofCfnAccountPolicyProps.getSelectionCriteria()
- Parameters:
selectionCriteria
- Use this parameter to apply a subscription filter policy to a subset of log groups in the account. Currently, the only supported filter isLogGroupName NOT IN []
. TheselectionCriteria
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 specifySUBSCRIPTION_FILTER_POLICY
forpolicyType
.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnAccountPolicyProps>
- Returns:
- a new instance of
CfnAccountPolicyProps
- Throws:
NullPointerException
- if any required attribute was not provided
-