Package software.amazon.awscdk.services.logs

Class CfnAccountPolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.logs.CfnAccountPolicy
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)", date="2024-01-03T18:29:28.781Z") @Stability(Stable) public class CfnAccountPolicy extends CfnResource implements IInspectable
Creates or updates an account-level data protection policy that applies to all log groups in the account.

A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level policy.

Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.

If you create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking .

To create an account-level policy, you must be signed on with the logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions.

An account-level policy applies to all log groups in the account. You can also create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

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.*;
 CfnAccountPolicy cfnAccountPolicy = CfnAccountPolicy.Builder.create(this, "MyCfnAccountPolicy")
         .policyDocument("policyDocument")
         .policyName("policyName")
         .policyType("policyType")
         // the properties below are optional
         .scope("scope")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAccountPolicy

      protected CfnAccountPolicy(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAccountPolicy

      protected CfnAccountPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAccountPolicy

      @Stability(Stable) public CfnAccountPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAccountPolicyProps props)
      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAccountId

      @Stability(Stable) @NotNull public String getAttrAccountId()
      The account ID of the account where this policy was created.

      For example, 123456789012 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPolicyDocument

      @Stability(Stable) @NotNull public String getPolicyDocument()
      Specify the data protection policy, in JSON.

    • setPolicyDocument

      @Stability(Stable) public void setPolicyDocument(@NotNull String value)
      Specify the data protection policy, in JSON.

    • getPolicyName

      @Stability(Stable) @NotNull public String getPolicyName()
      A name for the policy.

    • setPolicyName

      @Stability(Stable) public void setPolicyName(@NotNull String value)
      A name for the policy.

    • getPolicyType

      @Stability(Stable) @NotNull public String getPolicyType()
      Currently the only valid value for this parameter is DATA_PROTECTION_POLICY .

    • setPolicyType

      @Stability(Stable) public void setPolicyType(@NotNull String value)
      Currently the only valid value for this parameter is DATA_PROTECTION_POLICY .

    • getScope

      @Stability(Stable) @Nullable public 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.

    • setScope

      @Stability(Stable) public void setScope(@Nullable String value)
      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.