Package software.amazon.awssdk.services.cloudwatchlogs.model

Class PutAccountPolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.PutAccountPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutAccountPolicyRequest.Builder,PutAccountPolicyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutAccountPolicyRequest
extends CloudWatchLogsRequest
implements ToCopyableBuilder<PutAccountPolicyRequest.Builder,PutAccountPolicyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutAccountPolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutAccountPolicyRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	policyDocument()	Specify the data protection policy, in JSON.
String	policyName()	A name for the policy.
PolicyType	policyType()	Currently the only valid value for this parameter is DATA_PROTECTION_POLICY.
String	policyTypeAsString()	Currently the only valid value for this parameter is DATA_PROTECTION_POLICY.
Scope	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.
String	scopeAsString()	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.
List<SdkField<?>>	sdkFields()
static Class<? extends PutAccountPolicyRequest.Builder>	serializableBuilderClass()
PutAccountPolicyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

policyName

public final String policyName()

A name for the policy. This must be unique within the account.

Returns:

A name for the policy. This must be unique within the account.

policyDocument

public final 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.

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.

Returns:

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.

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.

policyType

public final PolicyType policyType()

Currently the only valid value for this parameter is DATA_PROTECTION_POLICY.

If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().

Returns:

Currently the only valid value for this parameter is DATA_PROTECTION_POLICY.

See Also:

PolicyType

policyTypeAsString

public final String policyTypeAsString()

Currently the only valid value for this parameter is DATA_PROTECTION_POLICY.

If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().

Returns:

Currently the only valid value for this parameter is DATA_PROTECTION_POLICY.

See Also:

PolicyType

scope

public final Scope 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.

If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

Returns:

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:

Scope

scopeAsString

public final String scopeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

Returns:

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:

Scope

toBuilder

public PutAccountPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutAccountPolicyRequest.Builder,PutAccountPolicyRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

builder

public static PutAccountPolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutAccountPolicyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo