AWS::Logs::AccountPolicy

Creates or updates an account-level data protection policy or subscription filter policy that applies to all log groups or a subset of log groups in the account.

Data protection policy

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 data protection policy.

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.

Subscription filter policy

A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

The following destinations are supported for subscription filters:

Each account can have one account-level subscription filter policy. If you are updating an existing filter, you must specify the correct name in PolicyName. To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

{
  "Type" : "AWS::Logs::AccountPolicy",
  "Properties" : {
      "PolicyDocument" : String,
      "PolicyName" : String,
      "PolicyType" : String,
      "Scope" : String,
      "SelectionCriteria" : String
    }
}

Type: AWS::Logs::AccountPolicy
Properties:
  PolicyDocument: String
  PolicyName: String
  PolicyType: String
  Scope: String
  SelectionCriteria: String

Properties

Return values

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Examples

Create an account-level data protection policy

The following example creates an account-level data protection policy that finds and masks email addresses in log events. It also sends audit findings to the EXISTING_LOG_GROUP_NAME log group in CloudWatch Logs.

{
    "Resources": {
        "AccountPolicy": {
            "Type": "AWS::Logs::AccountPolicy",
            "Properties": {
                "PolicyName": "TestPolicy",
                "PolicyDocument": "{ \"Name\": \"data-protection-policy\", \"Description\": \"\", \"Version\": \"2021-06-01\", \"Statement\": [ { \"Sid\": \"audit-policy\", \"DataIdentifier\": [ \"arn:aws:dataprotection::aws:data-identifier/EmailAddress\" ], \"Operation\": { \"Audit\": { \"FindingsDestination\": { \"CloudWatchLogs\": { \"LogGroup\": \"EXISTING_LOG_GROUP_NAME\" } } } } }, { \"Sid\": \"redact-policy\", \"DataIdentifier\": [ \"arn:aws:dataprotection::aws:data-identifier/EmailAddress\" ], \"Operation\": { \"Deidentify\": { \"MaskConfig\": {} } } } ] }",
                "PolicyType": "DATA_PROTECTION_POLICY",
                "Scope": "ALL"
            }
        }
    }
}

Resources:
  AccountPolicy:
    Type: AWS::Logs::AccountPolicy
    Properties:
      PolicyName: "TestPolicy"
      PolicyDocument: '{
        "Name": "data-protection-policy",
        "Description": "",
        "Version": "2021-06-01",
        "Statement": [
          {
            "Sid": "audit-policy",
            "DataIdentifier": [
              "arn:aws:dataprotection::aws:data-identifier/EmailAddress"
            ],
            "Operation": {
              "Audit": {
                "FindingsDestination": {
                  "CloudWatchLogs": {
                    "LogGroup": "EXISTING_LOG_GROUP_NAME"
                  }
                }
              }
            }
          },
          {
            "Sid": "redact-policy",
            "DataIdentifier": [
              "arn:aws:dataprotection::aws:data-identifier/EmailAddress"
            ],
            "Operation": {
              "Deidentify": {
                "MaskConfig": {}
              }
            }
          }
        ]
      }'
      PolicyType: "DATA_PROTECTION_POLICY"
      Scope: "ALL"

Create an account-level subscription filter policy

The following example creates an account-level subscription filter policy that forwards the log events matching the FilterPattern from all the log groups in an account to the specified ak Kinesis Data Streams stream. It forwards the log events from all the log groups except the ones that are specified in the SelectionCriteria field.

{
    "Resources": {
        "AccountPolicy": {
            "Type": "AWS::Logs::AccountPolicy",
            "Properties": {
                "PolicyName": "test-subscriptionfilter-policy",
                "PolicyDocument": {
                    "Fn::Sub": "{\"RoleArn\":\"arn:${AWS::Partition}:iam::${AWS::AccountId}:role/MyCWLtoKinesisRole\", \"DestinationArn\":\"arn:${AWS::Partition}:kinesis:${AWS::Region}:${AWS::AccountId}:stream/MyKinesisStream\", \"FilterPattern\": \"Test\", \"Distribution\": \"Random\"}"
                },
                "SelectionCriteria": {
                    "Fn::Sub": "LogGroupName NOT IN [\"MyLogGroup\", \"MyAnotherLogGroup\"]"
                },
                "PolicyType": "SUBSCRIPTION_FILTER_POLICY",
                "Scope": "ALL"
            }
        }
    }
}

Resources:
  AccountPolicy:
    Type: AWS::Logs::AccountPolicy
    Properties:
      PolicyName: test-subscriptionfilter-policy
      PolicyDocument: !Sub "{\"RoleArn\":\"arn:${AWS::Partition}:iam::${AWS::AccountId}:role/MyCWLtoKinesisRole\", \"DestinationArn\":\"arn:${AWS::Partition}:kinesis:${AWS::Region}:${AWS::AccountId}:stream/MyKinesisStream\", \"FilterPattern\": \"Test\", \"Distribution\": \"Random\"}"
      SelectionCriteria: !Sub "LogGroupName NOT IN [\"MyLogGroup\", \"MyAnotherLogGroup\"]"
      PolicyType: "SUBSCRIPTION_FILTER_POLICY"
      Scope: "ALL"