AWSLogsPutAccountPolicyRequest
Objective-C
@interface AWSLogsPutAccountPolicyRequest
Swift
class AWSLogsPutAccountPolicyRequest
-
Specify the data protection policy, in JSON.
This policy must include two JSON blocks:
The first block must include both a
DataIdentifer
array and anOperation
property with anAudit
action. TheDataIdentifer
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 anAudit
action is required to find the sensitive data terms. ThisAudit
action must contain aFindingsDestination
object. You can optionally use thatFindingsDestination
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 anOperation
property with anDeidentify
action. TheDataIdentifer
array must exactly match theDataIdentifer
array in the first block of the policy.The
Operation
property with theDeidentify
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 includeName
,Description
, andVersion
fields. TheName
is different than the operation’spolicyName
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.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable policyDocument;
Swift
var policyDocument: String? { get set }
-
A name for the policy. This must be unique within the account.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable policyName;
Swift
var policyName: String? { get set }
-
Currently the only valid value for this parameter is
DATA_PROTECTION_POLICY
.Declaration
Objective-C
@property (nonatomic) AWSLogsPolicyType policyType;
Swift
var policyType: AWSLogsPolicyType { get set }
-
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 ofALL
is used.Declaration
Objective-C
@property (nonatomic) AWSLogsScope scope;
Swift
var scope: AWSLogsScope { get set }