Class CfnAccountPolicy
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.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Logs
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAccountPolicy : CfnResource, IInspectable
Syntax (vb)
Public Class CfnAccountPolicy
Inherits CfnResource
Implements IInspectable
Remarks
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.
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.
Subscription filter policy
A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other AWS 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-accountpolicy.html
CloudformationResource: AWS::Logs::AccountPolicy
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Logs;
var cfnAccountPolicy = new CfnAccountPolicy(this, "MyCfnAccountPolicy", new CfnAccountPolicyProps {
PolicyDocument = "policyDocument",
PolicyName = "policyName",
PolicyType = "policyType",
// the properties below are optional
Scope = "scope",
SelectionCriteria = "selectionCriteria"
});
Synopsis
Constructors
CfnAccountPolicy(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAccountPolicy(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnAccountPolicy(Construct, String, ICfnAccountPolicyProps) |
Properties
AttrAccountId | The account ID of the account where this policy was created. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
PolicyDocument | Specify the policy, in JSON. |
PolicyName | A name for the policy. |
PolicyType | The type of policy that you're creating or updating. |
Scope | Currently the only valid value for this parameter is |
SelectionCriteria | Use this parameter to apply a subscription filter policy to a subset of log groups in the account. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAccountPolicy(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAccountPolicy(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAccountPolicy(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAccountPolicy(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnAccountPolicy(Construct, String, ICfnAccountPolicyProps)
public CfnAccountPolicy(Construct scope, string id, ICfnAccountPolicyProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnAccountPolicyProps
Resource properties.
Properties
AttrAccountId
The account ID of the account where this policy was created.
public virtual string AttrAccountId { get; }
Property Value
System.String
Remarks
For example, 123456789012
.
CloudformationAttribute: AccountId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
PolicyDocument
Specify the policy, in JSON.
public virtual string PolicyDocument { get; set; }
Property Value
System.String
PolicyName
A name for the policy.
public virtual string PolicyName { get; set; }
Property Value
System.String
PolicyType
The type of policy that you're creating or updating.
public virtual string PolicyType { get; set; }
Property Value
System.String
Scope
Currently the only valid value for this parameter is ALL
, which specifies that the policy applies to all log groups in the account.
public virtual string Scope { get; set; }
Property Value
System.String
SelectionCriteria
Use this parameter to apply a subscription filter policy to a subset of log groups in the account.
public virtual string SelectionCriteria { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>