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

All Methods Static Methods Instance Methods Concrete Methods
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 policy, in JSON.
`String`	`policyName()`	A name for the policy.
`PolicyType`	`policyType()`	The type of policy that you're creating or updating.
`String`	`policyTypeAsString()`	The type of policy that you're creating or updating.
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`String`	`selectionCriteria()`	Use this parameter to apply the subscription filter policy to a subset of log groups in the account.
`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 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 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, 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 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.
    Returns:
    
    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 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, 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 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.
  - policyType
```
public final PolicyType policyType()
```
    The type of policy that you're creating or updating.
    
    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:
    
    The type of policy that you're creating or updating.
    
    See Also:
    
    PolicyType
  - policyTypeAsString
```
public final String policyTypeAsString()
```
    The type of policy that you're creating or updating.
    
    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:
    
    The type of policy that you're creating or updating.
    
    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
  - selectionCriteria
```
public final String selectionCriteria()
```
    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.
    
    Returns:
    
    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.
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class PutAccountPolicyRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

policyName

policyDocument

policyType

policyTypeAsString

scope

scopeAsString

selectionCriteria

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField