cdk-docker-image-deployment 0.0.88 → 0.0.89
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +3 -3
- package/lib/destination.js +1 -1
- package/lib/docker-image-deployment.js +1 -1
- package/lib/source.js +1 -1
- package/node_modules/aws-sdk/CHANGELOG.md +29 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/arc-zonal-shift-2022-10-30.examples.json +5 -0
- package/node_modules/aws-sdk/apis/arc-zonal-shift-2022-10-30.min.json +284 -0
- package/node_modules/aws-sdk/apis/arc-zonal-shift-2022-10-30.paginators.json +16 -0
- package/node_modules/aws-sdk/apis/compute-optimizer-2019-11-01.min.json +31 -13
- package/node_modules/aws-sdk/apis/config-2014-11-12.min.json +282 -134
- package/node_modules/aws-sdk/apis/config-2014-11-12.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +2824 -1317
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.paginators.json +42 -0
- package/node_modules/aws-sdk/apis/eks-2017-11-01.min.json +87 -52
- package/node_modules/aws-sdk/apis/firehose-2015-08-04.min.json +128 -27
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json +156 -130
- package/node_modules/aws-sdk/apis/glue-2017-03-31.min.json +341 -298
- package/node_modules/aws-sdk/apis/inspector2-2020-06-08.min.json +205 -28
- package/node_modules/aws-sdk/apis/kms-2014-11-01.examples.json +359 -50
- package/node_modules/aws-sdk/apis/kms-2014-11-01.min.json +127 -72
- package/node_modules/aws-sdk/apis/kms-2014-11-01.paginators.json +0 -7
- package/node_modules/aws-sdk/apis/lambda-2015-03-31.min.json +69 -50
- package/node_modules/aws-sdk/apis/lambda-2015-03-31.waiters2.json +26 -0
- package/node_modules/aws-sdk/apis/license-manager-user-subscriptions-2018-05-10.min.json +82 -9
- package/node_modules/aws-sdk/apis/macie2-2020-01-01.min.json +793 -112
- package/node_modules/aws-sdk/apis/macie2-2020-01-01.paginators.json +33 -0
- package/node_modules/aws-sdk/apis/metadata.json +16 -0
- package/node_modules/aws-sdk/apis/omics-2022-11-28.examples.json +5 -0
- package/node_modules/aws-sdk/apis/omics-2022-11-28.min.json +3722 -0
- package/node_modules/aws-sdk/apis/omics-2022-11-28.paginators.json +100 -0
- package/node_modules/aws-sdk/apis/omics-2022-11-28.waiters2.json +498 -0
- package/node_modules/aws-sdk/apis/opensearchserverless-2021-11-01.examples.json +5 -0
- package/node_modules/aws-sdk/apis/opensearchserverless-2021-11-01.min.json +1082 -0
- package/node_modules/aws-sdk/apis/opensearchserverless-2021-11-01.paginators.json +29 -0
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +5991 -325
- package/node_modules/aws-sdk/apis/s3control-2018-08-20.min.json +138 -28
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +23 -16
- package/node_modules/aws-sdk/apis/securitylake-2018-05-10.examples.json +5 -0
- package/node_modules/aws-sdk/apis/securitylake-2018-05-10.min.json +1041 -0
- package/node_modules/aws-sdk/apis/securitylake-2018-05-10.paginators.json +28 -0
- package/node_modules/aws-sdk/apis/simspaceweaver-2022-10-28.examples.json +5 -0
- package/node_modules/aws-sdk/apis/simspaceweaver-2022-10-28.min.json +578 -0
- package/node_modules/aws-sdk/apis/simspaceweaver-2022-10-28.paginators.json +14 -0
- package/node_modules/aws-sdk/clients/all.d.ts +5 -0
- package/node_modules/aws-sdk/clients/all.js +6 -1
- package/node_modules/aws-sdk/clients/arczonalshift.d.ts +309 -0
- package/node_modules/aws-sdk/clients/arczonalshift.js +18 -0
- package/node_modules/aws-sdk/clients/computeoptimizer.d.ts +28 -5
- package/node_modules/aws-sdk/clients/configservice.d.ts +233 -6
- package/node_modules/aws-sdk/clients/ec2.d.ts +1851 -20
- package/node_modules/aws-sdk/clients/eks.d.ts +58 -8
- package/node_modules/aws-sdk/clients/firehose.d.ts +263 -48
- package/node_modules/aws-sdk/clients/fsx.d.ts +70 -21
- package/node_modules/aws-sdk/clients/glue.d.ts +66 -0
- package/node_modules/aws-sdk/clients/inspector2.d.ts +289 -15
- package/node_modules/aws-sdk/clients/kms.d.ts +198 -92
- package/node_modules/aws-sdk/clients/lambda.d.ts +132 -94
- package/node_modules/aws-sdk/clients/licensemanagerusersubscriptions.d.ts +62 -4
- package/node_modules/aws-sdk/clients/macie2.d.ts +637 -54
- package/node_modules/aws-sdk/clients/omics.d.ts +4175 -0
- package/node_modules/aws-sdk/clients/omics.js +19 -0
- package/node_modules/aws-sdk/clients/opensearchserverless.d.ts +1508 -0
- package/node_modules/aws-sdk/clients/opensearchserverless.js +18 -0
- package/node_modules/aws-sdk/clients/quicksight.d.ts +9833 -2835
- package/node_modules/aws-sdk/clients/s3control.d.ts +69 -0
- package/node_modules/aws-sdk/clients/securityhub.d.ts +14 -0
- package/node_modules/aws-sdk/clients/securitylake.d.ts +1049 -0
- package/node_modules/aws-sdk/clients/securitylake.js +18 -0
- package/node_modules/aws-sdk/clients/simspaceweaver.d.ts +647 -0
- package/node_modules/aws-sdk/clients/simspaceweaver.js +18 -0
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +39 -13
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +264 -37
- package/node_modules/aws-sdk/dist/aws-sdk.js +3615 -1676
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +79 -78
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +10 -0
- package/node_modules/aws-sdk/lib/core.d.ts +4 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/event_listeners.js +26 -9
- package/node_modules/aws-sdk/lib/region_config.js +11 -2
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +3 -3
|
@@ -36,9 +36,9 @@
|
|
|
36
36
|
"output": {
|
|
37
37
|
}
|
|
38
38
|
},
|
|
39
|
-
"description": "This example connects an AWS KMS custom key store to its AWS CloudHSM cluster. This operation does not return any data. To verify that the custom key store is connected, use the <code>DescribeCustomKeyStores</code> operation.",
|
|
40
|
-
"id": "to-connect-a-custom-key-store-
|
|
41
|
-
"title": "To connect a custom key store
|
|
39
|
+
"description": "This example connects an AWS KMS custom key store to its backing key store. For an AWS CloudHSM key store, it connects the key store to its AWS CloudHSM cluster. For an external key store, it connects the key store to the external key store proxy that communicates with your external key manager. This operation does not return any data. To verify that the custom key store is connected, use the <code>DescribeCustomKeyStores</code> operation.",
|
|
40
|
+
"id": "to-connect-a-custom-key-store-1628626947750",
|
|
41
|
+
"title": "To connect a custom key store"
|
|
42
42
|
}
|
|
43
43
|
],
|
|
44
44
|
"CreateAlias": [
|
|
@@ -81,8 +81,68 @@
|
|
|
81
81
|
}
|
|
82
82
|
},
|
|
83
83
|
"description": "This example creates a custom key store that is associated with an AWS CloudHSM cluster.",
|
|
84
|
-
"id": "to-create-an-aws-cloudhsm-custom-key-store-
|
|
85
|
-
"title": "To create an AWS CloudHSM
|
|
84
|
+
"id": "to-create-an-aws-cloudhsm-custom-key-store-1",
|
|
85
|
+
"title": "To create an AWS CloudHSM key store"
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"input": {
|
|
89
|
+
"CustomKeyStoreName": "ExampleVPCEndpointKeyStore",
|
|
90
|
+
"CustomKeyStoreType": "EXTERNAL_KEY_STORE",
|
|
91
|
+
"XksProxyAuthenticationCredential": "AccessKeyId=ABCDE12345670EXAMPLE,RawSecretAccessKey=file://SecretAccessKey",
|
|
92
|
+
"XksProxyConnectivity": "VPC_ENDPOINT_SERVICE",
|
|
93
|
+
"XksProxyUriEndpoint": "https://myproxy-private.xks.example.com",
|
|
94
|
+
"XksProxyUriPath": "/example-prefix/kms/xks/v1",
|
|
95
|
+
"XksProxyVpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-example1"
|
|
96
|
+
},
|
|
97
|
+
"output": {
|
|
98
|
+
"CustomKeyStoreId": "cks-1234567890abcdef0"
|
|
99
|
+
},
|
|
100
|
+
"comments": {
|
|
101
|
+
"input": {
|
|
102
|
+
"CustomKeyStoreName": "A friendly name for the custom key store",
|
|
103
|
+
"CustomKeyStoreType": "For external key stores, the value must be EXTERNAL_KEY_STORE",
|
|
104
|
+
"XksProxyAuthenticationCredential": "The access key ID and secret access key that KMS uses to authenticate to your external key store proxy",
|
|
105
|
+
"XksProxyConnectivity": "Indicates how AWS KMS communicates with the external key store proxy",
|
|
106
|
+
"XksProxyUriEndpoint": "The URI that AWS KMS uses to connect to the external key store proxy",
|
|
107
|
+
"XksProxyUriPath": "The URI path to the external key store proxy APIs",
|
|
108
|
+
"XksProxyVpcEndpointServiceName": "The VPC endpoint service that KMS uses to communicate with the external key store proxy"
|
|
109
|
+
},
|
|
110
|
+
"output": {
|
|
111
|
+
"CustomKeyStoreId": "The ID of the new custom key store."
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
"description": "This example creates an external key store that uses an Amazon VPC endpoint service to communicate with AWS KMS.",
|
|
115
|
+
"id": "to-create-an-external-custom-key-store-with-vpc-connectivity-2",
|
|
116
|
+
"title": "To create an external key store with VPC endpoint service connectivity"
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"input": {
|
|
120
|
+
"CustomKeyStoreName": "ExamplePublicEndpointKeyStore",
|
|
121
|
+
"CustomKeyStoreType": "EXTERNAL_KEY_STORE",
|
|
122
|
+
"XksProxyAuthenticationCredential": "AccessKeyId=ABCDE12345670EXAMPLE,RawSecretAccessKey=file://SecretAccessKey",
|
|
123
|
+
"XksProxyConnectivity": "PUBLIC_ENDPOINT",
|
|
124
|
+
"XksProxyUriEndpoint": "https://myproxy.xks.example.com",
|
|
125
|
+
"XksProxyUriPath": "/kms/xks/v1"
|
|
126
|
+
},
|
|
127
|
+
"output": {
|
|
128
|
+
"CustomKeyStoreId": "cks-987654321abcdef0"
|
|
129
|
+
},
|
|
130
|
+
"comments": {
|
|
131
|
+
"input": {
|
|
132
|
+
"CustomKeyStoreName": "A friendly name for the custom key store",
|
|
133
|
+
"CustomKeyStoreType": "For external key stores, the value must be EXTERNAL_KEY_STORE",
|
|
134
|
+
"XksProxyAuthenticationCredential": "The access key ID and secret access key that KMS uses to authenticate to your external key store proxy",
|
|
135
|
+
"XksProxyConnectivity": "Indicates how AWS KMS communicates with the external key store proxy",
|
|
136
|
+
"XksProxyUriEndpoint": "The URI that AWS KMS uses to connect to the external key store proxy",
|
|
137
|
+
"XksProxyUriPath": "The URI path to your external key store proxy API"
|
|
138
|
+
},
|
|
139
|
+
"output": {
|
|
140
|
+
"CustomKeyStoreId": "The ID of the new custom key store."
|
|
141
|
+
}
|
|
142
|
+
},
|
|
143
|
+
"description": "This example creates an external key store with public endpoint connectivity.",
|
|
144
|
+
"id": "to-create-an-external-custom-key-store-with-a-public-endpoint-3",
|
|
145
|
+
"title": "To create an external key store with public endpoint connectivity"
|
|
86
146
|
}
|
|
87
147
|
],
|
|
88
148
|
"CreateGrant": [
|
|
@@ -148,7 +208,7 @@
|
|
|
148
208
|
}
|
|
149
209
|
},
|
|
150
210
|
"description": "The following example creates a symmetric KMS key for encryption and decryption. No parameters are required for this operation.",
|
|
151
|
-
"id": "to-create-a-cmk-
|
|
211
|
+
"id": "to-create-a-cmk-1",
|
|
152
212
|
"title": "To create a KMS key"
|
|
153
213
|
},
|
|
154
214
|
{
|
|
@@ -187,7 +247,7 @@
|
|
|
187
247
|
}
|
|
188
248
|
},
|
|
189
249
|
"description": "This example creates a KMS key that contains an asymmetric RSA key pair for encryption and decryption. The key spec and key usage can't be changed after the key is created.",
|
|
190
|
-
"id": "to-create-an-asymmetric-rsa-kms-key-for-encryption-and-decryption-
|
|
250
|
+
"id": "to-create-an-asymmetric-rsa-kms-key-for-encryption-and-decryption-2",
|
|
191
251
|
"title": "To create an asymmetric RSA KMS key for encryption and decryption"
|
|
192
252
|
},
|
|
193
253
|
{
|
|
@@ -225,9 +285,47 @@
|
|
|
225
285
|
}
|
|
226
286
|
},
|
|
227
287
|
"description": "This example creates a KMS key that contains an asymmetric elliptic curve (ECC) key pair for signing and verification. The key usage is required even though \"SIGN_VERIFY\" is the only valid value for ECC KMS keys. The key spec and key usage can't be changed after the key is created.",
|
|
228
|
-
"id": "to-create-an-asymmetric-elliptic-curve-kms-key-for-signing-and-verification-
|
|
288
|
+
"id": "to-create-an-asymmetric-elliptic-curve-kms-key-for-signing-and-verification-3",
|
|
229
289
|
"title": "To create an asymmetric elliptic curve KMS key for signing and verification"
|
|
230
290
|
},
|
|
291
|
+
{
|
|
292
|
+
"input": {
|
|
293
|
+
"KeySpec": "HMAC_384",
|
|
294
|
+
"KeyUsage": "GENERATE_VERIFY_MAC"
|
|
295
|
+
},
|
|
296
|
+
"output": {
|
|
297
|
+
"KeyMetadata": {
|
|
298
|
+
"AWSAccountId": "111122223333",
|
|
299
|
+
"Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
300
|
+
"CreationDate": "2022-04-05T14:04:55-07:00",
|
|
301
|
+
"CustomerMasterKeySpec": "HMAC_384",
|
|
302
|
+
"Description": "",
|
|
303
|
+
"Enabled": true,
|
|
304
|
+
"KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
305
|
+
"KeyManager": "CUSTOMER",
|
|
306
|
+
"KeySpec": "HMAC_384",
|
|
307
|
+
"KeyState": "Enabled",
|
|
308
|
+
"KeyUsage": "GENERATE_VERIFY_MAC",
|
|
309
|
+
"MacAlgorithms": [
|
|
310
|
+
"HMAC_SHA_384"
|
|
311
|
+
],
|
|
312
|
+
"MultiRegion": false,
|
|
313
|
+
"Origin": "AWS_KMS"
|
|
314
|
+
}
|
|
315
|
+
},
|
|
316
|
+
"comments": {
|
|
317
|
+
"input": {
|
|
318
|
+
"KeySpec": "Describes the type of key material in the KMS key.",
|
|
319
|
+
"KeyUsage": "The cryptographic operations for which you can use the KMS key."
|
|
320
|
+
},
|
|
321
|
+
"output": {
|
|
322
|
+
"KeyMetadata": "Detailed information about the KMS key that this operation creates."
|
|
323
|
+
}
|
|
324
|
+
},
|
|
325
|
+
"description": "This example creates a 384-bit symmetric HMAC KMS key. The GENERATE_VERIFY_MAC key usage value is required even though it's the only valid value for HMAC KMS keys. The key spec and key usage can't be changed after the key is created.",
|
|
326
|
+
"id": "to-create-an-hmac-kms-key-1630628752841",
|
|
327
|
+
"title": "To create an HMAC KMS key"
|
|
328
|
+
},
|
|
231
329
|
{
|
|
232
330
|
"input": {
|
|
233
331
|
"MultiRegion": true
|
|
@@ -271,7 +369,7 @@
|
|
|
271
369
|
}
|
|
272
370
|
},
|
|
273
371
|
"description": "This example creates a multi-Region primary symmetric encryption key. Because the default values for all parameters create a symmetric encryption key, only the MultiRegion parameter is required for this KMS key.",
|
|
274
|
-
"id": "to-create-a-multi-region-primary-kms-key-
|
|
372
|
+
"id": "to-create-a-multi-region-primary-kms-key-4",
|
|
275
373
|
"title": "To create a multi-Region primary KMS key"
|
|
276
374
|
},
|
|
277
375
|
{
|
|
@@ -306,8 +404,8 @@
|
|
|
306
404
|
"KeyMetadata": "Detailed information about the KMS key that this operation creates."
|
|
307
405
|
}
|
|
308
406
|
},
|
|
309
|
-
"description": "This example creates a KMS key with no key material. When the operation is complete, you can import your own key material into the KMS key. To create this KMS key, set the Origin parameter to EXTERNAL.
|
|
310
|
-
"id": "to-create-a-kms-key-for-imported-key-material-
|
|
407
|
+
"description": "This example creates a KMS key with no key material. When the operation is complete, you can import your own key material into the KMS key. To create this KMS key, set the Origin parameter to EXTERNAL.",
|
|
408
|
+
"id": "to-create-a-kms-key-for-imported-key-material-5",
|
|
311
409
|
"title": "To create a KMS key for imported key material"
|
|
312
410
|
},
|
|
313
411
|
{
|
|
@@ -346,47 +444,53 @@
|
|
|
346
444
|
"KeyMetadata": "Detailed information about the KMS key that this operation creates."
|
|
347
445
|
}
|
|
348
446
|
},
|
|
349
|
-
"description": "This example creates a KMS key in the specified
|
|
350
|
-
"id": "to-create-a-kms-key-in-
|
|
351
|
-
"title": "To create a KMS key in
|
|
447
|
+
"description": "This example creates a KMS key in the specified AWS CloudHSM key store. The operation creates the KMS key and its metadata in AWS KMS and creates the key material in the AWS CloudHSM cluster associated with the custom key store. This example requires the CustomKeyStoreId and Origin parameters.",
|
|
448
|
+
"id": "to-create-a-kms-key-in-an-aws-cloudhsm-custom-key-store-6",
|
|
449
|
+
"title": "To create a KMS key in an AWS CloudHSM key store"
|
|
352
450
|
},
|
|
353
451
|
{
|
|
354
452
|
"input": {
|
|
355
|
-
"
|
|
356
|
-
"
|
|
453
|
+
"CustomKeyStoreId": "cks-9876543210fedcba9",
|
|
454
|
+
"Origin": "EXTERNAL_KEY_STORE",
|
|
455
|
+
"XksKeyId": "bb8562717f809024"
|
|
357
456
|
},
|
|
358
457
|
"output": {
|
|
359
458
|
"KeyMetadata": {
|
|
360
459
|
"AWSAccountId": "111122223333",
|
|
361
|
-
"Arn": "arn:aws:kms:us-east-2:111122223333:key/
|
|
362
|
-
"CreationDate": "2022-
|
|
363
|
-
"
|
|
460
|
+
"Arn": "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321",
|
|
461
|
+
"CreationDate": "2022-02-02T07:48:55-07:00",
|
|
462
|
+
"CustomKeyStoreId": "cks-9876543210fedcba9",
|
|
463
|
+
"CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
|
|
364
464
|
"Description": "",
|
|
365
465
|
"Enabled": true,
|
|
366
|
-
"
|
|
466
|
+
"EncryptionAlgorithms": [
|
|
467
|
+
"SYMMETRIC_DEFAULT"
|
|
468
|
+
],
|
|
469
|
+
"KeyId": "0987dcba-09fe-87dc-65ba-ab0987654321",
|
|
367
470
|
"KeyManager": "CUSTOMER",
|
|
368
|
-
"KeySpec": "
|
|
471
|
+
"KeySpec": "SYMMETRIC_DEFAULT",
|
|
369
472
|
"KeyState": "Enabled",
|
|
370
|
-
"KeyUsage": "
|
|
371
|
-
"MacAlgorithms": [
|
|
372
|
-
"HMAC_SHA_384"
|
|
373
|
-
],
|
|
473
|
+
"KeyUsage": "ENCRYPT_DECRYPT",
|
|
374
474
|
"MultiRegion": false,
|
|
375
|
-
"Origin": "
|
|
475
|
+
"Origin": "EXTERNAL_KEY_STORE",
|
|
476
|
+
"XksKeyConfiguration": {
|
|
477
|
+
"Id": "bb8562717f809024"
|
|
478
|
+
}
|
|
376
479
|
}
|
|
377
480
|
},
|
|
378
481
|
"comments": {
|
|
379
482
|
"input": {
|
|
380
|
-
"
|
|
381
|
-
"
|
|
483
|
+
"CustomKeyStoreId": "Identifies the custom key store that hosts the KMS key.",
|
|
484
|
+
"Origin": "Indicates the source of the key material for the KMS key.",
|
|
485
|
+
"XksKeyId": "Identifies the encryption key in your external key manager that is associated with the KMS key"
|
|
382
486
|
},
|
|
383
487
|
"output": {
|
|
384
488
|
"KeyMetadata": "Detailed information about the KMS key that this operation creates."
|
|
385
489
|
}
|
|
386
490
|
},
|
|
387
|
-
"description": "This example creates a
|
|
388
|
-
"id": "to-create-an-
|
|
389
|
-
"title": "To create an
|
|
491
|
+
"description": "This example creates a KMS key in the specified external key store. It uses the XksKeyId parameter to associate the KMS key with an existing symmetric encryption key in your external key manager. This CustomKeyStoreId, Origin, and XksKeyId parameters are required in this operation.",
|
|
492
|
+
"id": "to-create-a-kms-key-in-an-external-custom-key-store-7",
|
|
493
|
+
"title": "To create a KMS key in an external key store"
|
|
390
494
|
}
|
|
391
495
|
],
|
|
392
496
|
"Decrypt": [
|
|
@@ -443,7 +547,7 @@
|
|
|
443
547
|
"output": {
|
|
444
548
|
}
|
|
445
549
|
},
|
|
446
|
-
"description": "This example deletes a custom key store from AWS KMS. This operation does not
|
|
550
|
+
"description": "This example deletes a custom key store from AWS KMS. This operation does not affect the backing key store, such as a CloudHSM cluster, external key store proxy, or your external key manager. This operation doesn't return any data. To verify that the operation was successful, use the DescribeCustomKeyStores operation.",
|
|
447
551
|
"id": "to-delete-a-custom-key-store-from-aws-kms-1628630837145",
|
|
448
552
|
"title": "To delete a custom key store from AWS KMS"
|
|
449
553
|
}
|
|
@@ -480,7 +584,7 @@
|
|
|
480
584
|
}
|
|
481
585
|
},
|
|
482
586
|
"description": "This example gets detailed information about all AWS KMS custom key stores in an AWS account and Region. To get all key stores, do not enter a custom key store name or ID.",
|
|
483
|
-
"id": "to-get-detailed-information-about-custom-key-stores-in-the-account-and-region-
|
|
587
|
+
"id": "to-get-detailed-information-about-custom-key-stores-in-the-account-and-region-1",
|
|
484
588
|
"title": "To get detailed information about custom key stores in the account and Region"
|
|
485
589
|
},
|
|
486
590
|
{
|
|
@@ -495,6 +599,7 @@
|
|
|
495
599
|
"CreationDate": "1.499288695918E9",
|
|
496
600
|
"CustomKeyStoreId": "cks-1234567890abcdef0",
|
|
497
601
|
"CustomKeyStoreName": "ExampleKeyStore",
|
|
602
|
+
"CustomKeyStoreType": "AWS_CLOUDHSM",
|
|
498
603
|
"TrustAnchorCertificate": "<certificate appears here>"
|
|
499
604
|
}
|
|
500
605
|
]
|
|
@@ -507,9 +612,76 @@
|
|
|
507
612
|
"CustomKeyStores": "Detailed information about the specified custom key store."
|
|
508
613
|
}
|
|
509
614
|
},
|
|
510
|
-
"description": "This example gets detailed information about a particular AWS
|
|
511
|
-
"id": "to-get-detailed-information-about-a-custom-key-store-
|
|
512
|
-
"title": "To get detailed information about
|
|
615
|
+
"description": "This example gets detailed information about a particular AWS CloudHSM key store by specifying its friendly name. To limit the output to a particular custom key store, provide either the custom key store name or ID.",
|
|
616
|
+
"id": "to-get-detailed-information-about-a-cloudhsm-custom-key-store-by-name-2",
|
|
617
|
+
"title": "To get detailed information about an AWS CloudHSM key store by specifying its friendly name"
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
"input": {
|
|
621
|
+
"CustomKeyStoreId": "cks-9876543210fedcba9"
|
|
622
|
+
},
|
|
623
|
+
"output": {
|
|
624
|
+
"CustomKeyStores": [
|
|
625
|
+
{
|
|
626
|
+
"ConnectionState": "CONNECTED",
|
|
627
|
+
"CreationDate": "1.599288695918E9",
|
|
628
|
+
"CustomKeyStoreId": "cks-9876543210fedcba9",
|
|
629
|
+
"CustomKeyStoreName": "ExampleExternalKeyStore",
|
|
630
|
+
"CustomKeyStoreType": "EXTERNAL_KEY_STORE",
|
|
631
|
+
"XksProxyConfiguration": {
|
|
632
|
+
"AccessKeyId": "ABCDE12345670EXAMPLE",
|
|
633
|
+
"Connectivity": "PUBLIC_ENDPOINT",
|
|
634
|
+
"UriEndpoint": "https://myproxy.xks.example.com",
|
|
635
|
+
"UriPath": "/kms/xks/v1"
|
|
636
|
+
}
|
|
637
|
+
}
|
|
638
|
+
]
|
|
639
|
+
},
|
|
640
|
+
"comments": {
|
|
641
|
+
"input": {
|
|
642
|
+
"CustomKeyStoreId": "The ID of the custom key store."
|
|
643
|
+
},
|
|
644
|
+
"output": {
|
|
645
|
+
"CustomKeyStores": "Detailed information about the specified custom key store."
|
|
646
|
+
}
|
|
647
|
+
},
|
|
648
|
+
"description": "This example gets detailed information about an external key store by specifying its ID. The example external key store proxy uses public endpoint connectivity.",
|
|
649
|
+
"id": "to-get-detailed-information-about-an-external-key-store--3",
|
|
650
|
+
"title": "To get detailed information about an external key store by specifying its ID"
|
|
651
|
+
},
|
|
652
|
+
{
|
|
653
|
+
"input": {
|
|
654
|
+
"CustomKeyStoreName": "VPCExternalKeystore"
|
|
655
|
+
},
|
|
656
|
+
"output": {
|
|
657
|
+
"CustomKeyStores": [
|
|
658
|
+
{
|
|
659
|
+
"ConnectionState": "CONNECTED",
|
|
660
|
+
"CreationDate": "1.643057863.842",
|
|
661
|
+
"CustomKeyStoreId": "cks-876543210fedcba98",
|
|
662
|
+
"CustomKeyStoreName": "ExampleVPCExternalKeyStore",
|
|
663
|
+
"CustomKeyStoreType": "EXTERNAL_KEY_STORE",
|
|
664
|
+
"XksProxyConfiguration": {
|
|
665
|
+
"AccessKeyId": "ABCDE12345670EXAMPLE",
|
|
666
|
+
"Connectivity": "VPC_ENDPOINT_SERVICE",
|
|
667
|
+
"UriEndpoint": "https://myproxy-private.xks.example.com",
|
|
668
|
+
"UriPath": "/example-prefix/kms/xks/v1",
|
|
669
|
+
"VpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-example1"
|
|
670
|
+
}
|
|
671
|
+
}
|
|
672
|
+
]
|
|
673
|
+
},
|
|
674
|
+
"comments": {
|
|
675
|
+
"input": {
|
|
676
|
+
"CustomKeyStoreId": "The ID of the custom key store."
|
|
677
|
+
},
|
|
678
|
+
"output": {
|
|
679
|
+
"CustomKeyStores": "Detailed information about the specified custom key store."
|
|
680
|
+
}
|
|
681
|
+
},
|
|
682
|
+
"description": "This example gets detailed information about a particular external key store by specifying its friendly name. To limit the output to a particular custom key store, provide either the custom key store name or ID. The proxy URI path for this external key store includes an optional prefix. Also, because this example external key store uses VPC endpoint connectivity, the response includes the associated VPC endpoint service name.",
|
|
683
|
+
"id": "to-get-detailed-information-about-an-external-custom-key-store-by-name-4",
|
|
684
|
+
"title": "To get detailed information about an external key store VPC endpoint connectivity by specifying its friendly name"
|
|
513
685
|
}
|
|
514
686
|
],
|
|
515
687
|
"DescribeKey": [
|
|
@@ -546,7 +718,7 @@
|
|
|
546
718
|
}
|
|
547
719
|
},
|
|
548
720
|
"description": "The following example gets metadata for a symmetric encryption KMS key.",
|
|
549
|
-
"id": "get-key-details-
|
|
721
|
+
"id": "get-key-details-1",
|
|
550
722
|
"title": "To get details about a KMS key"
|
|
551
723
|
},
|
|
552
724
|
{
|
|
@@ -587,7 +759,7 @@
|
|
|
587
759
|
}
|
|
588
760
|
},
|
|
589
761
|
"description": "The following example gets metadata for an asymmetric RSA KMS key used for signing and verification.",
|
|
590
|
-
"id": "to-get-details-about-an-rsa-asymmetric-kms-key-
|
|
762
|
+
"id": "to-get-details-about-an-rsa-asymmetric-kms-key-2",
|
|
591
763
|
"title": "To get details about an RSA asymmetric KMS key"
|
|
592
764
|
},
|
|
593
765
|
{
|
|
@@ -643,7 +815,7 @@
|
|
|
643
815
|
}
|
|
644
816
|
},
|
|
645
817
|
"description": "The following example gets metadata for a multi-Region replica key. This multi-Region key is a symmetric encryption key. DescribeKey returns information about the primary key and all of its replicas.",
|
|
646
|
-
"id": "to-get-details-about-a-multi-region-key-
|
|
818
|
+
"id": "to-get-details-about-a-multi-region-key-3",
|
|
647
819
|
"title": "To get details about a multi-Region key"
|
|
648
820
|
},
|
|
649
821
|
{
|
|
@@ -677,9 +849,87 @@
|
|
|
677
849
|
"KeyMetadata": "An object that contains information about the specified KMS key."
|
|
678
850
|
}
|
|
679
851
|
},
|
|
680
|
-
"description": "The following example gets the metadata of an HMAC KMS key.
|
|
681
|
-
"id": "to-get-details-about-an-hmac-kms-key-
|
|
852
|
+
"description": "The following example gets the metadata of an HMAC KMS key.",
|
|
853
|
+
"id": "to-get-details-about-an-hmac-kms-key-4",
|
|
682
854
|
"title": "To get details about an HMAC KMS key"
|
|
855
|
+
},
|
|
856
|
+
{
|
|
857
|
+
"input": {
|
|
858
|
+
"KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
859
|
+
},
|
|
860
|
+
"output": {
|
|
861
|
+
"KeyMetadata": {
|
|
862
|
+
"AWSAccountId": "123456789012",
|
|
863
|
+
"Arn": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
864
|
+
"CloudHsmClusterId": "cluster-1a23b4cdefg",
|
|
865
|
+
"CreationDate": 1646160362.664,
|
|
866
|
+
"CustomKeyStoreId": "cks-1234567890abcdef0",
|
|
867
|
+
"CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
|
|
868
|
+
"Description": "CloudHSM key store test key",
|
|
869
|
+
"Enabled": true,
|
|
870
|
+
"EncryptionAlgorithms": [
|
|
871
|
+
"SYMMETRIC_DEFAULT"
|
|
872
|
+
],
|
|
873
|
+
"KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
874
|
+
"KeyManager": "CUSTOMER",
|
|
875
|
+
"KeySpec": "SYMMETRIC_DEFAULT",
|
|
876
|
+
"KeyState": "Enabled",
|
|
877
|
+
"KeyUsage": "ENCRYPT_DECRYPT",
|
|
878
|
+
"MultiRegion": false,
|
|
879
|
+
"Origin": "AWS_CLOUDHSM"
|
|
880
|
+
}
|
|
881
|
+
},
|
|
882
|
+
"comments": {
|
|
883
|
+
"input": {
|
|
884
|
+
"KeyId": "An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key."
|
|
885
|
+
},
|
|
886
|
+
"output": {
|
|
887
|
+
"KeyMetadata": "An object that contains information about the specified KMS key."
|
|
888
|
+
}
|
|
889
|
+
},
|
|
890
|
+
"description": "The following example gets the metadata of a KMS key in an AWS CloudHSM key store.",
|
|
891
|
+
"id": "to-get-details-about-a-kms-key-in-an-AWS-CloudHSM-key-store-5",
|
|
892
|
+
"title": "To get details about a KMS key in an AWS CloudHSM key store"
|
|
893
|
+
},
|
|
894
|
+
{
|
|
895
|
+
"input": {
|
|
896
|
+
"KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
897
|
+
},
|
|
898
|
+
"output": {
|
|
899
|
+
"KeyMetadata": {
|
|
900
|
+
"AWSAccountId": "123456789012",
|
|
901
|
+
"Arn": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
902
|
+
"CreationDate": 1646160362.664,
|
|
903
|
+
"CustomKeyStoreId": "cks-1234567890abcdef0",
|
|
904
|
+
"CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
|
|
905
|
+
"Description": "External key store test key",
|
|
906
|
+
"Enabled": true,
|
|
907
|
+
"EncryptionAlgorithms": [
|
|
908
|
+
"SYMMETRIC_DEFAULT"
|
|
909
|
+
],
|
|
910
|
+
"KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
911
|
+
"KeyManager": "CUSTOMER",
|
|
912
|
+
"KeySpec": "SYMMETRIC_DEFAULT",
|
|
913
|
+
"KeyState": "Enabled",
|
|
914
|
+
"KeyUsage": "ENCRYPT_DECRYPT",
|
|
915
|
+
"MultiRegion": false,
|
|
916
|
+
"Origin": "EXTERNAL_KEY_STORE",
|
|
917
|
+
"XksKeyConfiguration": {
|
|
918
|
+
"Id": "bb8562717f809024"
|
|
919
|
+
}
|
|
920
|
+
}
|
|
921
|
+
},
|
|
922
|
+
"comments": {
|
|
923
|
+
"input": {
|
|
924
|
+
"KeyId": "An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key."
|
|
925
|
+
},
|
|
926
|
+
"output": {
|
|
927
|
+
"KeyMetadata": "An object that contains information about the specified KMS key."
|
|
928
|
+
}
|
|
929
|
+
},
|
|
930
|
+
"description": "The following example gets the metadata of a KMS key in an external key store.",
|
|
931
|
+
"id": "to-get-details-about-a-kms-key-in-an-external-key-store-6",
|
|
932
|
+
"title": "To get details about a KMS key in an external key store"
|
|
683
933
|
}
|
|
684
934
|
],
|
|
685
935
|
"DisableKey": [
|
|
@@ -726,7 +976,7 @@
|
|
|
726
976
|
"output": {
|
|
727
977
|
}
|
|
728
978
|
},
|
|
729
|
-
"description": "This example disconnects an AWS KMS custom key store from its AWS CloudHSM cluster. This operation doesn't return any data. To verify that the custom key store is disconnected, use the <code>DescribeCustomKeyStores</code> operation.",
|
|
979
|
+
"description": "This example disconnects an AWS KMS custom key store from its backing key store. For an AWS CloudHSM key store, it disconnects the key store from its AWS CloudHSM cluster. For an external key store, it disconnects the key store from the external key store proxy that communicates with your external key manager. This operation doesn't return any data. To verify that the custom key store is disconnected, use the <code>DescribeCustomKeyStores</code> operation.",
|
|
730
980
|
"id": "to-disconnect-a-custom-key-store-from-its-cloudhsm-cluster-1628627955156",
|
|
731
981
|
"title": "To disconnect a custom key store from its CloudHSM cluster"
|
|
732
982
|
}
|
|
@@ -1452,7 +1702,7 @@
|
|
|
1452
1702
|
"ReplicaTags": "The tags on the replica key, if any."
|
|
1453
1703
|
}
|
|
1454
1704
|
},
|
|
1455
|
-
"description": "This example creates a multi-Region replica key in us-west-2 of a multi-Region primary key in us-east-1.
|
|
1705
|
+
"description": "This example creates a multi-Region replica key in us-west-2 of a multi-Region primary key in us-east-1.",
|
|
1456
1706
|
"id": "to-replicate-a-multi-region-key-in-a-different-aws-region-1628622402887",
|
|
1457
1707
|
"title": "To replicate a multi-Region key in a different AWS Region"
|
|
1458
1708
|
}
|
|
@@ -1622,9 +1872,9 @@
|
|
|
1622
1872
|
"output": {
|
|
1623
1873
|
}
|
|
1624
1874
|
},
|
|
1625
|
-
"description": "This example tells KMS the password for the kmsuser crypto user in the AWS CloudHSM cluster that is associated with the AWS KMS custom key store. (It does not change the password in the CloudHSM cluster.) This operation does not return any data.",
|
|
1626
|
-
"id": "to-edit-the-properties-of-a-custom-key-store-
|
|
1627
|
-
"title": "To edit the password of
|
|
1875
|
+
"description": "This example tells AWS KMS the password for the kmsuser crypto user in the AWS CloudHSM cluster that is associated with the AWS KMS custom key store. (It does not change the password in the CloudHSM cluster.) This operation does not return any data.",
|
|
1876
|
+
"id": "to-edit-the-properties-of-a-custom-key-store-1",
|
|
1877
|
+
"title": "To edit the password of an AWS CloudHSM key store"
|
|
1628
1878
|
},
|
|
1629
1879
|
{
|
|
1630
1880
|
"input": {
|
|
@@ -1642,7 +1892,7 @@
|
|
|
1642
1892
|
}
|
|
1643
1893
|
},
|
|
1644
1894
|
"description": "This example changes the friendly name of the AWS KMS custom key store to the name that you specify. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation.",
|
|
1645
|
-
"id": "to-edit-the-friendly-name-of-a-custom-key-store-
|
|
1895
|
+
"id": "to-edit-the-friendly-name-of-a-custom-key-store-2",
|
|
1646
1896
|
"title": "To edit the friendly name of a custom key store"
|
|
1647
1897
|
},
|
|
1648
1898
|
{
|
|
@@ -1660,9 +1910,51 @@
|
|
|
1660
1910
|
"output": {
|
|
1661
1911
|
}
|
|
1662
1912
|
},
|
|
1663
|
-
"description": "This example changes the cluster that is associated with
|
|
1664
|
-
"id": "to-associate-the-custom-key-store-with-a-different-but-related-aws-cloudhsm-cluster-
|
|
1913
|
+
"description": "This example changes the AWS CloudHSM cluster that is associated with an AWS CloudHSM key store to a related cluster, such as a different backup of the same cluster. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation.",
|
|
1914
|
+
"id": "to-associate-the-custom-key-store-with-a-different-but-related-aws-cloudhsm-cluster-3",
|
|
1665
1915
|
"title": "To associate the custom key store with a different, but related, AWS CloudHSM cluster."
|
|
1916
|
+
},
|
|
1917
|
+
{
|
|
1918
|
+
"input": {
|
|
1919
|
+
"CustomKeyStoreId": "cks-1234567890abcdef0",
|
|
1920
|
+
"XksProxyUriPath": "/new-path/kms/xks/v1"
|
|
1921
|
+
},
|
|
1922
|
+
"output": {
|
|
1923
|
+
},
|
|
1924
|
+
"comments": {
|
|
1925
|
+
"input": {
|
|
1926
|
+
"CustomKeyStoreId": "The ID of the custom key store that you are updating",
|
|
1927
|
+
"XksProxyUriPath": "The URI path to the external key store proxy APIs"
|
|
1928
|
+
},
|
|
1929
|
+
"output": {
|
|
1930
|
+
}
|
|
1931
|
+
},
|
|
1932
|
+
"description": "This example updates the proxy URI path for an external key store",
|
|
1933
|
+
"id": "to-update-the-xks-proxy-api-path-of-an-external-custom-key-store-4",
|
|
1934
|
+
"title": "To edit the proxy URI path of an external key store."
|
|
1935
|
+
},
|
|
1936
|
+
{
|
|
1937
|
+
"input": {
|
|
1938
|
+
"CustomKeyStoreId": "cks-1234567890abcdef0",
|
|
1939
|
+
"XksProxyConnectivity": "VPC_ENDPOINT_SERVICE",
|
|
1940
|
+
"XksProxyUriEndpoint": "https://myproxy-private.xks.example.com",
|
|
1941
|
+
"XksProxyVpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-example"
|
|
1942
|
+
},
|
|
1943
|
+
"output": {
|
|
1944
|
+
},
|
|
1945
|
+
"comments": {
|
|
1946
|
+
"input": {
|
|
1947
|
+
"CustomKeyStoreId": "Identifies the custom key store",
|
|
1948
|
+
"XksProxyConnectivity": "Specifies the connectivity option",
|
|
1949
|
+
"XksProxyUriEndpoint": "Specifies the URI endpoint that AWS KMS uses when communicating with the external key store proxy",
|
|
1950
|
+
"XksProxyVpcEndpointServiceName": "Specifies the name of the VPC endpoint service that the proxy uses for communication"
|
|
1951
|
+
},
|
|
1952
|
+
"output": {
|
|
1953
|
+
}
|
|
1954
|
+
},
|
|
1955
|
+
"description": "To change the external key store proxy connectivity option from public endpoint connectivity to VPC endpoint service connectivity, in addition to changing the <code>XksProxyConnectivity</code> value, you must change the <code>XksProxyUriEndpoint</code> value to reflect the private DNS name associated with the VPC endpoint service. You must also add an <code>XksProxyVpcEndpointServiceName</code> value.",
|
|
1956
|
+
"id": "to-update-the-proxy-connectivity-of-an-external-key-store-to-vpc_endpoint_service-5",
|
|
1957
|
+
"title": "To update the proxy connectivity of an external key store to VPC_ENDPOINT_SERVICE"
|
|
1666
1958
|
}
|
|
1667
1959
|
],
|
|
1668
1960
|
"UpdateKeyDescription": [
|
|
@@ -1682,6 +1974,23 @@
|
|
|
1682
1974
|
"title": "To update the description of a KMS key"
|
|
1683
1975
|
}
|
|
1684
1976
|
],
|
|
1977
|
+
"UpdatePrimaryRegion": [
|
|
1978
|
+
{
|
|
1979
|
+
"input": {
|
|
1980
|
+
"KeyId": "arn:aws:kms:us-west-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
|
|
1981
|
+
"PrimaryRegion": "eu-central-1"
|
|
1982
|
+
},
|
|
1983
|
+
"comments": {
|
|
1984
|
+
"input": {
|
|
1985
|
+
"KeyId": "The current primary key.",
|
|
1986
|
+
"PrimaryRegion": "The Region of the replica key that will become the primary key."
|
|
1987
|
+
}
|
|
1988
|
+
},
|
|
1989
|
+
"description": "The following UpdatePrimaryRegion example changes the multi-Region replica key in the eu-central-1 Region to the primary key. The current primary key in the us-west-1 Region becomes a replica key. \n\nThe KeyId parameter identifies the current primary key in the us-west-1 Region. The PrimaryRegion parameter indicates the Region of the replica key that will become the new primary key.\n\nThis operation does not return any output. To verify that primary key is changed, use the DescribeKey operation.",
|
|
1990
|
+
"id": "to-update-the-primary-region-of-a-multi-region-kms-key-1660249555577",
|
|
1991
|
+
"title": "To update the primary Region of a multi-Region KMS key"
|
|
1992
|
+
}
|
|
1993
|
+
],
|
|
1685
1994
|
"Verify": [
|
|
1686
1995
|
{
|
|
1687
1996
|
"input": {
|
|
@@ -1710,7 +2019,7 @@
|
|
|
1710
2019
|
"SigningAlgorithm": "The signing algorithm that was used to verify the signature."
|
|
1711
2020
|
}
|
|
1712
2021
|
},
|
|
1713
|
-
"description": "This operation uses the public key in an elliptic curve (ECC) asymmetric key to verify a digital signature within AWS KMS.
|
|
2022
|
+
"description": "This operation uses the public key in an elliptic curve (ECC) asymmetric key to verify a digital signature within AWS KMS.",
|
|
1714
2023
|
"id": "to-use-an-asymmetric-kms-key-to-verify-a-digital-signature-1628633365663",
|
|
1715
2024
|
"title": "To use an asymmetric KMS key to verify a digital signature"
|
|
1716
2025
|
}
|