Package software.amazon.awscdk.services.logs

Class CfnAccountPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.logs.CfnAccountPolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAccountPolicy>

Enclosing class:

CfnAccountPolicy

@Stability(Stable)
public static final class CfnAccountPolicy.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAccountPolicy>

A fluent builder for CfnAccountPolicy.

Method Summary

Modifier and Type	Method	Description
CfnAccountPolicy	build()
static CfnAccountPolicy.Builder	create(software.constructs.Construct scope, String id)
CfnAccountPolicy.Builder	policyDocument(String policyDocument)	Specify the data protection policy, in JSON.
CfnAccountPolicy.Builder	policyName(String policyName)	A name for the policy.
CfnAccountPolicy.Builder	policyType(String policyType)	Currently the only valid value for this parameter is DATA_PROTECTION_POLICY .
CfnAccountPolicy.Builder	scope(String 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnAccountPolicy.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnAccountPolicy.Builder.

policyDocument

@Stability(Stable)
public CfnAccountPolicy.Builder policyDocument(String policyDocument)

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.

Parameters:

policyDocument - Specify the data protection policy, in JSON. This parameter is required.

Returns:

this

See Also:

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

policyName

@Stability(Stable)
public CfnAccountPolicy.Builder policyName(String policyName)

A name for the policy.

This must be unique within the account.

Parameters:

policyName - A name for the policy. This parameter is required.

Returns:

this

See Also:

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

policyType

@Stability(Stable)
public CfnAccountPolicy.Builder policyType(String policyType)

Currently the only valid value for this parameter is DATA_PROTECTION_POLICY .

Parameters:

policyType - Currently the only valid value for this parameter is DATA_PROTECTION_POLICY . This parameter is required.

Returns:

this

See Also:

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

scope

@Stability(Stable)
public CfnAccountPolicy.Builder scope(String 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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAccountPolicy build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAccountPolicy>

Returns:

a newly built instance of CfnAccountPolicy.