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

Interface PutAccountPolicyRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudWatchLogsRequest.Builder, CopyableBuilder<PutAccountPolicyRequest.Builder,PutAccountPolicyRequest>, SdkBuilder<PutAccountPolicyRequest.Builder,PutAccountPolicyRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutAccountPolicyRequest
public static interface PutAccountPolicyRequest.Builder extends CloudWatchLogsRequest.Builder, SdkPojo, CopyableBuilder<PutAccountPolicyRequest.Builder,PutAccountPolicyRequest>

  • Method Details

    • policyName

      PutAccountPolicyRequest.Builder policyName(String policyName)

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

      Parameters:
      policyName - A name for the policy. This must be unique within the account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policyDocument

      PutAccountPolicyRequest.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.

      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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • policyType

      PutAccountPolicyRequest.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • policyType

      PutAccountPolicyRequest.Builder policyType(PolicyType 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scope

      PutAccountPolicyRequest.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. If you omit this parameter, the default of ALL is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scope

      PutAccountPolicyRequest.Builder scope(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.

      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. If you omit this parameter, the default of ALL is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      PutAccountPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutAccountPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.