1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package cloudwatchlogs
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates 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 use PutAccountPolicy to 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 (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html)
// or FilterLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html)
// 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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html)
// . To use the PutAccountPolicy operation, you must be signed on with the
// logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions. The
// PutAccountPolicy operation applies to all log groups in the account. You can
// also use PutDataProtectionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html)
// to 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.
func (c *Client) PutAccountPolicy(ctx context.Context, params *PutAccountPolicyInput, optFns ...func(*Options)) (*PutAccountPolicyOutput, error) {
if params == nil {
params = &PutAccountPolicyInput{}
}
result, metadata, err := c.invokeOperation(ctx, "PutAccountPolicy", params, optFns, c.addOperationPutAccountPolicyMiddlewares)
if err != nil {
return nil, err
}
out := result.(*PutAccountPolicyOutput)
out.ResultMetadata = metadata
return out, nil
}
type PutAccountPolicyInput struct {
// Specify the data protection policy, in JSON. This policy must include two JSON
// blocks:
// - The first block must include both a DataIdentifer array and an Operation
// property with an Audit action. The DataIdentifer 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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html)
// . The Operation property with an Audit action is required to find the
// sensitive data terms. This Audit action must contain a FindingsDestination
// object. You can optionally use that FindingsDestination 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 an Operation
// property with an Deidentify action. The DataIdentifer array must exactly match
// the DataIdentifer array in the first block of the policy. The Operation
// property with the Deidentify 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 include Name , Description ,
// and Version fields. The Name is different than the operation's policyName
// 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.
//
// This member is required.
PolicyDocument *string
// A name for the policy. This must be unique within the account.
//
// This member is required.
PolicyName *string
// Currently the only valid value for this parameter is DATA_PROTECTION_POLICY .
//
// This member is required.
PolicyType types.PolicyType
// 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 of ALL is used.
Scope types.Scope
noSmithyDocumentSerde
}
type PutAccountPolicyOutput struct {
// The account policy that you created.
AccountPolicy *types.AccountPolicy
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationPutAccountPolicyMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpPutAccountPolicy{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpPutAccountPolicy{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "PutAccountPolicy"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpPutAccountPolicyValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opPutAccountPolicy(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opPutAccountPolicy(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "PutAccountPolicy",
}
}
|
