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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/s3/S3_EXPORTS.h>
#include <aws/s3/model/ServerSideEncryption.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Xml
{
class XmlNode;
} // namespace Xml
} // namespace Utils
namespace S3
{
namespace Model
{
/**
* <p>Describes the default server-side encryption to apply to new objects in the
* bucket. If a PUT Object request doesn't specify any server-side encryption, this
* default encryption will be applied. If you don't specify a customer managed key
* at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key
* in your Amazon Web Services account the first time that you add an object
* encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for
* SSE-KMS. For more information, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html">PUT
* Bucket encryption</a> in the <i>Amazon S3 API Reference</i>.</p><p><h3>See
* Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ServerSideEncryptionByDefault">AWS
* API Reference</a></p>
*/
class ServerSideEncryptionByDefault
{
public:
AWS_S3_API ServerSideEncryptionByDefault();
AWS_S3_API ServerSideEncryptionByDefault(const Aws::Utils::Xml::XmlNode& xmlNode);
AWS_S3_API ServerSideEncryptionByDefault& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
AWS_S3_API void AddToNode(Aws::Utils::Xml::XmlNode& parentNode) const;
/**
* <p>Server-side encryption algorithm to use for the default encryption.</p>
*/
inline const ServerSideEncryption& GetSSEAlgorithm() const{ return m_sSEAlgorithm; }
/**
* <p>Server-side encryption algorithm to use for the default encryption.</p>
*/
inline bool SSEAlgorithmHasBeenSet() const { return m_sSEAlgorithmHasBeenSet; }
/**
* <p>Server-side encryption algorithm to use for the default encryption.</p>
*/
inline void SetSSEAlgorithm(const ServerSideEncryption& value) { m_sSEAlgorithmHasBeenSet = true; m_sSEAlgorithm = value; }
/**
* <p>Server-side encryption algorithm to use for the default encryption.</p>
*/
inline void SetSSEAlgorithm(ServerSideEncryption&& value) { m_sSEAlgorithmHasBeenSet = true; m_sSEAlgorithm = std::move(value); }
/**
* <p>Server-side encryption algorithm to use for the default encryption.</p>
*/
inline ServerSideEncryptionByDefault& WithSSEAlgorithm(const ServerSideEncryption& value) { SetSSEAlgorithm(value); return *this;}
/**
* <p>Server-side encryption algorithm to use for the default encryption.</p>
*/
inline ServerSideEncryptionByDefault& WithSSEAlgorithm(ServerSideEncryption&& value) { SetSSEAlgorithm(std::move(value)); return *this;}
/**
* <p>Amazon Web Services Key Management Service (KMS) customer Amazon Web Services
* KMS key ID to use for the default encryption. This parameter is allowed if and
* only if <code>SSEAlgorithm</code> is set to <code>aws:kms</code>.</p> <p>You can
* specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if
* you are using encryption with cross-account or Amazon Web Services service
* operations you must use a fully qualified KMS key ARN. For more information, see
* <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy">Using
* encryption for cross-account operations</a>. </p> <p> <b>For example:</b> </p>
* <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>
* </li> <li> <p>Key ARN:
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
* </p> </li> </ul> <p>Amazon S3 only supports symmetric KMS keys and
* not asymmetric KMS keys. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>Amazon Web Services Key Management
* Service Developer Guide</i>.</p>
*/
inline const Aws::String& GetKMSMasterKeyID() const{ return m_kMSMasterKeyID; }
/**
* <p>Amazon Web Services Key Management Service (KMS) customer Amazon Web Services
* KMS key ID to use for the default encryption. This parameter is allowed if and
* only if <code>SSEAlgorithm</code> is set to <code>aws:kms</code>.</p> <p>You can
* specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if
* you are using encryption with cross-account or Amazon Web Services service
* operations you must use a fully qualified KMS key ARN. For more information, see
* <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy">Using
* encryption for cross-account operations</a>. </p> <p> <b>For example:</b> </p>
* <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>
* </li> <li> <p>Key ARN:
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
* </p> </li> </ul> <p>Amazon S3 only supports symmetric KMS keys and
* not asymmetric KMS keys. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>Amazon Web Services Key Management
* Service Developer Guide</i>.</p>
*/
inline bool KMSMasterKeyIDHasBeenSet() const { return m_kMSMasterKeyIDHasBeenSet; }
/**
* <p>Amazon Web Services Key Management Service (KMS) customer Amazon Web Services
* KMS key ID to use for the default encryption. This parameter is allowed if and
* only if <code>SSEAlgorithm</code> is set to <code>aws:kms</code>.</p> <p>You can
* specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if
* you are using encryption with cross-account or Amazon Web Services service
* operations you must use a fully qualified KMS key ARN. For more information, see
* <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy">Using
* encryption for cross-account operations</a>. </p> <p> <b>For example:</b> </p>
* <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>
* </li> <li> <p>Key ARN:
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
* </p> </li> </ul> <p>Amazon S3 only supports symmetric KMS keys and
* not asymmetric KMS keys. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>Amazon Web Services Key Management
* Service Developer Guide</i>.</p>
*/
inline void SetKMSMasterKeyID(const Aws::String& value) { m_kMSMasterKeyIDHasBeenSet = true; m_kMSMasterKeyID = value; }
/**
* <p>Amazon Web Services Key Management Service (KMS) customer Amazon Web Services
* KMS key ID to use for the default encryption. This parameter is allowed if and
* only if <code>SSEAlgorithm</code> is set to <code>aws:kms</code>.</p> <p>You can
* specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if
* you are using encryption with cross-account or Amazon Web Services service
* operations you must use a fully qualified KMS key ARN. For more information, see
* <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy">Using
* encryption for cross-account operations</a>. </p> <p> <b>For example:</b> </p>
* <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>
* </li> <li> <p>Key ARN:
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
* </p> </li> </ul> <p>Amazon S3 only supports symmetric KMS keys and
* not asymmetric KMS keys. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>Amazon Web Services Key Management
* Service Developer Guide</i>.</p>
*/
inline void SetKMSMasterKeyID(Aws::String&& value) { m_kMSMasterKeyIDHasBeenSet = true; m_kMSMasterKeyID = std::move(value); }
/**
* <p>Amazon Web Services Key Management Service (KMS) customer Amazon Web Services
* KMS key ID to use for the default encryption. This parameter is allowed if and
* only if <code>SSEAlgorithm</code> is set to <code>aws:kms</code>.</p> <p>You can
* specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if
* you are using encryption with cross-account or Amazon Web Services service
* operations you must use a fully qualified KMS key ARN. For more information, see
* <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy">Using
* encryption for cross-account operations</a>. </p> <p> <b>For example:</b> </p>
* <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>
* </li> <li> <p>Key ARN:
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
* </p> </li> </ul> <p>Amazon S3 only supports symmetric KMS keys and
* not asymmetric KMS keys. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>Amazon Web Services Key Management
* Service Developer Guide</i>.</p>
*/
inline void SetKMSMasterKeyID(const char* value) { m_kMSMasterKeyIDHasBeenSet = true; m_kMSMasterKeyID.assign(value); }
/**
* <p>Amazon Web Services Key Management Service (KMS) customer Amazon Web Services
* KMS key ID to use for the default encryption. This parameter is allowed if and
* only if <code>SSEAlgorithm</code> is set to <code>aws:kms</code>.</p> <p>You can
* specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if
* you are using encryption with cross-account or Amazon Web Services service
* operations you must use a fully qualified KMS key ARN. For more information, see
* <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy">Using
* encryption for cross-account operations</a>. </p> <p> <b>For example:</b> </p>
* <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>
* </li> <li> <p>Key ARN:
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
* </p> </li> </ul> <p>Amazon S3 only supports symmetric KMS keys and
* not asymmetric KMS keys. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>Amazon Web Services Key Management
* Service Developer Guide</i>.</p>
*/
inline ServerSideEncryptionByDefault& WithKMSMasterKeyID(const Aws::String& value) { SetKMSMasterKeyID(value); return *this;}
/**
* <p>Amazon Web Services Key Management Service (KMS) customer Amazon Web Services
* KMS key ID to use for the default encryption. This parameter is allowed if and
* only if <code>SSEAlgorithm</code> is set to <code>aws:kms</code>.</p> <p>You can
* specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if
* you are using encryption with cross-account or Amazon Web Services service
* operations you must use a fully qualified KMS key ARN. For more information, see
* <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy">Using
* encryption for cross-account operations</a>. </p> <p> <b>For example:</b> </p>
* <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>
* </li> <li> <p>Key ARN:
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
* </p> </li> </ul> <p>Amazon S3 only supports symmetric KMS keys and
* not asymmetric KMS keys. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>Amazon Web Services Key Management
* Service Developer Guide</i>.</p>
*/
inline ServerSideEncryptionByDefault& WithKMSMasterKeyID(Aws::String&& value) { SetKMSMasterKeyID(std::move(value)); return *this;}
/**
* <p>Amazon Web Services Key Management Service (KMS) customer Amazon Web Services
* KMS key ID to use for the default encryption. This parameter is allowed if and
* only if <code>SSEAlgorithm</code> is set to <code>aws:kms</code>.</p> <p>You can
* specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if
* you are using encryption with cross-account or Amazon Web Services service
* operations you must use a fully qualified KMS key ARN. For more information, see
* <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy">Using
* encryption for cross-account operations</a>. </p> <p> <b>For example:</b> </p>
* <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>
* </li> <li> <p>Key ARN:
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
* </p> </li> </ul> <p>Amazon S3 only supports symmetric KMS keys and
* not asymmetric KMS keys. For more information, see <a
* href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
* symmetric and asymmetric keys</a> in the <i>Amazon Web Services Key Management
* Service Developer Guide</i>.</p>
*/
inline ServerSideEncryptionByDefault& WithKMSMasterKeyID(const char* value) { SetKMSMasterKeyID(value); return *this;}
private:
ServerSideEncryption m_sSEAlgorithm;
bool m_sSEAlgorithmHasBeenSet = false;
Aws::String m_kMSMasterKeyID;
bool m_kMSMasterKeyIDHasBeenSet = false;
};
} // namespace Model
} // namespace S3
} // namespace Aws
|
