Class CfnAccountPolicy
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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:
- 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.
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.
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") .selectionCriteria("selectionCriteria") .build();
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnAccountPolicy
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnAccountPolicy
(software.amazon.jsii.JsiiObjectRef objRef) CfnAccountPolicy
(software.constructs.Construct scope, String id, CfnAccountPolicyProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe account ID of the account where this policy was created.Specify the policy, in JSON.A name for the policy.The type of policy that you're creating or updating.getScope()
Currently the only valid value for this parameter isALL
, which specifies that the policy applies to all log groups in the account.Use this parameter to apply a subscription filter policy to a subset of log groups in the account.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setPolicyDocument
(String value) Specify the policy, in JSON.void
setPolicyName
(String value) A name for the policy.void
setPolicyType
(String value) The type of policy that you're creating or updating.void
Currently the only valid value for this parameter isALL
, which specifies that the policy applies to all log groups in the account.void
setSelectionCriteria
(String value) Use this parameter to apply a subscription filter policy to a subset of log groups in the account.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrAccountId
The account ID of the account where this policy was created.For example,
123456789012
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getPolicyDocument
Specify the policy, in JSON. -
setPolicyDocument
Specify the policy, in JSON. -
getPolicyName
A name for the policy. -
setPolicyName
A name for the policy. -
getPolicyType
The type of policy that you're creating or updating. -
setPolicyType
The type of policy that you're creating or updating. -
getScope
Currently the only valid value for this parameter isALL
, which specifies that the policy applies to all log groups in the account. -
setScope
Currently the only valid value for this parameter isALL
, which specifies that the policy applies to all log groups in the account. -
getSelectionCriteria
Use this parameter to apply a subscription filter policy to a subset of log groups in the account. -
setSelectionCriteria
Use this parameter to apply a subscription filter policy to a subset of log groups in the account.
-