Package software.amazon.awscdk.services.logs

Interface CfnAccountPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAccountPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-03T18:29:28.782Z")
@Stability(Stable)
public interface CfnAccountPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAccountPolicy.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.logs.*;
 CfnAccountPolicyProps cfnAccountPolicyProps = CfnAccountPolicyProps.builder()
         .policyDocument("policyDocument")
         .policyName("policyName")
         .policyType("policyType")
         // the properties below are optional
         .scope("scope")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAccountPolicyProps.Builder	A builder for CfnAccountPolicyProps
static final class	CfnAccountPolicyProps.Jsii$Proxy	An implementation for CfnAccountPolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnAccountPolicyProps.Builder	builder()
String	getPolicyDocument()	Specify the data protection policy, in JSON.
String	getPolicyName()	A name for the policy.
String	getPolicyType()	Currently the only valid value for this parameter is DATA_PROTECTION_POLICY .
default String	getScope()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPolicyDocument

@Stability(Stable)
@NotNull
String getPolicyDocument()

Specify the data protection policy, in JSON.

This policy must include two JSON blocks:

• The first block must include both a DataIdentifer array and an Operation property with an Audit action. The DataIdentifer 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 an Audit action is required to find the sensitive data terms. This Audit action must contain a FindingsDestination object. You can optionally use that FindingsDestination object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, they must already exist.

• The second block must include both a DataIdentifer array and an Operation property with an Deidentify action. The DataIdentifer array must exactly match the DataIdentifer array in the first block of the policy.

The Operation property with the Deidentify 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html#cfn-logs-accountpolicy-policydocument

getPolicyName

@Stability(Stable)
@NotNull
String getPolicyName()

A name for the policy.

This must be unique within the account.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html#cfn-logs-accountpolicy-policyname

getPolicyType

@Stability(Stable)
@NotNull
String getPolicyType()

Currently the only valid value for this parameter is DATA_PROTECTION_POLICY .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html#cfn-logs-accountpolicy-policytype

getScope

@Stability(Stable)
@Nullable
default String getScope()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html#cfn-logs-accountpolicy-scope

builder

@Stability(Stable)
static CfnAccountPolicyProps.Builder builder()

Returns:

a CfnAccountPolicyProps.Builder of CfnAccountPolicyProps