UNPKG

169 kBPlain TextView Raw
1{
2 "author": {
3 "name": "Amazon Web Services",
4 "organization": true,
5 "roles": [
6 "author"
7 ],
8 "url": "https://aws.amazon.com"
9 },
10 "dependencies": {
11 "@aws-cdk/aws-iam": "1.191.0",
12 "@aws-cdk/cloud-assembly-schema": "1.191.0",
13 "@aws-cdk/core": "1.191.0",
14 "@aws-cdk/cx-api": "1.191.0",
15 "constructs": "^3.3.69"
16 },
17 "dependencyClosure": {
18 "@aws-cdk/aws-iam": {
19 "targets": {
20 "dotnet": {
21 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
22 "namespace": "Amazon.CDK.AWS.IAM",
23 "packageId": "Amazon.CDK.AWS.IAM"
24 },
25 "java": {
26 "maven": {
27 "artifactId": "iam",
28 "groupId": "software.amazon.awscdk"
29 },
30 "package": "software.amazon.awscdk.services.iam"
31 },
32 "js": {
33 "npm": "@aws-cdk/aws-iam"
34 },
35 "python": {
36 "classifiers": [
37 "Framework :: AWS CDK",
38 "Framework :: AWS CDK :: 1"
39 ],
40 "distName": "aws-cdk.aws-iam",
41 "module": "aws_cdk.aws_iam"
42 }
43 }
44 },
45 "@aws-cdk/cloud-assembly-schema": {
46 "targets": {
47 "dotnet": {
48 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
49 "namespace": "Amazon.CDK.CloudAssembly.Schema",
50 "packageId": "Amazon.CDK.CloudAssembly.Schema"
51 },
52 "java": {
53 "maven": {
54 "artifactId": "cdk-cloud-assembly-schema",
55 "groupId": "software.amazon.awscdk"
56 },
57 "package": "software.amazon.awscdk.cloudassembly.schema"
58 },
59 "js": {
60 "npm": "@aws-cdk/cloud-assembly-schema"
61 },
62 "python": {
63 "classifiers": [
64 "Framework :: AWS CDK",
65 "Framework :: AWS CDK :: 1"
66 ],
67 "distName": "aws-cdk.cloud-assembly-schema",
68 "module": "aws_cdk.cloud_assembly_schema"
69 }
70 }
71 },
72 "@aws-cdk/core": {
73 "targets": {
74 "dotnet": {
75 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
76 "namespace": "Amazon.CDK",
77 "packageId": "Amazon.CDK"
78 },
79 "java": {
80 "maven": {
81 "artifactId": "core",
82 "groupId": "software.amazon.awscdk"
83 },
84 "package": "software.amazon.awscdk.core"
85 },
86 "js": {
87 "npm": "@aws-cdk/core"
88 },
89 "python": {
90 "classifiers": [
91 "Framework :: AWS CDK",
92 "Framework :: AWS CDK :: 1"
93 ],
94 "distName": "aws-cdk.core",
95 "module": "aws_cdk.core"
96 }
97 }
98 },
99 "@aws-cdk/cx-api": {
100 "targets": {
101 "dotnet": {
102 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
103 "namespace": "Amazon.CDK.CXAPI",
104 "packageId": "Amazon.CDK.CXAPI"
105 },
106 "java": {
107 "maven": {
108 "artifactId": "cdk-cx-api",
109 "groupId": "software.amazon.awscdk"
110 },
111 "package": "software.amazon.awscdk.cxapi"
112 },
113 "js": {
114 "npm": "@aws-cdk/cx-api"
115 },
116 "python": {
117 "classifiers": [
118 "Framework :: AWS CDK",
119 "Framework :: AWS CDK :: 1"
120 ],
121 "distName": "aws-cdk.cx-api",
122 "module": "aws_cdk.cx_api"
123 }
124 }
125 },
126 "@aws-cdk/region-info": {
127 "targets": {
128 "dotnet": {
129 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
130 "namespace": "Amazon.CDK.RegionInfo",
131 "packageId": "Amazon.CDK.RegionInfo"
132 },
133 "java": {
134 "maven": {
135 "artifactId": "cdk-region-info",
136 "groupId": "software.amazon.awscdk"
137 },
138 "package": "software.amazon.awscdk.regioninfo"
139 },
140 "js": {
141 "npm": "@aws-cdk/region-info"
142 },
143 "python": {
144 "classifiers": [
145 "Framework :: AWS CDK",
146 "Framework :: AWS CDK :: 1"
147 ],
148 "distName": "aws-cdk.region-info",
149 "module": "aws_cdk.region_info"
150 }
151 }
152 },
153 "constructs": {
154 "targets": {
155 "dotnet": {
156 "namespace": "Constructs",
157 "packageId": "Constructs"
158 },
159 "go": {
160 "moduleName": "github.com/aws/constructs-go"
161 },
162 "java": {
163 "maven": {
164 "artifactId": "constructs",
165 "groupId": "software.constructs"
166 },
167 "package": "software.constructs"
168 },
169 "js": {
170 "npm": "constructs"
171 },
172 "python": {
173 "distName": "constructs",
174 "module": "constructs"
175 }
176 }
177 }
178 },
179 "description": "The CDK Construct Library for AWS::KMS",
180 "docs": {
181 "stability": "stable"
182 },
183 "homepage": "https://github.com/aws/aws-cdk",
184 "jsiiVersion": "1.73.0 (build 6faeda3)",
185 "keywords": [
186 "aws",
187 "cdk",
188 "constructs",
189 "kms"
190 ],
191 "license": "Apache-2.0",
192 "metadata": {
193 "jsii": {
194 "compiledWithDeprecationWarnings": true,
195 "pacmak": {
196 "hasDefaultInterfaces": true
197 },
198 "rosetta": {
199 "strict": true
200 }
201 }
202 },
203 "name": "@aws-cdk/aws-kms",
204 "readme": {
205 "markdown": "# AWS Key Management Service Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)\n\n![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)\n\n---\n\n<!--END STABILITY BANNER-->\n\nDefine a KMS key:\n\n```ts\nnew kms.Key(this, 'MyKey', {\n enableKeyRotation: true,\n});\n```\n\nDefine a KMS key with waiting period:\n\nSpecifies the number of days in the waiting period before AWS KMS deletes a CMK that has been removed from a CloudFormation stack.\n\n```ts\nconst key = new kms.Key(this, 'MyKey', {\n pendingWindow: Duration.days(10), // Default to 30 Days\n});\n```\n\n\nAdd a couple of aliases:\n\n```ts\nconst key = new kms.Key(this, 'MyKey');\nkey.addAlias('alias/foo');\nkey.addAlias('alias/bar');\n```\n\n\nDefine a key with specific key spec and key usage:\n\nValid `keySpec` values depends on `keyUsage` value.\n\n```ts\nconst key = new kms.Key(this, 'MyKey', {\n keySpec: kms.KeySpec.ECC_SECG_P256K1, // Default to SYMMETRIC_DEFAULT\n keyUsage: kms.KeyUsage.SIGN_VERIFY, // and ENCRYPT_DECRYPT\n});\n```\n\n## Sharing keys between stacks\n\nTo use a KMS key in a different stack in the same CDK application,\npass the construct to the other stack:\n\n```ts lit=test/integ.key-sharing.lit.ts\n\n/**\n * Stack that defines the key\n */\nclass KeyStack extends cdk.Stack {\n public readonly key: kms.Key;\n\n constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {\n super(scope, id, props);\n this.key = new kms.Key(this, 'MyKey', { removalPolicy: cdk.RemovalPolicy.DESTROY });\n }\n}\n\ninterface UseStackProps extends cdk.StackProps {\n key: kms.IKey; // Use IKey here\n}\n\n/**\n * Stack that uses the key\n */\nclass UseStack extends cdk.Stack {\n constructor(scope: cdk.App, id: string, props: UseStackProps) {\n super(scope, id, props);\n\n // Use the IKey object here.\n new kms.Alias(this, 'Alias', {\n aliasName: 'alias/foo',\n targetKey: props.key,\n });\n }\n}\n\nconst keyStack = new KeyStack(app, 'KeyStack');\nnew UseStack(app, 'UseStack', { key: keyStack.key });\n```\n\n\n## Importing existing keys\n\n### Import key by ARN\n\nTo use a KMS key that is not defined in this CDK app, but is created through other means, use\n`Key.fromKeyArn(parent, name, ref)`:\n\n```ts\nconst myKeyImported = kms.Key.fromKeyArn(this, 'MyImportedKey', 'arn:aws:...');\n\n// you can do stuff with this imported key.\nmyKeyImported.addAlias('alias/foo');\n```\n\nNote that a call to `.addToResourcePolicy(statement)` on `myKeyImported` will not have\nan affect on the key's policy because it is not owned by your stack. The call\nwill be a no-op.\n\n### Import key by alias\n\nIf a Key has an associated Alias, the Alias can be imported by name and used in place\nof the Key as a reference. A common scenario for this is in referencing AWS managed keys.\n\n```ts\nimport * as cloudtrail from '@aws-cdk/aws-cloudtrail';\n\nconst myKeyAlias = kms.Alias.fromAliasName(this, 'myKey', 'alias/aws/s3');\nconst trail = new cloudtrail.Trail(this, 'myCloudTrail', {\n sendToCloudWatchLogs: true,\n kmsKey: myKeyAlias,\n});\n```\n\nNote that calls to `addToResourcePolicy` and `grant*` methods on `myKeyAlias` will be\nno-ops, and `addAlias` and `aliasTargetKey` will fail, as the imported alias does not\nhave a reference to the underlying KMS Key.\n\n### Lookup key by alias\n\nIf you can't use a KMS key imported by alias (e.g. because you need access to the key id), you can lookup the key with `Key.fromLookup()`.\n\nIn general, the preferred method would be to use `Alias.fromAliasName()` which returns an `IAlias` object which extends `IKey`. However, some services need to have access to the underlying key id. In this case, `Key.fromLookup()` allows to lookup the key id.\n\nThe result of the `Key.fromLookup()` operation will be written to a file\ncalled `cdk.context.json`. You must commit this file to source control so\nthat the lookup values are available in non-privileged environments such\nas CI build steps, and to ensure your template builds are repeatable.\n\nHere's how `Key.fromLookup()` can be used:\n\n```ts\nconst myKeyLookup = kms.Key.fromLookup(this, 'MyKeyLookup', {\n aliasName: 'alias/KeyAlias',\n});\n\nconst role = new iam.Role(this, 'MyRole', {\n assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),\n});\nmyKeyLookup.grantEncryptDecrypt(role);\n```\n\nNote that a call to `.addToResourcePolicy(statement)` on `myKeyLookup` will not have\nan affect on the key's policy because it is not owned by your stack. The call\nwill be a no-op.\n\n## Key Policies\n\nControlling access and usage of KMS Keys requires the use of key policies (resource-based policies attached to the key);\nthis is in contrast to most other AWS resources where access can be entirely controlled with IAM policies,\nand optionally complemented with resource policies. For more in-depth understanding of KMS key access and policies, see\n\n* https://docs.aws.amazon.com/kms/latest/developerguide/control-access-overview.html\n* https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html\n\nKMS keys can be created to trust IAM policies. This is the default behavior for both the KMS APIs and in\nthe console. This behavior is enabled by the '@aws-cdk/aws-kms:defaultKeyPolicies' feature flag,\nwhich is set for all new projects; for existing projects, this same behavior can be enabled by\npassing the `trustAccountIdentities` property as `true` when creating the key:\n\n```ts\nnew kms.Key(this, 'MyKey', { trustAccountIdentities: true });\n```\n\nWith either the `@aws-cdk/aws-kms:defaultKeyPolicies` feature flag set,\nor the `trustAccountIdentities` prop set, the Key will be given the following default key policy:\n\n```json\n{\n \"Effect\": \"Allow\",\n \"Principal\": {\"AWS\": \"arn:aws:iam::111122223333:root\"},\n \"Action\": \"kms:*\",\n \"Resource\": \"*\"\n}\n```\n\nThis policy grants full access to the key to the root account user.\nThis enables the root account user -- via IAM policies -- to grant access to other IAM principals.\nWith the above default policy, future permissions can be added to either the key policy or IAM principal policy.\n\n```ts\nconst key = new kms.Key(this, 'MyKey');\nconst user = new iam.User(this, 'MyUser');\nkey.grantEncrypt(user); // Adds encrypt permissions to user policy; key policy is unmodified.\n```\n\nAdopting the default KMS key policy (and so trusting account identities)\nsolves many issues around cyclic dependencies between stacks.\nWithout this default key policy, future permissions must be added to both the key policy and IAM principal policy,\nwhich can cause cyclic dependencies if the permissions cross stack boundaries.\n(For example, an encrypted bucket in one stack, and Lambda function that accesses it in another.)\n\n### Appending to or replacing the default key policy\n\nThe default key policy can be amended or replaced entirely, depending on your use case and requirements.\nA common addition to the key policy would be to add other key admins that are allowed to administer the key\n(e.g., change permissions, revoke, delete). Additional key admins can be specified at key creation or after\nvia the `grantAdmin` method.\n\n```ts\nconst myTrustedAdminRole = iam.Role.fromRoleArn(this, 'TrustedRole', 'arn:aws:iam:....');\nconst key = new kms.Key(this, 'MyKey', {\n admins: [myTrustedAdminRole],\n});\n\nconst secondKey = new kms.Key(this, 'MyKey2');\nsecondKey.grantAdmin(myTrustedAdminRole);\n```\n\nAlternatively, a custom key policy can be specified, which will replace the default key policy.\n\n> **Note**: In applications without the '@aws-cdk/aws-kms:defaultKeyPolicies' feature flag set\nand with `trustedAccountIdentities` set to false (the default), specifying a policy at key creation _appends_ the\nprovided policy to the default key policy, rather than _replacing_ the default policy.\n\n```ts\nconst myTrustedAdminRole = iam.Role.fromRoleArn(this, 'TrustedRole', 'arn:aws:iam:....');\n// Creates a limited admin policy and assigns to the account root.\nconst myCustomPolicy = new iam.PolicyDocument({\n statements: [new iam.PolicyStatement({\n actions: [\n 'kms:Create*',\n 'kms:Describe*',\n 'kms:Enable*',\n 'kms:List*',\n 'kms:Put*',\n ],\n principals: [new iam.AccountRootPrincipal()],\n resources: ['*'],\n })],\n});\nconst key = new kms.Key(this, 'MyKey', {\n policy: myCustomPolicy,\n});\n```\n\n> **Warning:** Replacing the default key policy with one that only grants access to a specific user or role\nruns the risk of the key becoming unmanageable if that user or role is deleted.\nIt is highly recommended that the key policy grants access to the account root, rather than specific principals.\nSee https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html for more information.\n"
206 },
207 "repository": {
208 "directory": "packages/@aws-cdk/aws-kms",
209 "type": "git",
210 "url": "https://github.com/aws/aws-cdk.git"
211 },
212 "schema": "jsii/0.10.0",
213 "targets": {
214 "dotnet": {
215 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
216 "namespace": "Amazon.CDK.AWS.KMS",
217 "packageId": "Amazon.CDK.AWS.KMS"
218 },
219 "java": {
220 "maven": {
221 "artifactId": "kms",
222 "groupId": "software.amazon.awscdk"
223 },
224 "package": "software.amazon.awscdk.services.kms"
225 },
226 "js": {
227 "npm": "@aws-cdk/aws-kms"
228 },
229 "python": {
230 "classifiers": [
231 "Framework :: AWS CDK",
232 "Framework :: AWS CDK :: 1"
233 ],
234 "distName": "aws-cdk.aws-kms",
235 "module": "aws_cdk.aws_kms"
236 }
237 },
238 "types": {
239 "@aws-cdk/aws-kms.Alias": {
240 "assembly": "@aws-cdk/aws-kms",
241 "base": "@aws-cdk/core.Resource",
242 "docs": {
243 "custom": {
244 "resource": "AWS::KMS::Alias",
245 "exampleMetadata": "infused"
246 },
247 "remarks": "Using an alias to refer to a key can help you simplify key\nmanagement. For example, when rotating keys, you can just update the alias\nmapping instead of tracking and changing key IDs. For more information, see\nWorking with Aliases in the AWS Key Management Service Developer Guide.\n\nYou can also add an alias for a key by calling `key.addAlias(alias)`.",
248 "stability": "stable",
249 "summary": "Defines a display name for a customer master key (CMK) in AWS Key Management Service (AWS KMS).",
250 "example": "// Passing an encrypted replication bucket created in a different stack.\nconst app = new App();\nconst replicationStack = new Stack(app, 'ReplicationStack', {\n env: {\n region: 'us-west-1',\n },\n});\nconst key = new kms.Key(replicationStack, 'ReplicationKey');\nconst alias = new kms.Alias(replicationStack, 'ReplicationAlias', {\n // aliasName is required\n aliasName: PhysicalName.GENERATE_IF_NEEDED,\n targetKey: key,\n});\nconst replicationBucket = new s3.Bucket(replicationStack, 'ReplicationBucket', {\n bucketName: PhysicalName.GENERATE_IF_NEEDED,\n encryptionKey: alias,\n});"
251 },
252 "fqn": "@aws-cdk/aws-kms.Alias",
253 "initializer": {
254 "docs": {
255 "stability": "stable"
256 },
257 "locationInModule": {
258 "filename": "lib/alias.ts",
259 "line": 171
260 },
261 "parameters": [
262 {
263 "name": "scope",
264 "type": {
265 "fqn": "constructs.Construct"
266 }
267 },
268 {
269 "name": "id",
270 "type": {
271 "primitive": "string"
272 }
273 },
274 {
275 "name": "props",
276 "type": {
277 "fqn": "@aws-cdk/aws-kms.AliasProps"
278 }
279 }
280 ]
281 },
282 "interfaces": [
283 "@aws-cdk/aws-kms.IAlias"
284 ],
285 "kind": "class",
286 "locationInModule": {
287 "filename": "lib/alias.ts",
288 "line": 124
289 },
290 "methods": [
291 {
292 "docs": {
293 "stability": "stable",
294 "summary": "Import an existing KMS Alias defined outside the CDK app."
295 },
296 "locationInModule": {
297 "filename": "lib/alias.ts",
298 "line": 132
299 },
300 "name": "fromAliasAttributes",
301 "parameters": [
302 {
303 "docs": {
304 "summary": "The parent creating construct (usually `this`)."
305 },
306 "name": "scope",
307 "type": {
308 "fqn": "constructs.Construct"
309 }
310 },
311 {
312 "docs": {
313 "summary": "The construct's name."
314 },
315 "name": "id",
316 "type": {
317 "primitive": "string"
318 }
319 },
320 {
321 "docs": {
322 "summary": "the properties of the referenced KMS Alias."
323 },
324 "name": "attrs",
325 "type": {
326 "fqn": "@aws-cdk/aws-kms.AliasAttributes"
327 }
328 }
329 ],
330 "returns": {
331 "type": {
332 "fqn": "@aws-cdk/aws-kms.IAlias"
333 }
334 },
335 "static": true
336 },
337 {
338 "docs": {
339 "remarks": "This method should be used\ninstead of 'fromAliasAttributes' when the underlying KMS Key ARN is not available.\nThis Alias will not have a direct reference to the KMS Key, so addAlias and grant* methods are not supported.",
340 "stability": "stable",
341 "summary": "Import an existing KMS Alias defined outside the CDK app, by the alias name."
342 },
343 "locationInModule": {
344 "filename": "lib/alias.ts",
345 "line": 149
346 },
347 "name": "fromAliasName",
348 "parameters": [
349 {
350 "docs": {
351 "summary": "The parent creating construct (usually `this`)."
352 },
353 "name": "scope",
354 "type": {
355 "fqn": "constructs.Construct"
356 }
357 },
358 {
359 "docs": {
360 "summary": "The construct's name."
361 },
362 "name": "id",
363 "type": {
364 "primitive": "string"
365 }
366 },
367 {
368 "docs": {
369 "summary": "The full name of the KMS Alias (e.g., 'alias/aws/s3', 'alias/myKeyAlias')."
370 },
371 "name": "aliasName",
372 "type": {
373 "primitive": "string"
374 }
375 }
376 ],
377 "returns": {
378 "type": {
379 "fqn": "@aws-cdk/aws-kms.IAlias"
380 }
381 },
382 "static": true
383 },
384 {
385 "docs": {
386 "stability": "stable",
387 "summary": "Defines a new alias for the key."
388 },
389 "locationInModule": {
390 "filename": "lib/alias.ts",
391 "line": 73
392 },
393 "name": "addAlias",
394 "overrides": "@aws-cdk/aws-kms.IKey",
395 "parameters": [
396 {
397 "name": "alias",
398 "type": {
399 "primitive": "string"
400 }
401 }
402 ],
403 "returns": {
404 "type": {
405 "fqn": "@aws-cdk/aws-kms.Alias"
406 }
407 }
408 },
409 {
410 "docs": {
411 "stability": "stable",
412 "summary": "Adds a statement to the KMS key resource policy."
413 },
414 "locationInModule": {
415 "filename": "lib/alias.ts",
416 "line": 77
417 },
418 "name": "addToResourcePolicy",
419 "overrides": "@aws-cdk/aws-kms.IKey",
420 "parameters": [
421 {
422 "name": "statement",
423 "type": {
424 "fqn": "@aws-cdk/aws-iam.PolicyStatement"
425 }
426 },
427 {
428 "name": "allowNoOp",
429 "optional": true,
430 "type": {
431 "primitive": "boolean"
432 }
433 }
434 ],
435 "returns": {
436 "type": {
437 "fqn": "@aws-cdk/aws-iam.AddToResourcePolicyResult"
438 }
439 }
440 },
441 {
442 "docs": {
443 "stability": "stable"
444 },
445 "locationInModule": {
446 "filename": "lib/alias.ts",
447 "line": 210
448 },
449 "name": "generatePhysicalName",
450 "overrides": "@aws-cdk/core.Resource",
451 "protected": true,
452 "returns": {
453 "type": {
454 "primitive": "string"
455 }
456 }
457 },
458 {
459 "docs": {
460 "stability": "stable",
461 "summary": "Grant the indicated permissions on this key to the given principal."
462 },
463 "locationInModule": {
464 "filename": "lib/alias.ts",
465 "line": 81
466 },
467 "name": "grant",
468 "overrides": "@aws-cdk/aws-kms.IKey",
469 "parameters": [
470 {
471 "name": "grantee",
472 "type": {
473 "fqn": "@aws-cdk/aws-iam.IGrantable"
474 }
475 },
476 {
477 "name": "actions",
478 "type": {
479 "primitive": "string"
480 },
481 "variadic": true
482 }
483 ],
484 "returns": {
485 "type": {
486 "fqn": "@aws-cdk/aws-iam.Grant"
487 }
488 },
489 "variadic": true
490 },
491 {
492 "docs": {
493 "stability": "stable",
494 "summary": "Grant decryption permissions using this key to the given principal."
495 },
496 "locationInModule": {
497 "filename": "lib/alias.ts",
498 "line": 85
499 },
500 "name": "grantDecrypt",
501 "overrides": "@aws-cdk/aws-kms.IKey",
502 "parameters": [
503 {
504 "name": "grantee",
505 "type": {
506 "fqn": "@aws-cdk/aws-iam.IGrantable"
507 }
508 }
509 ],
510 "returns": {
511 "type": {
512 "fqn": "@aws-cdk/aws-iam.Grant"
513 }
514 }
515 },
516 {
517 "docs": {
518 "stability": "stable",
519 "summary": "Grant encryption permissions using this key to the given principal."
520 },
521 "locationInModule": {
522 "filename": "lib/alias.ts",
523 "line": 89
524 },
525 "name": "grantEncrypt",
526 "overrides": "@aws-cdk/aws-kms.IKey",
527 "parameters": [
528 {
529 "name": "grantee",
530 "type": {
531 "fqn": "@aws-cdk/aws-iam.IGrantable"
532 }
533 }
534 ],
535 "returns": {
536 "type": {
537 "fqn": "@aws-cdk/aws-iam.Grant"
538 }
539 }
540 },
541 {
542 "docs": {
543 "stability": "stable",
544 "summary": "Grant encryption and decryption permissions using this key to the given principal."
545 },
546 "locationInModule": {
547 "filename": "lib/alias.ts",
548 "line": 93
549 },
550 "name": "grantEncryptDecrypt",
551 "overrides": "@aws-cdk/aws-kms.IKey",
552 "parameters": [
553 {
554 "name": "grantee",
555 "type": {
556 "fqn": "@aws-cdk/aws-iam.IGrantable"
557 }
558 }
559 ],
560 "returns": {
561 "type": {
562 "fqn": "@aws-cdk/aws-iam.Grant"
563 }
564 }
565 }
566 ],
567 "name": "Alias",
568 "properties": [
569 {
570 "docs": {
571 "stability": "stable",
572 "summary": "The name of the alias."
573 },
574 "immutable": true,
575 "locationInModule": {
576 "filename": "lib/alias.ts",
577 "line": 168
578 },
579 "name": "aliasName",
580 "overrides": "@aws-cdk/aws-kms.IAlias",
581 "type": {
582 "primitive": "string"
583 }
584 },
585 {
586 "docs": {
587 "stability": "stable",
588 "summary": "The Key to which the Alias refers."
589 },
590 "immutable": true,
591 "locationInModule": {
592 "filename": "lib/alias.ts",
593 "line": 169
594 },
595 "name": "aliasTargetKey",
596 "overrides": "@aws-cdk/aws-kms.IAlias",
597 "type": {
598 "fqn": "@aws-cdk/aws-kms.IKey"
599 }
600 },
601 {
602 "docs": {
603 "stability": "stable",
604 "summary": "The ARN of the key."
605 },
606 "immutable": true,
607 "locationInModule": {
608 "filename": "lib/alias.ts",
609 "line": 61
610 },
611 "name": "keyArn",
612 "overrides": "@aws-cdk/aws-kms.IKey",
613 "type": {
614 "primitive": "string"
615 }
616 },
617 {
618 "docs": {
619 "stability": "stable",
620 "summary": "The ID of the key (the part that looks something like: 1234abcd-12ab-34cd-56ef-1234567890ab)."
621 },
622 "immutable": true,
623 "locationInModule": {
624 "filename": "lib/alias.ts",
625 "line": 69
626 },
627 "name": "keyId",
628 "overrides": "@aws-cdk/aws-kms.IKey",
629 "type": {
630 "primitive": "string"
631 }
632 }
633 ],
634 "symbolId": "lib/alias:Alias"
635 },
636 "@aws-cdk/aws-kms.AliasAttributes": {
637 "assembly": "@aws-cdk/aws-kms",
638 "datatype": true,
639 "docs": {
640 "stability": "stable",
641 "summary": "Properties of a reference to an existing KMS Alias.",
642 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as kms from '@aws-cdk/aws-kms';\n\ndeclare const key: kms.Key;\nconst aliasAttributes: kms.AliasAttributes = {\n aliasName: 'aliasName',\n aliasTargetKey: key,\n};",
643 "custom": {
644 "exampleMetadata": "fixture=_generated"
645 }
646 },
647 "fqn": "@aws-cdk/aws-kms.AliasAttributes",
648 "kind": "interface",
649 "locationInModule": {
650 "filename": "lib/alias.ts",
651 "line": 101
652 },
653 "name": "AliasAttributes",
654 "properties": [
655 {
656 "abstract": true,
657 "docs": {
658 "remarks": "This value must begin with alias/ followed by a name (i.e. alias/ExampleAlias)",
659 "stability": "stable",
660 "summary": "Specifies the alias name."
661 },
662 "immutable": true,
663 "locationInModule": {
664 "filename": "lib/alias.ts",
665 "line": 105
666 },
667 "name": "aliasName",
668 "type": {
669 "primitive": "string"
670 }
671 },
672 {
673 "abstract": true,
674 "docs": {
675 "stability": "stable",
676 "summary": "The customer master key (CMK) to which the Alias refers."
677 },
678 "immutable": true,
679 "locationInModule": {
680 "filename": "lib/alias.ts",
681 "line": 110
682 },
683 "name": "aliasTargetKey",
684 "type": {
685 "fqn": "@aws-cdk/aws-kms.IKey"
686 }
687 }
688 ],
689 "symbolId": "lib/alias:AliasAttributes"
690 },
691 "@aws-cdk/aws-kms.AliasProps": {
692 "assembly": "@aws-cdk/aws-kms",
693 "datatype": true,
694 "docs": {
695 "stability": "stable",
696 "summary": "Construction properties for a KMS Key Alias object.",
697 "example": "\n/**\n * Stack that defines the key\n */\nclass KeyStack extends cdk.Stack {\n public readonly key: kms.Key;\n\n constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {\n super(scope, id, props);\n this.key = new kms.Key(this, 'MyKey', { removalPolicy: cdk.RemovalPolicy.DESTROY });\n }\n}\n\ninterface UseStackProps extends cdk.StackProps {\n key: kms.IKey; // Use IKey here\n}\n\n/**\n * Stack that uses the key\n */\nclass UseStack extends cdk.Stack {\n constructor(scope: cdk.App, id: string, props: UseStackProps) {\n super(scope, id, props);\n\n // Use the IKey object here.\n new kms.Alias(this, 'Alias', {\n aliasName: 'alias/foo',\n targetKey: props.key,\n });\n }\n}\n\nconst keyStack = new KeyStack(app, 'KeyStack');\nnew UseStack(app, 'UseStack', { key: keyStack.key });",
698 "custom": {
699 "exampleMetadata": "lit=test/integ.key-sharing.lit.ts infused"
700 }
701 },
702 "fqn": "@aws-cdk/aws-kms.AliasProps",
703 "kind": "interface",
704 "locationInModule": {
705 "filename": "lib/alias.ts",
706 "line": 33
707 },
708 "name": "AliasProps",
709 "properties": [
710 {
711 "abstract": true,
712 "docs": {
713 "remarks": "The name must start with alias followed by a\nforward slash, such as alias/. You can't specify aliases that begin with\nalias/AWS. These aliases are reserved.",
714 "stability": "stable",
715 "summary": "The name of the alias."
716 },
717 "immutable": true,
718 "locationInModule": {
719 "filename": "lib/alias.ts",
720 "line": 39
721 },
722 "name": "aliasName",
723 "type": {
724 "primitive": "string"
725 }
726 },
727 {
728 "abstract": true,
729 "docs": {
730 "remarks": "Specify the key's\nglobally unique identifier or Amazon Resource Name (ARN). You can't\nspecify another alias.",
731 "stability": "stable",
732 "summary": "The ID of the key for which you are creating the alias."
733 },
734 "immutable": true,
735 "locationInModule": {
736 "filename": "lib/alias.ts",
737 "line": 46
738 },
739 "name": "targetKey",
740 "type": {
741 "fqn": "@aws-cdk/aws-kms.IKey"
742 }
743 },
744 {
745 "abstract": true,
746 "docs": {
747 "default": "- The alias will be deleted",
748 "stability": "stable",
749 "summary": "Policy to apply when the alias is removed from this stack."
750 },
751 "immutable": true,
752 "locationInModule": {
753 "filename": "lib/alias.ts",
754 "line": 53
755 },
756 "name": "removalPolicy",
757 "optional": true,
758 "type": {
759 "fqn": "@aws-cdk/core.RemovalPolicy"
760 }
761 }
762 ],
763 "symbolId": "lib/alias:AliasProps"
764 },
765 "@aws-cdk/aws-kms.CfnAlias": {
766 "assembly": "@aws-cdk/aws-kms",
767 "base": "@aws-cdk/core.CfnResource",
768 "docs": {
769 "custom": {
770 "cloudformationResource": "AWS::KMS::Alias",
771 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html",
772 "exampleMetadata": "fixture=_generated"
773 },
774 "remarks": "The `AWS::KMS::Alias` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) . You can use an alias to identify a KMS key in the AWS KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) , such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html) .\n\n> Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* .\n\nUsing an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys in different AWS Regions . For more information, see [Using aliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the *AWS Key Management Service Developer Guide* .\n\nWhen specifying an alias, observe the following rules.\n\n- Each alias is associated with one KMS key, but multiple aliases can be associated with the same KMS key.\n- The alias and its associated KMS key must be in the same AWS account and Region.\n- The alias name must be unique in the AWS account and Region. However, you can create aliases with the same name in different AWS Regions . For example, you can have an `alias/projectKey` in multiple Regions, each of which is associated with a KMS key in its Region.\n- Each alias name must begin with `alias/` followed by a name, such as `alias/exampleKey` . The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with `alias/aws/` . That alias name prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) .\n\n*Regions*\n\nAWS KMS CloudFormation resources are available in all AWS Regions in which AWS KMS and AWS CloudFormation are supported.",
775 "stability": "external",
776 "summary": "A CloudFormation `AWS::KMS::Alias`.",
777 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as kms from '@aws-cdk/aws-kms';\nconst cfnAlias = new kms.CfnAlias(this, 'MyCfnAlias', {\n aliasName: 'aliasName',\n targetKeyId: 'targetKeyId',\n});"
778 },
779 "fqn": "@aws-cdk/aws-kms.CfnAlias",
780 "initializer": {
781 "docs": {
782 "stability": "external",
783 "summary": "Create a new `AWS::KMS::Alias`."
784 },
785 "locationInModule": {
786 "filename": "lib/kms.generated.ts",
787 "line": 203
788 },
789 "parameters": [
790 {
791 "docs": {
792 "summary": "- scope in which this resource is defined."
793 },
794 "name": "scope",
795 "type": {
796 "fqn": "@aws-cdk/core.Construct"
797 }
798 },
799 {
800 "docs": {
801 "summary": "- scoped id of the resource."
802 },
803 "name": "id",
804 "type": {
805 "primitive": "string"
806 }
807 },
808 {
809 "docs": {
810 "summary": "- resource properties."
811 },
812 "name": "props",
813 "type": {
814 "fqn": "@aws-cdk/aws-kms.CfnAliasProps"
815 }
816 }
817 ]
818 },
819 "interfaces": [
820 "@aws-cdk/core.IInspectable"
821 ],
822 "kind": "class",
823 "locationInModule": {
824 "filename": "lib/kms.generated.ts",
825 "line": 134
826 },
827 "methods": [
828 {
829 "docs": {
830 "stability": "external",
831 "summary": "Examines the CloudFormation resource and discloses attributes."
832 },
833 "locationInModule": {
834 "filename": "lib/kms.generated.ts",
835 "line": 218
836 },
837 "name": "inspect",
838 "overrides": "@aws-cdk/core.IInspectable",
839 "parameters": [
840 {
841 "docs": {
842 "summary": "- tree inspector to collect and process attributes."
843 },
844 "name": "inspector",
845 "type": {
846 "fqn": "@aws-cdk/core.TreeInspector"
847 }
848 }
849 ]
850 },
851 {
852 "docs": {
853 "stability": "external"
854 },
855 "locationInModule": {
856 "filename": "lib/kms.generated.ts",
857 "line": 230
858 },
859 "name": "renderProperties",
860 "overrides": "@aws-cdk/core.CfnResource",
861 "parameters": [
862 {
863 "name": "props",
864 "type": {
865 "collection": {
866 "elementtype": {
867 "primitive": "any"
868 },
869 "kind": "map"
870 }
871 }
872 }
873 ],
874 "protected": true,
875 "returns": {
876 "type": {
877 "collection": {
878 "elementtype": {
879 "primitive": "any"
880 },
881 "kind": "map"
882 }
883 }
884 }
885 }
886 ],
887 "name": "CfnAlias",
888 "properties": [
889 {
890 "const": true,
891 "docs": {
892 "stability": "external",
893 "summary": "The CloudFormation resource type name for this resource class."
894 },
895 "immutable": true,
896 "locationInModule": {
897 "filename": "lib/kms.generated.ts",
898 "line": 138
899 },
900 "name": "CFN_RESOURCE_TYPE_NAME",
901 "static": true,
902 "type": {
903 "primitive": "string"
904 }
905 },
906 {
907 "docs": {
908 "stability": "external"
909 },
910 "immutable": true,
911 "locationInModule": {
912 "filename": "lib/kms.generated.ts",
913 "line": 223
914 },
915 "name": "cfnProperties",
916 "overrides": "@aws-cdk/core.CfnResource",
917 "protected": true,
918 "type": {
919 "collection": {
920 "elementtype": {
921 "primitive": "any"
922 },
923 "kind": "map"
924 }
925 }
926 },
927 {
928 "docs": {
929 "custom": {
930 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-aliasname"
931 },
932 "remarks": "> If you change the value of the `AliasName` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).\n\nThe alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with `alias/aws/` . The `alias/aws/` prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) .\n\n*Pattern* : `^alias/[a-zA-Z0-9/_-]+$`\n\n*Minimum* : `1`\n\n*Maximum* : `256`",
933 "stability": "external",
934 "summary": "Specifies the alias name. This value must begin with `alias/` followed by a name, such as `alias/ExampleAlias` ."
935 },
936 "locationInModule": {
937 "filename": "lib/kms.generated.ts",
938 "line": 174
939 },
940 "name": "aliasName",
941 "type": {
942 "primitive": "string"
943 }
944 },
945 {
946 "docs": {
947 "custom": {
948 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-targetkeyid"
949 },
950 "remarks": "A valid key ID is required. If you supply a null or empty string value, this operation returns an error.\n\nFor help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *AWS Key Management Service Developer Guide* .\n\nSpecify the key ID or the key ARN of the KMS key.\n\nFor example:\n\n- Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`\n- Key ARN: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`\n\nTo get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) .",
951 "stability": "external",
952 "summary": "Associates the alias with the specified [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) . The KMS key must be in the same AWS account and Region."
953 },
954 "locationInModule": {
955 "filename": "lib/kms.generated.ts",
956 "line": 194
957 },
958 "name": "targetKeyId",
959 "type": {
960 "primitive": "string"
961 }
962 }
963 ],
964 "symbolId": "lib/kms.generated:CfnAlias"
965 },
966 "@aws-cdk/aws-kms.CfnAliasProps": {
967 "assembly": "@aws-cdk/aws-kms",
968 "datatype": true,
969 "docs": {
970 "custom": {
971 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html",
972 "exampleMetadata": "fixture=_generated"
973 },
974 "stability": "external",
975 "summary": "Properties for defining a `CfnAlias`.",
976 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as kms from '@aws-cdk/aws-kms';\nconst cfnAliasProps: kms.CfnAliasProps = {\n aliasName: 'aliasName',\n targetKeyId: 'targetKeyId',\n};"
977 },
978 "fqn": "@aws-cdk/aws-kms.CfnAliasProps",
979 "kind": "interface",
980 "locationInModule": {
981 "filename": "lib/kms.generated.ts",
982 "line": 19
983 },
984 "name": "CfnAliasProps",
985 "properties": [
986 {
987 "abstract": true,
988 "docs": {
989 "custom": {
990 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-aliasname"
991 },
992 "remarks": "> If you change the value of the `AliasName` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).\n\nThe alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with `alias/aws/` . The `alias/aws/` prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) .\n\n*Pattern* : `^alias/[a-zA-Z0-9/_-]+$`\n\n*Minimum* : `1`\n\n*Maximum* : `256`",
993 "stability": "external",
994 "summary": "Specifies the alias name. This value must begin with `alias/` followed by a name, such as `alias/ExampleAlias` ."
995 },
996 "immutable": true,
997 "locationInModule": {
998 "filename": "lib/kms.generated.ts",
999 "line": 36
1000 },
1001 "name": "aliasName",
1002 "type": {
1003 "primitive": "string"
1004 }
1005 },
1006 {
1007 "abstract": true,
1008 "docs": {
1009 "custom": {
1010 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-targetkeyid"
1011 },
1012 "remarks": "A valid key ID is required. If you supply a null or empty string value, this operation returns an error.\n\nFor help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *AWS Key Management Service Developer Guide* .\n\nSpecify the key ID or the key ARN of the KMS key.\n\nFor example:\n\n- Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`\n- Key ARN: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`\n\nTo get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) .",
1013 "stability": "external",
1014 "summary": "Associates the alias with the specified [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) . The KMS key must be in the same AWS account and Region."
1015 },
1016 "immutable": true,
1017 "locationInModule": {
1018 "filename": "lib/kms.generated.ts",
1019 "line": 56
1020 },
1021 "name": "targetKeyId",
1022 "type": {
1023 "primitive": "string"
1024 }
1025 }
1026 ],
1027 "symbolId": "lib/kms.generated:CfnAliasProps"
1028 },
1029 "@aws-cdk/aws-kms.CfnKey": {
1030 "assembly": "@aws-cdk/aws-kms",
1031 "base": "@aws-cdk/core.CfnResource",
1032 "docs": {
1033 "custom": {
1034 "cloudformationResource": "AWS::KMS::Key",
1035 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html",
1036 "exampleMetadata": "infused"
1037 },
1038 "remarks": "The `AWS::KMS::Key` resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in AWS Key Management Service . You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use `AWS::KMS::Key` to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the `AWS::KMS::ReplicaKey` resource.\n\n> If you change the value of the `KeySpec` , `KeyUsage` , or `MultiRegion` properties of an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) . This prevents you from accidentally deleting a KMS key by changing any of its immutable property values. > AWS KMS replaced the term *customer master key (CMK)* with *AWS KMS key* and *KMS key* . The concept has not changed. To prevent breaking changes, AWS KMS is keeping some variations of this term.\n\nYou can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with AWS KMS](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration) . For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *AWS Key Management Service Developer Guide* .\n\nYou can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric `KeySpec` value and a `KeyUsage` value. For details, see [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *AWS Key Management Service Developer Guide* .\n\nYou can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC `KeySpec` value and a `KeyUsage` value of `GENERATE_VERIFY_MAC` . For details, see [HMAC keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *AWS Key Management Service Developer Guide* .\n\nYou can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the `MultiRegion` property to `true` . For information about multi-Region keys, see [Multi-Region keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide* .\n\nYou cannot use the `AWS::KMS::Key` resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) .\n\n*Regions*\n\nAWS KMS CloudFormation resources are available in all Regions in which AWS KMS and AWS CloudFormation are supported. You can use the `AWS::KMS::Key` resource to create and manage all KMS key types that are supported in a Region.",
1039 "stability": "external",
1040 "summary": "A CloudFormation `AWS::KMS::Key`.",
1041 "example": "declare const cfnTemplate: cfn_inc.CfnInclude;\nconst cfnKey = cfnTemplate.getResource('Key') as kms.CfnKey;\nconst key = kms.Key.fromCfnKey(cfnKey);"
1042 },
1043 "fqn": "@aws-cdk/aws-kms.CfnKey",
1044 "initializer": {
1045 "docs": {
1046 "stability": "external",
1047 "summary": "Create a new `AWS::KMS::Key`."
1048 },
1049 "locationInModule": {
1050 "filename": "lib/kms.generated.ts",
1051 "line": 710
1052 },
1053 "parameters": [
1054 {
1055 "docs": {
1056 "summary": "- scope in which this resource is defined."
1057 },
1058 "name": "scope",
1059 "type": {
1060 "fqn": "@aws-cdk/core.Construct"
1061 }
1062 },
1063 {
1064 "docs": {
1065 "summary": "- scoped id of the resource."
1066 },
1067 "name": "id",
1068 "type": {
1069 "primitive": "string"
1070 }
1071 },
1072 {
1073 "docs": {
1074 "summary": "- resource properties."
1075 },
1076 "name": "props",
1077 "type": {
1078 "fqn": "@aws-cdk/aws-kms.CfnKeyProps"
1079 }
1080 }
1081 ]
1082 },
1083 "interfaces": [
1084 "@aws-cdk/core.IInspectable"
1085 ],
1086 "kind": "class",
1087 "locationInModule": {
1088 "filename": "lib/kms.generated.ts",
1089 "line": 502
1090 },
1091 "methods": [
1092 {
1093 "docs": {
1094 "stability": "external",
1095 "summary": "Examines the CloudFormation resource and discloses attributes."
1096 },
1097 "locationInModule": {
1098 "filename": "lib/kms.generated.ts",
1099 "line": 733
1100 },
1101 "name": "inspect",
1102 "overrides": "@aws-cdk/core.IInspectable",
1103 "parameters": [
1104 {
1105 "docs": {
1106 "summary": "- tree inspector to collect and process attributes."
1107 },
1108 "name": "inspector",
1109 "type": {
1110 "fqn": "@aws-cdk/core.TreeInspector"
1111 }
1112 }
1113 ]
1114 },
1115 {
1116 "docs": {
1117 "stability": "external"
1118 },
1119 "locationInModule": {
1120 "filename": "lib/kms.generated.ts",
1121 "line": 752
1122 },
1123 "name": "renderProperties",
1124 "overrides": "@aws-cdk/core.CfnResource",
1125 "parameters": [
1126 {
1127 "name": "props",
1128 "type": {
1129 "collection": {
1130 "elementtype": {
1131 "primitive": "any"
1132 },
1133 "kind": "map"
1134 }
1135 }
1136 }
1137 ],
1138 "protected": true,
1139 "returns": {
1140 "type": {
1141 "collection": {
1142 "elementtype": {
1143 "primitive": "any"
1144 },
1145 "kind": "map"
1146 }
1147 }
1148 }
1149 }
1150 ],
1151 "name": "CfnKey",
1152 "properties": [
1153 {
1154 "const": true,
1155 "docs": {
1156 "stability": "external",
1157 "summary": "The CloudFormation resource type name for this resource class."
1158 },
1159 "immutable": true,
1160 "locationInModule": {
1161 "filename": "lib/kms.generated.ts",
1162 "line": 506
1163 },
1164 "name": "CFN_RESOURCE_TYPE_NAME",
1165 "static": true,
1166 "type": {
1167 "primitive": "string"
1168 }
1169 },
1170 {
1171 "docs": {
1172 "custom": {
1173 "cloudformationAttribute": "Arn"
1174 },
1175 "remarks": "For information about the key ARN of a KMS key, see [Key ARN](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) in the *AWS Key Management Service Developer Guide* .",
1176 "stability": "external",
1177 "summary": "The Amazon Resource Name (ARN) of the KMS key, such as `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` ."
1178 },
1179 "immutable": true,
1180 "locationInModule": {
1181 "filename": "lib/kms.generated.ts",
1182 "line": 533
1183 },
1184 "name": "attrArn",
1185 "type": {
1186 "primitive": "string"
1187 }
1188 },
1189 {
1190 "docs": {
1191 "custom": {
1192 "cloudformationAttribute": "KeyId"
1193 },
1194 "remarks": "For information about the key ID of a KMS key, see [Key ID](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) in the *AWS Key Management Service Developer Guide* .",
1195 "stability": "external",
1196 "summary": "The key ID of the KMS key, such as `1234abcd-12ab-34cd-56ef-1234567890ab` ."
1197 },
1198 "immutable": true,
1199 "locationInModule": {
1200 "filename": "lib/kms.generated.ts",
1201 "line": 541
1202 },
1203 "name": "attrKeyId",
1204 "type": {
1205 "primitive": "string"
1206 }
1207 },
1208 {
1209 "docs": {
1210 "stability": "external"
1211 },
1212 "immutable": true,
1213 "locationInModule": {
1214 "filename": "lib/kms.generated.ts",
1215 "line": 738
1216 },
1217 "name": "cfnProperties",
1218 "overrides": "@aws-cdk/core.CfnResource",
1219 "protected": true,
1220 "type": {
1221 "collection": {
1222 "elementtype": {
1223 "primitive": "any"
1224 },
1225 "kind": "map"
1226 }
1227 }
1228 },
1229 {
1230 "docs": {
1231 "custom": {
1232 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-tags"
1233 },
1234 "remarks": "> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* .\n\nFor information about tags in AWS KMS , see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *AWS Key Management Service Developer Guide* . For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .",
1235 "stability": "external",
1236 "summary": "Assigns one or more tags to the replica key."
1237 },
1238 "immutable": true,
1239 "locationInModule": {
1240 "filename": "lib/kms.generated.ts",
1241 "line": 701
1242 },
1243 "name": "tags",
1244 "type": {
1245 "fqn": "@aws-cdk/core.TagManager"
1246 }
1247 },
1248 {
1249 "docs": {
1250 "custom": {
1251 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keypolicy"
1252 },
1253 "remarks": "- The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the **AWS Key Management Service Developer Guide** .\n- Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS . When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS . For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide* .\n\nIf you are unsure of which policy to use, consider the *default key policy* . This is the key policy that AWS KMS applies to KMS keys that are created by using the CreateKey API with no specified key policy. It gives the AWS account that owns the key permission to perform all operations on the key. It also allows you write IAM policies to authorize access to the key. For details, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *AWS Key Management Service Developer Guide* .\n\nA key policy document can include only the following characters:\n\n- Printable ASCII characters\n- Printable characters in the Basic Latin and Latin-1 Supplement character set\n- The tab ( `\\ u0009` ), line feed ( `\\ u000A` ), and carriage return ( `\\ u000D` ) special characters\n\n*Minimum* : `1`\n\n*Maximum* : `32768`",
1254 "stability": "external",
1255 "summary": "The key policy that authorizes use of the KMS key. The key policy must conform to the following rules."
1256 },
1257 "locationInModule": {
1258 "filename": "lib/kms.generated.ts",
1259 "line": 563
1260 },
1261 "name": "keyPolicy",
1262 "type": {
1263 "primitive": "any"
1264 }
1265 },
1266 {
1267 "docs": {
1268 "custom": {
1269 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-description"
1270 },
1271 "remarks": "Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.",
1272 "stability": "external",
1273 "summary": "A description of the KMS key."
1274 },
1275 "locationInModule": {
1276 "filename": "lib/kms.generated.ts",
1277 "line": 570
1278 },
1279 "name": "description",
1280 "optional": true,
1281 "type": {
1282 "primitive": "string"
1283 }
1284 },
1285 {
1286 "docs": {
1287 "custom": {
1288 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enabled"
1289 },
1290 "remarks": "When `Enabled` is `true` , the *key state* of the KMS key is `Enabled` . When `Enabled` is `false` , the key state of the KMS key is `Disabled` . The default value is `true` .\n\nThe actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html) , [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html) , or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations.\n\nFor information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* .",
1291 "stability": "external",
1292 "summary": "Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations."
1293 },
1294 "locationInModule": {
1295 "filename": "lib/kms.generated.ts",
1296 "line": 583
1297 },
1298 "name": "enabled",
1299 "optional": true,
1300 "type": {
1301 "union": {
1302 "types": [
1303 {
1304 "primitive": "boolean"
1305 },
1306 {
1307 "fqn": "@aws-cdk/core.IResolvable"
1308 }
1309 ]
1310 }
1311 }
1312 },
1313 {
1314 "docs": {
1315 "custom": {
1316 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enablekeyrotation"
1317 },
1318 "remarks": "By default, automatic key rotation is not enabled.\n\nAWS KMS supports automatic rotation only for symmetric encryption KMS keys ( `KeySpec` = `SYMMETRIC_DEFAULT` ). For asymmetric KMS keys and HMAC KMS keys, omit the `EnableKeyRotation` property or set it to `false` .\n\nTo enable automatic key rotation of the key material for a multi-Region KMS key, set `EnableKeyRotation` to `true` on the primary key (created by using `AWS::KMS::Key` ). AWS KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *AWS Key Management Service Developer Guide* .\n\nWhen you enable automatic rotation, AWS KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. AWS KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *AWS Key Management Service Developer Guide* .",
1319 "stability": "external",
1320 "summary": "Enables automatic rotation of the key material for the specified KMS key."
1321 },
1322 "locationInModule": {
1323 "filename": "lib/kms.generated.ts",
1324 "line": 596
1325 },
1326 "name": "enableKeyRotation",
1327 "optional": true,
1328 "type": {
1329 "union": {
1330 "types": [
1331 {
1332 "primitive": "boolean"
1333 },
1334 {
1335 "fqn": "@aws-cdk/core.IResolvable"
1336 }
1337 ]
1338 }
1339 }
1340 },
1341 {
1342 "docs": {
1343 "custom": {
1344 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyspec"
1345 },
1346 "remarks": "The default value, `SYMMETRIC_DEFAULT` , creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, `SYMMETRIC_DEFAULT` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the `KeySpec` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *AWS Key Management Service Developer Guide* .\n\nThe `KeySpec` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [AWS KMS condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *AWS Key Management Service Developer Guide* .\n\n> If you change the value of the `KeySpec` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) . This prevents you from accidentally deleting a KMS key by changing an immutable property value. > [AWS services that are integrated with AWS KMS](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *AWS Key Management Service Developer Guide* .\n\nAWS KMS supports the following key specs for KMS keys:\n\n- Symmetric encryption key (default)\n\n- `SYMMETRIC_DEFAULT` (AES-256-GCM)\n- HMAC keys (symmetric)\n\n- `HMAC_224`\n- `HMAC_256`\n- `HMAC_384`\n- `HMAC_512`\n- Asymmetric RSA key pairs\n\n- `RSA_2048`\n- `RSA_3072`\n- `RSA_4096`\n- Asymmetric NIST-recommended elliptic curve key pairs\n\n- `ECC_NIST_P256` (secp256r1)\n- `ECC_NIST_P384` (secp384r1)\n- `ECC_NIST_P521` (secp521r1)\n- Other asymmetric elliptic curve key pairs\n\n- `ECC_SECG_P256K1` (secp256k1), commonly used for cryptocurrencies.\n- SM2 key pairs (China Regions only)\n\n- `SM2`",
1347 "stability": "external",
1348 "summary": "Specifies the type of KMS key to create."
1349 },
1350 "locationInModule": {
1351 "filename": "lib/kms.generated.ts",
1352 "line": 635
1353 },
1354 "name": "keySpec",
1355 "optional": true,
1356 "type": {
1357 "primitive": "string"
1358 }
1359 },
1360 {
1361 "docs": {
1362 "custom": {
1363 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyusage"
1364 },
1365 "remarks": "> If you change the value of the `KeyUsage` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) . This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n\nSelect only one valid value.\n\n- For symmetric encryption KMS keys, omit the property or specify `ENCRYPT_DECRYPT` .\n- For asymmetric KMS keys with RSA key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY` .\n- For asymmetric KMS keys with ECC key material, specify `SIGN_VERIFY` .\n- For asymmetric KMS keys with SM2 (China Regions only) key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY` .\n- For HMAC KMS keys, specify `GENERATE_VERIFY_MAC` .",
1366 "stability": "external",
1367 "summary": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is `ENCRYPT_DECRYPT` . This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the `KeyUsage` value after the KMS key is created."
1368 },
1369 "locationInModule": {
1370 "filename": "lib/kms.generated.ts",
1371 "line": 652
1372 },
1373 "name": "keyUsage",
1374 "optional": true,
1375 "type": {
1376 "primitive": "string"
1377 }
1378 },
1379 {
1380 "docs": {
1381 "custom": {
1382 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-multiregion"
1383 },
1384 "remarks": "You can't change the `MultiRegion` value after the KMS key is created.\n\nFor a list of AWS Regions in which multi-Region keys are supported, see [Multi-Region keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the ** .\n\n> If you change the value of the `MultiRegion` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) . This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n\nFor a multi-Region key, set to this property to `true` . For a single-Region key, omit this property or set it to `false` . The default value is `false` .\n\n*Multi-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions . Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide* .\n\nYou can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.\n\nTo create a replica of this primary key in a different AWS Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.",
1385 "stability": "external",
1386 "summary": "Creates a multi-Region primary key that you can replicate in other AWS Regions ."
1387 },
1388 "locationInModule": {
1389 "filename": "lib/kms.generated.ts",
1390 "line": 671
1391 },
1392 "name": "multiRegion",
1393 "optional": true,
1394 "type": {
1395 "union": {
1396 "types": [
1397 {
1398 "primitive": "boolean"
1399 },
1400 {
1401 "fqn": "@aws-cdk/core.IResolvable"
1402 }
1403 ]
1404 }
1405 }
1406 },
1407 {
1408 "docs": {
1409 "custom": {
1410 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-pendingwindowindays"
1411 },
1412 "remarks": "Enter a value between 7 and 30 days. The default value is 30 days.\n\nWhen you remove a KMS key from a CloudFormation stack, AWS KMS schedules the KMS key for deletion and starts the mandatory waiting period. The `PendingWindowInDays` property determines the length of waiting period. During the waiting period, the key state of KMS key is `Pending Deletion` or `Pending Replica Deletion` , which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the KMS key.\n\nAWS KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to `PendingReplicaDeletion` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to `PendingDeletion` and the waiting period specified by `PendingWindowInDays` begins. When this waiting period expires, AWS KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide* .\n\nYou cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the AWS KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.\n\nFor information about the `Pending Deletion` and `Pending Replica Deletion` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* . For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide* .\n\n*Minimum* : 7\n\n*Maximum* : 30",
1413 "stability": "external",
1414 "summary": "Specifies the number of days in the waiting period before AWS KMS deletes a KMS key that has been removed from a CloudFormation stack."
1415 },
1416 "locationInModule": {
1417 "filename": "lib/kms.generated.ts",
1418 "line": 690
1419 },
1420 "name": "pendingWindowInDays",
1421 "optional": true,
1422 "type": {
1423 "primitive": "number"
1424 }
1425 }
1426 ],
1427 "symbolId": "lib/kms.generated:CfnKey"
1428 },
1429 "@aws-cdk/aws-kms.CfnKeyProps": {
1430 "assembly": "@aws-cdk/aws-kms",
1431 "datatype": true,
1432 "docs": {
1433 "custom": {
1434 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html",
1435 "exampleMetadata": "fixture=_generated"
1436 },
1437 "stability": "external",
1438 "summary": "Properties for defining a `CfnKey`.",
1439 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as kms from '@aws-cdk/aws-kms';\n\ndeclare const keyPolicy: any;\nconst cfnKeyProps: kms.CfnKeyProps = {\n keyPolicy: keyPolicy,\n\n // the properties below are optional\n description: 'description',\n enabled: false,\n enableKeyRotation: false,\n keySpec: 'keySpec',\n keyUsage: 'keyUsage',\n multiRegion: false,\n pendingWindowInDays: 123,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};"
1440 },
1441 "fqn": "@aws-cdk/aws-kms.CfnKeyProps",
1442 "kind": "interface",
1443 "locationInModule": {
1444 "filename": "lib/kms.generated.ts",
1445 "line": 243
1446 },
1447 "name": "CfnKeyProps",
1448 "properties": [
1449 {
1450 "abstract": true,
1451 "docs": {
1452 "custom": {
1453 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keypolicy"
1454 },
1455 "remarks": "- The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the **AWS Key Management Service Developer Guide** .\n- Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS . When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS . For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide* .\n\nIf you are unsure of which policy to use, consider the *default key policy* . This is the key policy that AWS KMS applies to KMS keys that are created by using the CreateKey API with no specified key policy. It gives the AWS account that owns the key permission to perform all operations on the key. It also allows you write IAM policies to authorize access to the key. For details, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *AWS Key Management Service Developer Guide* .\n\nA key policy document can include only the following characters:\n\n- Printable ASCII characters\n- Printable characters in the Basic Latin and Latin-1 Supplement character set\n- The tab ( `\\ u0009` ), line feed ( `\\ u000A` ), and carriage return ( `\\ u000D` ) special characters\n\n*Minimum* : `1`\n\n*Maximum* : `32768`",
1456 "stability": "external",
1457 "summary": "The key policy that authorizes use of the KMS key. The key policy must conform to the following rules."
1458 },
1459 "immutable": true,
1460 "locationInModule": {
1461 "filename": "lib/kms.generated.ts",
1462 "line": 265
1463 },
1464 "name": "keyPolicy",
1465 "type": {
1466 "primitive": "any"
1467 }
1468 },
1469 {
1470 "abstract": true,
1471 "docs": {
1472 "custom": {
1473 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-description"
1474 },
1475 "remarks": "Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.",
1476 "stability": "external",
1477 "summary": "A description of the KMS key."
1478 },
1479 "immutable": true,
1480 "locationInModule": {
1481 "filename": "lib/kms.generated.ts",
1482 "line": 272
1483 },
1484 "name": "description",
1485 "optional": true,
1486 "type": {
1487 "primitive": "string"
1488 }
1489 },
1490 {
1491 "abstract": true,
1492 "docs": {
1493 "custom": {
1494 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enabled"
1495 },
1496 "remarks": "When `Enabled` is `true` , the *key state* of the KMS key is `Enabled` . When `Enabled` is `false` , the key state of the KMS key is `Disabled` . The default value is `true` .\n\nThe actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html) , [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html) , or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations.\n\nFor information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* .",
1497 "stability": "external",
1498 "summary": "Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations."
1499 },
1500 "immutable": true,
1501 "locationInModule": {
1502 "filename": "lib/kms.generated.ts",
1503 "line": 285
1504 },
1505 "name": "enabled",
1506 "optional": true,
1507 "type": {
1508 "union": {
1509 "types": [
1510 {
1511 "primitive": "boolean"
1512 },
1513 {
1514 "fqn": "@aws-cdk/core.IResolvable"
1515 }
1516 ]
1517 }
1518 }
1519 },
1520 {
1521 "abstract": true,
1522 "docs": {
1523 "custom": {
1524 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enablekeyrotation"
1525 },
1526 "remarks": "By default, automatic key rotation is not enabled.\n\nAWS KMS supports automatic rotation only for symmetric encryption KMS keys ( `KeySpec` = `SYMMETRIC_DEFAULT` ). For asymmetric KMS keys and HMAC KMS keys, omit the `EnableKeyRotation` property or set it to `false` .\n\nTo enable automatic key rotation of the key material for a multi-Region KMS key, set `EnableKeyRotation` to `true` on the primary key (created by using `AWS::KMS::Key` ). AWS KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *AWS Key Management Service Developer Guide* .\n\nWhen you enable automatic rotation, AWS KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. AWS KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *AWS Key Management Service Developer Guide* .",
1527 "stability": "external",
1528 "summary": "Enables automatic rotation of the key material for the specified KMS key."
1529 },
1530 "immutable": true,
1531 "locationInModule": {
1532 "filename": "lib/kms.generated.ts",
1533 "line": 298
1534 },
1535 "name": "enableKeyRotation",
1536 "optional": true,
1537 "type": {
1538 "union": {
1539 "types": [
1540 {
1541 "primitive": "boolean"
1542 },
1543 {
1544 "fqn": "@aws-cdk/core.IResolvable"
1545 }
1546 ]
1547 }
1548 }
1549 },
1550 {
1551 "abstract": true,
1552 "docs": {
1553 "custom": {
1554 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyspec"
1555 },
1556 "remarks": "The default value, `SYMMETRIC_DEFAULT` , creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, `SYMMETRIC_DEFAULT` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the `KeySpec` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *AWS Key Management Service Developer Guide* .\n\nThe `KeySpec` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [AWS KMS condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *AWS Key Management Service Developer Guide* .\n\n> If you change the value of the `KeySpec` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) . This prevents you from accidentally deleting a KMS key by changing an immutable property value. > [AWS services that are integrated with AWS KMS](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *AWS Key Management Service Developer Guide* .\n\nAWS KMS supports the following key specs for KMS keys:\n\n- Symmetric encryption key (default)\n\n- `SYMMETRIC_DEFAULT` (AES-256-GCM)\n- HMAC keys (symmetric)\n\n- `HMAC_224`\n- `HMAC_256`\n- `HMAC_384`\n- `HMAC_512`\n- Asymmetric RSA key pairs\n\n- `RSA_2048`\n- `RSA_3072`\n- `RSA_4096`\n- Asymmetric NIST-recommended elliptic curve key pairs\n\n- `ECC_NIST_P256` (secp256r1)\n- `ECC_NIST_P384` (secp384r1)\n- `ECC_NIST_P521` (secp521r1)\n- Other asymmetric elliptic curve key pairs\n\n- `ECC_SECG_P256K1` (secp256k1), commonly used for cryptocurrencies.\n- SM2 key pairs (China Regions only)\n\n- `SM2`",
1557 "stability": "external",
1558 "summary": "Specifies the type of KMS key to create."
1559 },
1560 "immutable": true,
1561 "locationInModule": {
1562 "filename": "lib/kms.generated.ts",
1563 "line": 337
1564 },
1565 "name": "keySpec",
1566 "optional": true,
1567 "type": {
1568 "primitive": "string"
1569 }
1570 },
1571 {
1572 "abstract": true,
1573 "docs": {
1574 "custom": {
1575 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyusage"
1576 },
1577 "remarks": "> If you change the value of the `KeyUsage` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) . This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n\nSelect only one valid value.\n\n- For symmetric encryption KMS keys, omit the property or specify `ENCRYPT_DECRYPT` .\n- For asymmetric KMS keys with RSA key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY` .\n- For asymmetric KMS keys with ECC key material, specify `SIGN_VERIFY` .\n- For asymmetric KMS keys with SM2 (China Regions only) key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY` .\n- For HMAC KMS keys, specify `GENERATE_VERIFY_MAC` .",
1578 "stability": "external",
1579 "summary": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is `ENCRYPT_DECRYPT` . This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the `KeyUsage` value after the KMS key is created."
1580 },
1581 "immutable": true,
1582 "locationInModule": {
1583 "filename": "lib/kms.generated.ts",
1584 "line": 354
1585 },
1586 "name": "keyUsage",
1587 "optional": true,
1588 "type": {
1589 "primitive": "string"
1590 }
1591 },
1592 {
1593 "abstract": true,
1594 "docs": {
1595 "custom": {
1596 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-multiregion"
1597 },
1598 "remarks": "You can't change the `MultiRegion` value after the KMS key is created.\n\nFor a list of AWS Regions in which multi-Region keys are supported, see [Multi-Region keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the ** .\n\n> If you change the value of the `MultiRegion` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) . This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n\nFor a multi-Region key, set to this property to `true` . For a single-Region key, omit this property or set it to `false` . The default value is `false` .\n\n*Multi-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions . Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide* .\n\nYou can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.\n\nTo create a replica of this primary key in a different AWS Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.",
1599 "stability": "external",
1600 "summary": "Creates a multi-Region primary key that you can replicate in other AWS Regions ."
1601 },
1602 "immutable": true,
1603 "locationInModule": {
1604 "filename": "lib/kms.generated.ts",
1605 "line": 373
1606 },
1607 "name": "multiRegion",
1608 "optional": true,
1609 "type": {
1610 "union": {
1611 "types": [
1612 {
1613 "primitive": "boolean"
1614 },
1615 {
1616 "fqn": "@aws-cdk/core.IResolvable"
1617 }
1618 ]
1619 }
1620 }
1621 },
1622 {
1623 "abstract": true,
1624 "docs": {
1625 "custom": {
1626 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-pendingwindowindays"
1627 },
1628 "remarks": "Enter a value between 7 and 30 days. The default value is 30 days.\n\nWhen you remove a KMS key from a CloudFormation stack, AWS KMS schedules the KMS key for deletion and starts the mandatory waiting period. The `PendingWindowInDays` property determines the length of waiting period. During the waiting period, the key state of KMS key is `Pending Deletion` or `Pending Replica Deletion` , which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the KMS key.\n\nAWS KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to `PendingReplicaDeletion` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to `PendingDeletion` and the waiting period specified by `PendingWindowInDays` begins. When this waiting period expires, AWS KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide* .\n\nYou cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the AWS KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.\n\nFor information about the `Pending Deletion` and `Pending Replica Deletion` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* . For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide* .\n\n*Minimum* : 7\n\n*Maximum* : 30",
1629 "stability": "external",
1630 "summary": "Specifies the number of days in the waiting period before AWS KMS deletes a KMS key that has been removed from a CloudFormation stack."
1631 },
1632 "immutable": true,
1633 "locationInModule": {
1634 "filename": "lib/kms.generated.ts",
1635 "line": 392
1636 },
1637 "name": "pendingWindowInDays",
1638 "optional": true,
1639 "type": {
1640 "primitive": "number"
1641 }
1642 },
1643 {
1644 "abstract": true,
1645 "docs": {
1646 "custom": {
1647 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-tags"
1648 },
1649 "remarks": "> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* .\n\nFor information about tags in AWS KMS , see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *AWS Key Management Service Developer Guide* . For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .",
1650 "stability": "external",
1651 "summary": "Assigns one or more tags to the replica key."
1652 },
1653 "immutable": true,
1654 "locationInModule": {
1655 "filename": "lib/kms.generated.ts",
1656 "line": 403
1657 },
1658 "name": "tags",
1659 "optional": true,
1660 "type": {
1661 "collection": {
1662 "elementtype": {
1663 "fqn": "@aws-cdk/core.CfnTag"
1664 },
1665 "kind": "array"
1666 }
1667 }
1668 }
1669 ],
1670 "symbolId": "lib/kms.generated:CfnKeyProps"
1671 },
1672 "@aws-cdk/aws-kms.CfnReplicaKey": {
1673 "assembly": "@aws-cdk/aws-kms",
1674 "base": "@aws-cdk/core.CfnResource",
1675 "docs": {
1676 "custom": {
1677 "cloudformationResource": "AWS::KMS::ReplicaKey",
1678 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html",
1679 "exampleMetadata": "fixture=_generated"
1680 },
1681 "remarks": "The `AWS::KMS::ReplicaKey` resource specifies a multi-Region replica key that is based on a multi-Region primary key.\n\n*Multi-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions . Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide* .\n\nA multi-Region *primary key* is a fully functional symmetric encryption KMS key, HMAC KMS key, or asymmetric KMS key that is also the model for replica keys in other AWS Regions . To create a multi-Region primary key, add an [AWS::KMS::Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html) resource to your CloudFormation stack. Set its `MultiRegion` property to true.\n\nA multi-Region *replica key* is a fully functional KMS key that has the same key ID and key material as a multi-Region primary key, but is located in a different AWS Region of the same AWS partition. There can be multiple replicas of a primary key, but each must be in a different AWS Region .\n\nWhen you create a replica key in AWS CloudFormation , the replica key is created in the AWS Region represented by the endpoint you use for the request. If you try to replicate a multi-Region key into a Region in which the key type is not supported, the request will fail.\n\nA primary key and its replicas have the same key ID and key material. They also have the same key spec, key usage, key material origin, and automatic key rotation status. These properties are known as *shared properties* . If they change, AWS KMS synchronizes the change to all related multi-Region keys. All other properties of a replica key can differ, including its key policy, tags, aliases, and key state. AWS KMS does not synchronize these properties.\n\n*Regions*\n\nAWS KMS CloudFormation resources are available in all AWS Regions in which AWS KMS and AWS CloudFormation are supported. You can use the `AWS::KMS::ReplicaKey` resource to create replica keys in all Regions that support multi-Region KMS keys. For details, see [Multi-Region keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the ** .",
1682 "stability": "external",
1683 "summary": "A CloudFormation `AWS::KMS::ReplicaKey`.",
1684 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as kms from '@aws-cdk/aws-kms';\n\ndeclare const keyPolicy: any;\nconst cfnReplicaKey = new kms.CfnReplicaKey(this, 'MyCfnReplicaKey', {\n keyPolicy: keyPolicy,\n primaryKeyArn: 'primaryKeyArn',\n\n // the properties below are optional\n description: 'description',\n enabled: false,\n pendingWindowInDays: 123,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});"
1685 },
1686 "fqn": "@aws-cdk/aws-kms.CfnReplicaKey",
1687 "initializer": {
1688 "docs": {
1689 "stability": "external",
1690 "summary": "Create a new `AWS::KMS::ReplicaKey`."
1691 },
1692 "locationInModule": {
1693 "filename": "lib/kms.generated.ts",
1694 "line": 1096
1695 },
1696 "parameters": [
1697 {
1698 "docs": {
1699 "summary": "- scope in which this resource is defined."
1700 },
1701 "name": "scope",
1702 "type": {
1703 "fqn": "@aws-cdk/core.Construct"
1704 }
1705 },
1706 {
1707 "docs": {
1708 "summary": "- scoped id of the resource."
1709 },
1710 "name": "id",
1711 "type": {
1712 "primitive": "string"
1713 }
1714 },
1715 {
1716 "docs": {
1717 "summary": "- resource properties."
1718 },
1719 "name": "props",
1720 "type": {
1721 "fqn": "@aws-cdk/aws-kms.CfnReplicaKeyProps"
1722 }
1723 }
1724 ]
1725 },
1726 "interfaces": [
1727 "@aws-cdk/core.IInspectable"
1728 ],
1729 "kind": "class",
1730 "locationInModule": {
1731 "filename": "lib/kms.generated.ts",
1732 "line": 951
1733 },
1734 "methods": [
1735 {
1736 "docs": {
1737 "stability": "external",
1738 "summary": "Examines the CloudFormation resource and discloses attributes."
1739 },
1740 "locationInModule": {
1741 "filename": "lib/kms.generated.ts",
1742 "line": 1117
1743 },
1744 "name": "inspect",
1745 "overrides": "@aws-cdk/core.IInspectable",
1746 "parameters": [
1747 {
1748 "docs": {
1749 "summary": "- tree inspector to collect and process attributes."
1750 },
1751 "name": "inspector",
1752 "type": {
1753 "fqn": "@aws-cdk/core.TreeInspector"
1754 }
1755 }
1756 ]
1757 },
1758 {
1759 "docs": {
1760 "stability": "external"
1761 },
1762 "locationInModule": {
1763 "filename": "lib/kms.generated.ts",
1764 "line": 1133
1765 },
1766 "name": "renderProperties",
1767 "overrides": "@aws-cdk/core.CfnResource",
1768 "parameters": [
1769 {
1770 "name": "props",
1771 "type": {
1772 "collection": {
1773 "elementtype": {
1774 "primitive": "any"
1775 },
1776 "kind": "map"
1777 }
1778 }
1779 }
1780 ],
1781 "protected": true,
1782 "returns": {
1783 "type": {
1784 "collection": {
1785 "elementtype": {
1786 "primitive": "any"
1787 },
1788 "kind": "map"
1789 }
1790 }
1791 }
1792 }
1793 ],
1794 "name": "CfnReplicaKey",
1795 "properties": [
1796 {
1797 "const": true,
1798 "docs": {
1799 "stability": "external",
1800 "summary": "The CloudFormation resource type name for this resource class."
1801 },
1802 "immutable": true,
1803 "locationInModule": {
1804 "filename": "lib/kms.generated.ts",
1805 "line": 955
1806 },
1807 "name": "CFN_RESOURCE_TYPE_NAME",
1808 "static": true,
1809 "type": {
1810 "primitive": "string"
1811 }
1812 },
1813 {
1814 "docs": {
1815 "custom": {
1816 "cloudformationAttribute": "Arn"
1817 },
1818 "remarks": "The key ARNs of related multi-Region keys differ only in the Region value. For information about the key ARNs of multi-Region keys, see [How multi-Region keys work](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-how-it-works) in the *AWS Key Management Service Developer Guide* .",
1819 "stability": "external",
1820 "summary": "The Amazon Resource Name (ARN) of the replica key, such as `arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab` ."
1821 },
1822 "immutable": true,
1823 "locationInModule": {
1824 "filename": "lib/kms.generated.ts",
1825 "line": 982
1826 },
1827 "name": "attrArn",
1828 "type": {
1829 "primitive": "string"
1830 }
1831 },
1832 {
1833 "docs": {
1834 "custom": {
1835 "cloudformationAttribute": "KeyId"
1836 },
1837 "remarks": "Related multi-Region keys have the same key ID. For information about the key IDs of multi-Region keys, see [How multi-Region keys work](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-how-it-works) in the *AWS Key Management Service Developer Guide* .",
1838 "stability": "external",
1839 "summary": "The key ID of the replica key, such as `mrk-1234abcd12ab34cd56ef1234567890ab` ."
1840 },
1841 "immutable": true,
1842 "locationInModule": {
1843 "filename": "lib/kms.generated.ts",
1844 "line": 990
1845 },
1846 "name": "attrKeyId",
1847 "type": {
1848 "primitive": "string"
1849 }
1850 },
1851 {
1852 "docs": {
1853 "stability": "external"
1854 },
1855 "immutable": true,
1856 "locationInModule": {
1857 "filename": "lib/kms.generated.ts",
1858 "line": 1122
1859 },
1860 "name": "cfnProperties",
1861 "overrides": "@aws-cdk/core.CfnResource",
1862 "protected": true,
1863 "type": {
1864 "collection": {
1865 "elementtype": {
1866 "primitive": "any"
1867 },
1868 "kind": "map"
1869 }
1870 }
1871 },
1872 {
1873 "docs": {
1874 "custom": {
1875 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-tags"
1876 },
1877 "remarks": "> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* .\n\nTags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. AWS KMS does not synchronize this property.\n\nEach tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.\n\nWhen you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) .",
1878 "stability": "external",
1879 "summary": "Assigns one or more tags to the replica key."
1880 },
1881 "immutable": true,
1882 "locationInModule": {
1883 "filename": "lib/kms.generated.ts",
1884 "line": 1087
1885 },
1886 "name": "tags",
1887 "type": {
1888 "fqn": "@aws-cdk/core.TagManager"
1889 }
1890 },
1891 {
1892 "docs": {
1893 "custom": {
1894 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-keypolicy"
1895 },
1896 "remarks": "The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. AWS KMS does not synchronize this property.\n\nThe key policy must conform to the following rules.\n\n- The key policy must give the caller [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) permission on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the **AWS Key Management Service Developer Guide** .\n- Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS . When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS . For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide* .\n\nA key policy document can include only the following characters:\n\n- Printable ASCII characters from the space character ( `\\ u0020` ) through the end of the ASCII character range.\n- Printable characters in the Basic Latin and Latin-1 Supplement character set (through `\\ u00FF` ).\n- The tab ( `\\ u0009` ), line feed ( `\\ u000A` ), and carriage return ( `\\ u000D` ) special characters\n\n*Minimum* : `1`\n\n*Maximum* : `32768`",
1897 "stability": "external",
1898 "summary": "The key policy that authorizes use of the replica key."
1899 },
1900 "locationInModule": {
1901 "filename": "lib/kms.generated.ts",
1902 "line": 1014
1903 },
1904 "name": "keyPolicy",
1905 "type": {
1906 "primitive": "any"
1907 }
1908 },
1909 {
1910 "docs": {
1911 "custom": {
1912 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-primarykeyarn"
1913 },
1914 "remarks": "The primary key must be in a different AWS Region of the same AWS partition. You can create only one replica of a given primary key in each AWS Region .\n\n> If you change the `PrimaryKeyArn` value of a replica key, the existing replica key is scheduled for deletion and a new replica key is created based on the specified primary key. While it is scheduled for deletion, the existing replica key becomes unusable. You can cancel the scheduled deletion of the key outside of CloudFormation.\n>\n> However, if you inadvertently delete a replica key, you can decrypt ciphertext encrypted by that replica key by using any related multi-Region key. If necessary, you can recreate the replica in the same Region after the previous one is completely deleted. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide*\n\nSpecify the key ARN of an existing multi-Region primary key. For example, `arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab` .",
1915 "stability": "external",
1916 "summary": "Specifies the multi-Region primary key to replicate."
1917 },
1918 "locationInModule": {
1919 "filename": "lib/kms.generated.ts",
1920 "line": 1027
1921 },
1922 "name": "primaryKeyArn",
1923 "type": {
1924 "primitive": "string"
1925 }
1926 },
1927 {
1928 "docs": {
1929 "custom": {
1930 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-description"
1931 },
1932 "remarks": "The default value is an empty string (no description).\n\nThe description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. AWS Key Management Service does not synchronize this property.",
1933 "stability": "external",
1934 "summary": "A description of the KMS key."
1935 },
1936 "locationInModule": {
1937 "filename": "lib/kms.generated.ts",
1938 "line": 1038
1939 },
1940 "name": "description",
1941 "optional": true,
1942 "type": {
1943 "primitive": "string"
1944 }
1945 },
1946 {
1947 "docs": {
1948 "custom": {
1949 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-enabled"
1950 },
1951 "remarks": "When `Enabled` is `true` , the *key state* of the KMS key is `Enabled` . When `Enabled` is `false` , the key state of the KMS key is `Disabled` . The default value is `true` .\n\nThe actual key state of the replica might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html) , [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html) , or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. Also, while the replica key is being created, its key state is `Creating` . When the process is complete, the key state of the replica key changes to `Enabled` .\n\nFor information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* .",
1952 "stability": "external",
1953 "summary": "Specifies whether the replica key is enabled. Disabled KMS keys cannot be used in cryptographic operations."
1954 },
1955 "locationInModule": {
1956 "filename": "lib/kms.generated.ts",
1957 "line": 1051
1958 },
1959 "name": "enabled",
1960 "optional": true,
1961 "type": {
1962 "union": {
1963 "types": [
1964 {
1965 "primitive": "boolean"
1966 },
1967 {
1968 "fqn": "@aws-cdk/core.IResolvable"
1969 }
1970 ]
1971 }
1972 }
1973 },
1974 {
1975 "docs": {
1976 "custom": {
1977 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-pendingwindowindays"
1978 },
1979 "remarks": "Enter a value between 7 and 30 days. The default value is 30 days.\n\nWhen you remove a replica key from a CloudFormation stack, AWS KMS schedules the replica key for deletion and starts the mandatory waiting period. The `PendingWindowInDays` property determines the length of waiting period. During the waiting period, the key state of replica key is `Pending Deletion` , which prevents it from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the replica key.\n\nIf the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.\n\nYou cannot use a CloudFormation template to cancel deletion of the replica after you remove it from the stack, regardless of the waiting period. However, if you specify a replica key in your template that is based on the same primary key as the original replica key, CloudFormation creates a new replica key with the same key ID, key material, and other shared properties of the original replica key. This new replica key can decrypt ciphertext that was encrypted under the original replica key, or any related multi-Region key.\n\nFor detailed information about deleting multi-Region keys, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide* .\n\nFor information about the `PendingDeletion` key state, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* . For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide* .\n\n*Minimum* : 7\n\n*Maximum* : 30",
1980 "stability": "external",
1981 "summary": "Specifies the number of days in the waiting period before AWS KMS deletes a replica key that has been removed from a CloudFormation stack."
1982 },
1983 "locationInModule": {
1984 "filename": "lib/kms.generated.ts",
1985 "line": 1072
1986 },
1987 "name": "pendingWindowInDays",
1988 "optional": true,
1989 "type": {
1990 "primitive": "number"
1991 }
1992 }
1993 ],
1994 "symbolId": "lib/kms.generated:CfnReplicaKey"
1995 },
1996 "@aws-cdk/aws-kms.CfnReplicaKeyProps": {
1997 "assembly": "@aws-cdk/aws-kms",
1998 "datatype": true,
1999 "docs": {
2000 "custom": {
2001 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html",
2002 "exampleMetadata": "fixture=_generated"
2003 },
2004 "stability": "external",
2005 "summary": "Properties for defining a `CfnReplicaKey`.",
2006 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as kms from '@aws-cdk/aws-kms';\n\ndeclare const keyPolicy: any;\nconst cfnReplicaKeyProps: kms.CfnReplicaKeyProps = {\n keyPolicy: keyPolicy,\n primaryKeyArn: 'primaryKeyArn',\n\n // the properties below are optional\n description: 'description',\n enabled: false,\n pendingWindowInDays: 123,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};"
2007 },
2008 "fqn": "@aws-cdk/aws-kms.CfnReplicaKeyProps",
2009 "kind": "interface",
2010 "locationInModule": {
2011 "filename": "lib/kms.generated.ts",
2012 "line": 765
2013 },
2014 "name": "CfnReplicaKeyProps",
2015 "properties": [
2016 {
2017 "abstract": true,
2018 "docs": {
2019 "custom": {
2020 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-keypolicy"
2021 },
2022 "remarks": "The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. AWS KMS does not synchronize this property.\n\nThe key policy must conform to the following rules.\n\n- The key policy must give the caller [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) permission on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the **AWS Key Management Service Developer Guide** .\n- Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS . When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS . For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide* .\n\nA key policy document can include only the following characters:\n\n- Printable ASCII characters from the space character ( `\\ u0020` ) through the end of the ASCII character range.\n- Printable characters in the Basic Latin and Latin-1 Supplement character set (through `\\ u00FF` ).\n- The tab ( `\\ u0009` ), line feed ( `\\ u000A` ), and carriage return ( `\\ u000D` ) special characters\n\n*Minimum* : `1`\n\n*Maximum* : `32768`",
2023 "stability": "external",
2024 "summary": "The key policy that authorizes use of the replica key."
2025 },
2026 "immutable": true,
2027 "locationInModule": {
2028 "filename": "lib/kms.generated.ts",
2029 "line": 789
2030 },
2031 "name": "keyPolicy",
2032 "type": {
2033 "primitive": "any"
2034 }
2035 },
2036 {
2037 "abstract": true,
2038 "docs": {
2039 "custom": {
2040 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-primarykeyarn"
2041 },
2042 "remarks": "The primary key must be in a different AWS Region of the same AWS partition. You can create only one replica of a given primary key in each AWS Region .\n\n> If you change the `PrimaryKeyArn` value of a replica key, the existing replica key is scheduled for deletion and a new replica key is created based on the specified primary key. While it is scheduled for deletion, the existing replica key becomes unusable. You can cancel the scheduled deletion of the key outside of CloudFormation.\n>\n> However, if you inadvertently delete a replica key, you can decrypt ciphertext encrypted by that replica key by using any related multi-Region key. If necessary, you can recreate the replica in the same Region after the previous one is completely deleted. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide*\n\nSpecify the key ARN of an existing multi-Region primary key. For example, `arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab` .",
2043 "stability": "external",
2044 "summary": "Specifies the multi-Region primary key to replicate."
2045 },
2046 "immutable": true,
2047 "locationInModule": {
2048 "filename": "lib/kms.generated.ts",
2049 "line": 802
2050 },
2051 "name": "primaryKeyArn",
2052 "type": {
2053 "primitive": "string"
2054 }
2055 },
2056 {
2057 "abstract": true,
2058 "docs": {
2059 "custom": {
2060 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-description"
2061 },
2062 "remarks": "The default value is an empty string (no description).\n\nThe description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. AWS Key Management Service does not synchronize this property.",
2063 "stability": "external",
2064 "summary": "A description of the KMS key."
2065 },
2066 "immutable": true,
2067 "locationInModule": {
2068 "filename": "lib/kms.generated.ts",
2069 "line": 813
2070 },
2071 "name": "description",
2072 "optional": true,
2073 "type": {
2074 "primitive": "string"
2075 }
2076 },
2077 {
2078 "abstract": true,
2079 "docs": {
2080 "custom": {
2081 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-enabled"
2082 },
2083 "remarks": "When `Enabled` is `true` , the *key state* of the KMS key is `Enabled` . When `Enabled` is `false` , the key state of the KMS key is `Disabled` . The default value is `true` .\n\nThe actual key state of the replica might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html) , [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html) , or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. Also, while the replica key is being created, its key state is `Creating` . When the process is complete, the key state of the replica key changes to `Enabled` .\n\nFor information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* .",
2084 "stability": "external",
2085 "summary": "Specifies whether the replica key is enabled. Disabled KMS keys cannot be used in cryptographic operations."
2086 },
2087 "immutable": true,
2088 "locationInModule": {
2089 "filename": "lib/kms.generated.ts",
2090 "line": 826
2091 },
2092 "name": "enabled",
2093 "optional": true,
2094 "type": {
2095 "union": {
2096 "types": [
2097 {
2098 "primitive": "boolean"
2099 },
2100 {
2101 "fqn": "@aws-cdk/core.IResolvable"
2102 }
2103 ]
2104 }
2105 }
2106 },
2107 {
2108 "abstract": true,
2109 "docs": {
2110 "custom": {
2111 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-pendingwindowindays"
2112 },
2113 "remarks": "Enter a value between 7 and 30 days. The default value is 30 days.\n\nWhen you remove a replica key from a CloudFormation stack, AWS KMS schedules the replica key for deletion and starts the mandatory waiting period. The `PendingWindowInDays` property determines the length of waiting period. During the waiting period, the key state of replica key is `Pending Deletion` , which prevents it from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the replica key.\n\nIf the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.\n\nYou cannot use a CloudFormation template to cancel deletion of the replica after you remove it from the stack, regardless of the waiting period. However, if you specify a replica key in your template that is based on the same primary key as the original replica key, CloudFormation creates a new replica key with the same key ID, key material, and other shared properties of the original replica key. This new replica key can decrypt ciphertext that was encrypted under the original replica key, or any related multi-Region key.\n\nFor detailed information about deleting multi-Region keys, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide* .\n\nFor information about the `PendingDeletion` key state, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* . For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide* .\n\n*Minimum* : 7\n\n*Maximum* : 30",
2114 "stability": "external",
2115 "summary": "Specifies the number of days in the waiting period before AWS KMS deletes a replica key that has been removed from a CloudFormation stack."
2116 },
2117 "immutable": true,
2118 "locationInModule": {
2119 "filename": "lib/kms.generated.ts",
2120 "line": 847
2121 },
2122 "name": "pendingWindowInDays",
2123 "optional": true,
2124 "type": {
2125 "primitive": "number"
2126 }
2127 },
2128 {
2129 "abstract": true,
2130 "docs": {
2131 "custom": {
2132 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-tags"
2133 },
2134 "remarks": "> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* .\n\nTags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. AWS KMS does not synchronize this property.\n\nEach tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.\n\nWhen you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) .",
2135 "stability": "external",
2136 "summary": "Assigns one or more tags to the replica key."
2137 },
2138 "immutable": true,
2139 "locationInModule": {
2140 "filename": "lib/kms.generated.ts",
2141 "line": 862
2142 },
2143 "name": "tags",
2144 "optional": true,
2145 "type": {
2146 "collection": {
2147 "elementtype": {
2148 "fqn": "@aws-cdk/core.CfnTag"
2149 },
2150 "kind": "array"
2151 }
2152 }
2153 }
2154 ],
2155 "symbolId": "lib/kms.generated:CfnReplicaKeyProps"
2156 },
2157 "@aws-cdk/aws-kms.IAlias": {
2158 "assembly": "@aws-cdk/aws-kms",
2159 "docs": {
2160 "remarks": "An alias can be used in all places that expect a key.",
2161 "stability": "stable",
2162 "summary": "A KMS Key alias."
2163 },
2164 "fqn": "@aws-cdk/aws-kms.IAlias",
2165 "interfaces": [
2166 "@aws-cdk/aws-kms.IKey"
2167 ],
2168 "kind": "interface",
2169 "locationInModule": {
2170 "filename": "lib/alias.ts",
2171 "line": 14
2172 },
2173 "name": "IAlias",
2174 "properties": [
2175 {
2176 "abstract": true,
2177 "docs": {
2178 "custom": {
2179 "attribute": "true"
2180 },
2181 "stability": "stable",
2182 "summary": "The name of the alias."
2183 },
2184 "immutable": true,
2185 "locationInModule": {
2186 "filename": "lib/alias.ts",
2187 "line": 20
2188 },
2189 "name": "aliasName",
2190 "type": {
2191 "primitive": "string"
2192 }
2193 },
2194 {
2195 "abstract": true,
2196 "docs": {
2197 "custom": {
2198 "attribute": "true"
2199 },
2200 "stability": "stable",
2201 "summary": "The Key to which the Alias refers."
2202 },
2203 "immutable": true,
2204 "locationInModule": {
2205 "filename": "lib/alias.ts",
2206 "line": 27
2207 },
2208 "name": "aliasTargetKey",
2209 "type": {
2210 "fqn": "@aws-cdk/aws-kms.IKey"
2211 }
2212 }
2213 ],
2214 "symbolId": "lib/alias:IAlias"
2215 },
2216 "@aws-cdk/aws-kms.IKey": {
2217 "assembly": "@aws-cdk/aws-kms",
2218 "docs": {
2219 "stability": "stable",
2220 "summary": "A KMS Key, either managed by this CDK app, or imported."
2221 },
2222 "fqn": "@aws-cdk/aws-kms.IKey",
2223 "interfaces": [
2224 "@aws-cdk/core.IResource"
2225 ],
2226 "kind": "interface",
2227 "locationInModule": {
2228 "filename": "lib/key.ts",
2229 "line": 14
2230 },
2231 "methods": [
2232 {
2233 "abstract": true,
2234 "docs": {
2235 "stability": "stable",
2236 "summary": "Defines a new alias for the key."
2237 },
2238 "locationInModule": {
2239 "filename": "lib/key.ts",
2240 "line": 33
2241 },
2242 "name": "addAlias",
2243 "parameters": [
2244 {
2245 "name": "alias",
2246 "type": {
2247 "primitive": "string"
2248 }
2249 }
2250 ],
2251 "returns": {
2252 "type": {
2253 "fqn": "@aws-cdk/aws-kms.Alias"
2254 }
2255 }
2256 },
2257 {
2258 "abstract": true,
2259 "docs": {
2260 "stability": "stable",
2261 "summary": "Adds a statement to the KMS key resource policy."
2262 },
2263 "locationInModule": {
2264 "filename": "lib/key.ts",
2265 "line": 42
2266 },
2267 "name": "addToResourcePolicy",
2268 "parameters": [
2269 {
2270 "docs": {
2271 "summary": "The policy statement to add."
2272 },
2273 "name": "statement",
2274 "type": {
2275 "fqn": "@aws-cdk/aws-iam.PolicyStatement"
2276 }
2277 },
2278 {
2279 "docs": {
2280 "summary": "If this is set to `false` and there is no policy defined (i.e. external key), the operation will fail. Otherwise, it will no-op."
2281 },
2282 "name": "allowNoOp",
2283 "optional": true,
2284 "type": {
2285 "primitive": "boolean"
2286 }
2287 }
2288 ],
2289 "returns": {
2290 "type": {
2291 "fqn": "@aws-cdk/aws-iam.AddToResourcePolicyResult"
2292 }
2293 }
2294 },
2295 {
2296 "abstract": true,
2297 "docs": {
2298 "stability": "stable",
2299 "summary": "Grant the indicated permissions on this key to the given principal."
2300 },
2301 "locationInModule": {
2302 "filename": "lib/key.ts",
2303 "line": 47
2304 },
2305 "name": "grant",
2306 "parameters": [
2307 {
2308 "name": "grantee",
2309 "type": {
2310 "fqn": "@aws-cdk/aws-iam.IGrantable"
2311 }
2312 },
2313 {
2314 "name": "actions",
2315 "type": {
2316 "primitive": "string"
2317 },
2318 "variadic": true
2319 }
2320 ],
2321 "returns": {
2322 "type": {
2323 "fqn": "@aws-cdk/aws-iam.Grant"
2324 }
2325 },
2326 "variadic": true
2327 },
2328 {
2329 "abstract": true,
2330 "docs": {
2331 "stability": "stable",
2332 "summary": "Grant decryption permissions using this key to the given principal."
2333 },
2334 "locationInModule": {
2335 "filename": "lib/key.ts",
2336 "line": 52
2337 },
2338 "name": "grantDecrypt",
2339 "parameters": [
2340 {
2341 "name": "grantee",
2342 "type": {
2343 "fqn": "@aws-cdk/aws-iam.IGrantable"
2344 }
2345 }
2346 ],
2347 "returns": {
2348 "type": {
2349 "fqn": "@aws-cdk/aws-iam.Grant"
2350 }
2351 }
2352 },
2353 {
2354 "abstract": true,
2355 "docs": {
2356 "stability": "stable",
2357 "summary": "Grant encryption permissions using this key to the given principal."
2358 },
2359 "locationInModule": {
2360 "filename": "lib/key.ts",
2361 "line": 57
2362 },
2363 "name": "grantEncrypt",
2364 "parameters": [
2365 {
2366 "name": "grantee",
2367 "type": {
2368 "fqn": "@aws-cdk/aws-iam.IGrantable"
2369 }
2370 }
2371 ],
2372 "returns": {
2373 "type": {
2374 "fqn": "@aws-cdk/aws-iam.Grant"
2375 }
2376 }
2377 },
2378 {
2379 "abstract": true,
2380 "docs": {
2381 "stability": "stable",
2382 "summary": "Grant encryption and decryption permissions using this key to the given principal."
2383 },
2384 "locationInModule": {
2385 "filename": "lib/key.ts",
2386 "line": 62
2387 },
2388 "name": "grantEncryptDecrypt",
2389 "parameters": [
2390 {
2391 "name": "grantee",
2392 "type": {
2393 "fqn": "@aws-cdk/aws-iam.IGrantable"
2394 }
2395 }
2396 ],
2397 "returns": {
2398 "type": {
2399 "fqn": "@aws-cdk/aws-iam.Grant"
2400 }
2401 }
2402 }
2403 ],
2404 "name": "IKey",
2405 "properties": [
2406 {
2407 "abstract": true,
2408 "docs": {
2409 "custom": {
2410 "attribute": "true"
2411 },
2412 "stability": "stable",
2413 "summary": "The ARN of the key."
2414 },
2415 "immutable": true,
2416 "locationInModule": {
2417 "filename": "lib/key.ts",
2418 "line": 20
2419 },
2420 "name": "keyArn",
2421 "type": {
2422 "primitive": "string"
2423 }
2424 },
2425 {
2426 "abstract": true,
2427 "docs": {
2428 "custom": {
2429 "attribute": "true"
2430 },
2431 "stability": "stable",
2432 "summary": "The ID of the key (the part that looks something like: 1234abcd-12ab-34cd-56ef-1234567890ab)."
2433 },
2434 "immutable": true,
2435 "locationInModule": {
2436 "filename": "lib/key.ts",
2437 "line": 28
2438 },
2439 "name": "keyId",
2440 "type": {
2441 "primitive": "string"
2442 }
2443 }
2444 ],
2445 "symbolId": "lib/key:IKey"
2446 },
2447 "@aws-cdk/aws-kms.Key": {
2448 "assembly": "@aws-cdk/aws-kms",
2449 "base": "@aws-cdk/core.Resource",
2450 "docs": {
2451 "custom": {
2452 "resource": "AWS::KMS::Key",
2453 "exampleMetadata": "infused"
2454 },
2455 "stability": "stable",
2456 "summary": "Defines a KMS key.",
2457 "example": "import * as kms from '@aws-cdk/aws-kms';\n\nconst encryptionKey = new kms.Key(this, 'Key', {\n enableKeyRotation: true,\n});\nconst table = new dynamodb.Table(this, 'MyTable', {\n partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },\n encryption: dynamodb.TableEncryption.CUSTOMER_MANAGED,\n encryptionKey, // This will be exposed as table.encryptionKey\n});"
2458 },
2459 "fqn": "@aws-cdk/aws-kms.Key",
2460 "initializer": {
2461 "docs": {
2462 "stability": "stable"
2463 },
2464 "locationInModule": {
2465 "filename": "lib/key.ts",
2466 "line": 598
2467 },
2468 "parameters": [
2469 {
2470 "name": "scope",
2471 "type": {
2472 "fqn": "constructs.Construct"
2473 }
2474 },
2475 {
2476 "name": "id",
2477 "type": {
2478 "primitive": "string"
2479 }
2480 },
2481 {
2482 "name": "props",
2483 "optional": true,
2484 "type": {
2485 "fqn": "@aws-cdk/aws-kms.KeyProps"
2486 }
2487 }
2488 ]
2489 },
2490 "interfaces": [
2491 "@aws-cdk/aws-kms.IKey"
2492 ],
2493 "kind": "class",
2494 "locationInModule": {
2495 "filename": "lib/key.ts",
2496 "line": 457
2497 },
2498 "methods": [
2499 {
2500 "docs": {
2501 "remarks": "This is most useful when combined with the cloudformation-include module.\nThis method is different than {@link fromKeyArn()} because the {@link IKey}\nreturned from this method is mutable;\nmeaning, calling any mutating methods on it,\nlike {@link IKey.addToResourcePolicy()},\nwill actually be reflected in the resulting template,\nas opposed to the object returned from {@link fromKeyArn()},\non which calling those methods would have no effect.",
2502 "stability": "stable",
2503 "summary": "Create a mutable {@link IKey} based on a low-level {@link CfnKey}."
2504 },
2505 "locationInModule": {
2506 "filename": "lib/key.ts",
2507 "line": 501
2508 },
2509 "name": "fromCfnKey",
2510 "parameters": [
2511 {
2512 "name": "cfnKey",
2513 "type": {
2514 "fqn": "@aws-cdk/aws-kms.CfnKey"
2515 }
2516 }
2517 ],
2518 "returns": {
2519 "type": {
2520 "fqn": "@aws-cdk/aws-kms.IKey"
2521 }
2522 },
2523 "static": true
2524 },
2525 {
2526 "docs": {
2527 "stability": "stable",
2528 "summary": "Import an externally defined KMS Key using its ARN."
2529 },
2530 "locationInModule": {
2531 "filename": "lib/key.ts",
2532 "line": 465
2533 },
2534 "name": "fromKeyArn",
2535 "parameters": [
2536 {
2537 "docs": {
2538 "summary": "the construct that will \"own\" the imported key."
2539 },
2540 "name": "scope",
2541 "type": {
2542 "fqn": "constructs.Construct"
2543 }
2544 },
2545 {
2546 "docs": {
2547 "summary": "the id of the imported key in the construct tree."
2548 },
2549 "name": "id",
2550 "type": {
2551 "primitive": "string"
2552 }
2553 },
2554 {
2555 "docs": {
2556 "summary": "the ARN of an existing KMS key."
2557 },
2558 "name": "keyArn",
2559 "type": {
2560 "primitive": "string"
2561 }
2562 }
2563 ],
2564 "returns": {
2565 "type": {
2566 "fqn": "@aws-cdk/aws-kms.IKey"
2567 }
2568 },
2569 "static": true
2570 },
2571 {
2572 "docs": {
2573 "remarks": "This function only needs to be used to use Keys not defined in your CDK\napplication. If you are looking to share a Key between stacks, you can\npass the `Key` object between stacks and use it as normal. In addition,\nit's not necessary to use this method if an interface accepts an `IKey`.\nIn this case, `Alias.fromAliasName()` can be used which returns an alias\nthat extends `IKey`.\n\nCalling this method will lead to a lookup when the CDK CLI is executed.\nYou can therefore not use any values that will only be available at\nCloudFormation execution time (i.e., Tokens).\n\nThe Key information will be cached in `cdk.context.json` and the same Key\nwill be used on future runs. To refresh the lookup, you will have to\nevict the value from the cache using the `cdk context` command. See\nhttps://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.",
2574 "stability": "stable",
2575 "summary": "Import an existing Key by querying the AWS environment this stack is deployed to."
2576 },
2577 "locationInModule": {
2578 "filename": "lib/key.ts",
2579 "line": 558
2580 },
2581 "name": "fromLookup",
2582 "parameters": [
2583 {
2584 "name": "scope",
2585 "type": {
2586 "fqn": "constructs.Construct"
2587 }
2588 },
2589 {
2590 "name": "id",
2591 "type": {
2592 "primitive": "string"
2593 }
2594 },
2595 {
2596 "name": "options",
2597 "type": {
2598 "fqn": "@aws-cdk/aws-kms.KeyLookupOptions"
2599 }
2600 }
2601 ],
2602 "returns": {
2603 "type": {
2604 "fqn": "@aws-cdk/aws-kms.IKey"
2605 }
2606 },
2607 "static": true
2608 },
2609 {
2610 "docs": {
2611 "stability": "stable",
2612 "summary": "Defines a new alias for the key."
2613 },
2614 "locationInModule": {
2615 "filename": "lib/key.ts",
2616 "line": 100
2617 },
2618 "name": "addAlias",
2619 "overrides": "@aws-cdk/aws-kms.IKey",
2620 "parameters": [
2621 {
2622 "name": "aliasName",
2623 "type": {
2624 "primitive": "string"
2625 }
2626 }
2627 ],
2628 "returns": {
2629 "type": {
2630 "fqn": "@aws-cdk/aws-kms.Alias"
2631 }
2632 }
2633 },
2634 {
2635 "docs": {
2636 "stability": "stable",
2637 "summary": "Adds a statement to the KMS key resource policy."
2638 },
2639 "locationInModule": {
2640 "filename": "lib/key.ts",
2641 "line": 116
2642 },
2643 "name": "addToResourcePolicy",
2644 "overrides": "@aws-cdk/aws-kms.IKey",
2645 "parameters": [
2646 {
2647 "docs": {
2648 "summary": "The policy statement to add."
2649 },
2650 "name": "statement",
2651 "type": {
2652 "fqn": "@aws-cdk/aws-iam.PolicyStatement"
2653 }
2654 },
2655 {
2656 "docs": {
2657 "summary": "If this is set to `false` and there is no policy defined (i.e. external key), the operation will fail. Otherwise, it will no-op."
2658 },
2659 "name": "allowNoOp",
2660 "optional": true,
2661 "type": {
2662 "primitive": "boolean"
2663 }
2664 }
2665 ],
2666 "returns": {
2667 "type": {
2668 "fqn": "@aws-cdk/aws-iam.AddToResourcePolicyResult"
2669 }
2670 }
2671 },
2672 {
2673 "docs": {
2674 "remarks": "This modifies both the principal's policy as well as the resource policy,\nsince the default CloudFormation setup for KMS keys is that the policy\nmust not be empty and so default grants won't work.",
2675 "stability": "stable",
2676 "summary": "Grant the indicated permissions on this key to the given principal."
2677 },
2678 "locationInModule": {
2679 "filename": "lib/key.ts",
2680 "line": 141
2681 },
2682 "name": "grant",
2683 "overrides": "@aws-cdk/aws-kms.IKey",
2684 "parameters": [
2685 {
2686 "name": "grantee",
2687 "type": {
2688 "fqn": "@aws-cdk/aws-iam.IGrantable"
2689 }
2690 },
2691 {
2692 "name": "actions",
2693 "type": {
2694 "primitive": "string"
2695 },
2696 "variadic": true
2697 }
2698 ],
2699 "returns": {
2700 "type": {
2701 "fqn": "@aws-cdk/aws-iam.Grant"
2702 }
2703 },
2704 "variadic": true
2705 },
2706 {
2707 "docs": {
2708 "remarks": "Key administrators have permissions to manage the key (e.g., change permissions, revoke), but do not have permissions\nto use the key in cryptographic operations (e.g., encrypt, decrypt).",
2709 "stability": "stable",
2710 "summary": "Grant admins permissions using this key to the given principal."
2711 },
2712 "locationInModule": {
2713 "filename": "lib/key.ts",
2714 "line": 679
2715 },
2716 "name": "grantAdmin",
2717 "parameters": [
2718 {
2719 "name": "grantee",
2720 "type": {
2721 "fqn": "@aws-cdk/aws-iam.IGrantable"
2722 }
2723 }
2724 ],
2725 "returns": {
2726 "type": {
2727 "fqn": "@aws-cdk/aws-iam.Grant"
2728 }
2729 }
2730 },
2731 {
2732 "docs": {
2733 "stability": "stable",
2734 "summary": "Grant decryption permissions using this key to the given principal."
2735 },
2736 "locationInModule": {
2737 "filename": "lib/key.ts",
2738 "line": 178
2739 },
2740 "name": "grantDecrypt",
2741 "overrides": "@aws-cdk/aws-kms.IKey",
2742 "parameters": [
2743 {
2744 "name": "grantee",
2745 "type": {
2746 "fqn": "@aws-cdk/aws-iam.IGrantable"
2747 }
2748 }
2749 ],
2750 "returns": {
2751 "type": {
2752 "fqn": "@aws-cdk/aws-iam.Grant"
2753 }
2754 }
2755 },
2756 {
2757 "docs": {
2758 "stability": "stable",
2759 "summary": "Grant encryption permissions using this key to the given principal."
2760 },
2761 "locationInModule": {
2762 "filename": "lib/key.ts",
2763 "line": 185
2764 },
2765 "name": "grantEncrypt",
2766 "overrides": "@aws-cdk/aws-kms.IKey",
2767 "parameters": [
2768 {
2769 "name": "grantee",
2770 "type": {
2771 "fqn": "@aws-cdk/aws-iam.IGrantable"
2772 }
2773 }
2774 ],
2775 "returns": {
2776 "type": {
2777 "fqn": "@aws-cdk/aws-iam.Grant"
2778 }
2779 }
2780 },
2781 {
2782 "docs": {
2783 "stability": "stable",
2784 "summary": "Grant encryption and decryption permissions using this key to the given principal."
2785 },
2786 "locationInModule": {
2787 "filename": "lib/key.ts",
2788 "line": 192
2789 },
2790 "name": "grantEncryptDecrypt",
2791 "overrides": "@aws-cdk/aws-kms.IKey",
2792 "parameters": [
2793 {
2794 "name": "grantee",
2795 "type": {
2796 "fqn": "@aws-cdk/aws-iam.IGrantable"
2797 }
2798 }
2799 ],
2800 "returns": {
2801 "type": {
2802 "fqn": "@aws-cdk/aws-iam.Grant"
2803 }
2804 }
2805 },
2806 {
2807 "docs": {
2808 "remarks": "This method can be implemented by derived constructs in order to perform\nvalidation logic. It is called on all constructs before synthesis.",
2809 "stability": "stable",
2810 "summary": "Validate the current construct."
2811 },
2812 "locationInModule": {
2813 "filename": "lib/key.ts",
2814 "line": 128
2815 },
2816 "name": "validate",
2817 "overrides": "@aws-cdk/core.Construct",
2818 "protected": true,
2819 "returns": {
2820 "type": {
2821 "collection": {
2822 "elementtype": {
2823 "primitive": "string"
2824 },
2825 "kind": "array"
2826 }
2827 }
2828 }
2829 }
2830 ],
2831 "name": "Key",
2832 "properties": [
2833 {
2834 "docs": {
2835 "stability": "stable",
2836 "summary": "The ARN of the key."
2837 },
2838 "immutable": true,
2839 "locationInModule": {
2840 "filename": "lib/key.ts",
2841 "line": 593
2842 },
2843 "name": "keyArn",
2844 "overrides": "@aws-cdk/aws-kms.IKey",
2845 "type": {
2846 "primitive": "string"
2847 }
2848 },
2849 {
2850 "docs": {
2851 "stability": "stable",
2852 "summary": "The ID of the key (the part that looks something like: 1234abcd-12ab-34cd-56ef-1234567890ab)."
2853 },
2854 "immutable": true,
2855 "locationInModule": {
2856 "filename": "lib/key.ts",
2857 "line": 594
2858 },
2859 "name": "keyId",
2860 "overrides": "@aws-cdk/aws-kms.IKey",
2861 "type": {
2862 "primitive": "string"
2863 }
2864 },
2865 {
2866 "docs": {
2867 "remarks": "If specified, grants will default identity policies instead of to both\nresource and identity policies. This matches the default behavior when creating\nKMS keys via the API or console.",
2868 "stability": "stable",
2869 "summary": "Optional property to control trusting account identities."
2870 },
2871 "immutable": true,
2872 "locationInModule": {
2873 "filename": "lib/key.ts",
2874 "line": 596
2875 },
2876 "name": "trustAccountIdentities",
2877 "protected": true,
2878 "type": {
2879 "primitive": "boolean"
2880 }
2881 },
2882 {
2883 "docs": {
2884 "remarks": "If specified, addToResourcePolicy can be used to edit this policy.\nOtherwise this method will no-op.",
2885 "stability": "stable",
2886 "summary": "Optional policy document that represents the resource policy of this key."
2887 },
2888 "immutable": true,
2889 "locationInModule": {
2890 "filename": "lib/key.ts",
2891 "line": 595
2892 },
2893 "name": "policy",
2894 "optional": true,
2895 "protected": true,
2896 "type": {
2897 "fqn": "@aws-cdk/aws-iam.PolicyDocument"
2898 }
2899 }
2900 ],
2901 "symbolId": "lib/key:Key"
2902 },
2903 "@aws-cdk/aws-kms.KeyLookupOptions": {
2904 "assembly": "@aws-cdk/aws-kms",
2905 "datatype": true,
2906 "docs": {
2907 "stability": "stable",
2908 "summary": "Properties for looking up an existing Key.",
2909 "example": "const myKeyLookup = kms.Key.fromLookup(this, 'MyKeyLookup', {\n aliasName: 'alias/KeyAlias',\n});\n\nconst role = new iam.Role(this, 'MyRole', {\n assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),\n});\nmyKeyLookup.grantEncryptDecrypt(role);",
2910 "custom": {
2911 "exampleMetadata": "infused"
2912 }
2913 },
2914 "fqn": "@aws-cdk/aws-kms.KeyLookupOptions",
2915 "kind": "interface",
2916 "locationInModule": {
2917 "filename": "lib/key-lookup.ts",
2918 "line": 4
2919 },
2920 "name": "KeyLookupOptions",
2921 "properties": [
2922 {
2923 "abstract": true,
2924 "docs": {
2925 "stability": "stable",
2926 "summary": "The alias name of the Key."
2927 },
2928 "immutable": true,
2929 "locationInModule": {
2930 "filename": "lib/key-lookup.ts",
2931 "line": 8
2932 },
2933 "name": "aliasName",
2934 "type": {
2935 "primitive": "string"
2936 }
2937 }
2938 ],
2939 "symbolId": "lib/key-lookup:KeyLookupOptions"
2940 },
2941 "@aws-cdk/aws-kms.KeyProps": {
2942 "assembly": "@aws-cdk/aws-kms",
2943 "datatype": true,
2944 "docs": {
2945 "stability": "stable",
2946 "summary": "Construction properties for a KMS Key object.",
2947 "example": "const myTrustedAdminRole = iam.Role.fromRoleArn(this, 'TrustedRole', 'arn:aws:iam:....');\n// Creates a limited admin policy and assigns to the account root.\nconst myCustomPolicy = new iam.PolicyDocument({\n statements: [new iam.PolicyStatement({\n actions: [\n 'kms:Create*',\n 'kms:Describe*',\n 'kms:Enable*',\n 'kms:List*',\n 'kms:Put*',\n ],\n principals: [new iam.AccountRootPrincipal()],\n resources: ['*'],\n })],\n});\nconst key = new kms.Key(this, 'MyKey', {\n policy: myCustomPolicy,\n});",
2948 "custom": {
2949 "exampleMetadata": "infused"
2950 }
2951 },
2952 "fqn": "@aws-cdk/aws-kms.KeyProps",
2953 "kind": "interface",
2954 "locationInModule": {
2955 "filename": "lib/key.ts",
2956 "line": 334
2957 },
2958 "name": "KeyProps",
2959 "properties": [
2960 {
2961 "abstract": true,
2962 "docs": {
2963 "default": "[]",
2964 "remarks": "Key administrators have permissions to manage the key (e.g., change permissions, revoke), but do not have permissions\nto use the key in cryptographic operations (e.g., encrypt, decrypt).\n\nThese principals will be added to the default key policy (if none specified), or to the specified policy (if provided).",
2965 "stability": "stable",
2966 "summary": "A list of principals to add as key administrators to the key policy."
2967 },
2968 "immutable": true,
2969 "locationInModule": {
2970 "filename": "lib/key.ts",
2971 "line": 408
2972 },
2973 "name": "admins",
2974 "optional": true,
2975 "type": {
2976 "collection": {
2977 "elementtype": {
2978 "fqn": "@aws-cdk/aws-iam.IPrincipal"
2979 },
2980 "kind": "array"
2981 }
2982 }
2983 },
2984 {
2985 "abstract": true,
2986 "docs": {
2987 "default": "- No alias is added for the key.",
2988 "remarks": "More aliases can be added later by calling `addAlias`.",
2989 "stability": "stable",
2990 "summary": "Initial alias to add to the key."
2991 },
2992 "immutable": true,
2993 "locationInModule": {
2994 "filename": "lib/key.ts",
2995 "line": 350
2996 },
2997 "name": "alias",
2998 "optional": true,
2999 "type": {
3000 "primitive": "string"
3001 }
3002 },
3003 {
3004 "abstract": true,
3005 "docs": {
3006 "default": "- No description.",
3007 "remarks": "Use a description that helps your users decide\nwhether the key is appropriate for a particular task.",
3008 "stability": "stable",
3009 "summary": "A description of the key."
3010 },
3011 "immutable": true,
3012 "locationInModule": {
3013 "filename": "lib/key.ts",
3014 "line": 341
3015 },
3016 "name": "description",
3017 "optional": true,
3018 "type": {
3019 "primitive": "string"
3020 }
3021 },
3022 {
3023 "abstract": true,
3024 "docs": {
3025 "default": "- Key is enabled.",
3026 "stability": "stable",
3027 "summary": "Indicates whether the key is available for use."
3028 },
3029 "immutable": true,
3030 "locationInModule": {
3031 "filename": "lib/key.ts",
3032 "line": 364
3033 },
3034 "name": "enabled",
3035 "optional": true,
3036 "type": {
3037 "primitive": "boolean"
3038 }
3039 },
3040 {
3041 "abstract": true,
3042 "docs": {
3043 "default": "false",
3044 "stability": "stable",
3045 "summary": "Indicates whether AWS KMS rotates the key."
3046 },
3047 "immutable": true,
3048 "locationInModule": {
3049 "filename": "lib/key.ts",
3050 "line": 357
3051 },
3052 "name": "enableKeyRotation",
3053 "optional": true,
3054 "type": {
3055 "primitive": "boolean"
3056 }
3057 },
3058 {
3059 "abstract": true,
3060 "docs": {
3061 "default": "KeySpec.SYMMETRIC_DEFAULT",
3062 "remarks": "IMPORTANT: If you change this property of an existing key, the existing key is scheduled for deletion\nand a new key is created with the specified value.",
3063 "stability": "stable",
3064 "summary": "The cryptographic configuration of the key. The valid value depends on usage of the key."
3065 },
3066 "immutable": true,
3067 "locationInModule": {
3068 "filename": "lib/key.ts",
3069 "line": 374
3070 },
3071 "name": "keySpec",
3072 "optional": true,
3073 "type": {
3074 "fqn": "@aws-cdk/aws-kms.KeySpec"
3075 }
3076 },
3077 {
3078 "abstract": true,
3079 "docs": {
3080 "default": "KeyUsage.ENCRYPT_DECRYPT",
3081 "remarks": "IMPORTANT: If you change this property of an existing key, the existing key is scheduled for deletion\nand a new key is created with the specified value.",
3082 "stability": "stable",
3083 "summary": "The cryptographic operations for which the key can be used."
3084 },
3085 "immutable": true,
3086 "locationInModule": {
3087 "filename": "lib/key.ts",
3088 "line": 384
3089 },
3090 "name": "keyUsage",
3091 "optional": true,
3092 "type": {
3093 "fqn": "@aws-cdk/aws-kms.KeyUsage"
3094 }
3095 },
3096 {
3097 "abstract": true,
3098 "docs": {
3099 "default": "- 30 days",
3100 "remarks": "When you remove a customer master key (CMK) from a CloudFormation stack, AWS KMS schedules the CMK for deletion\nand starts the mandatory waiting period. The PendingWindowInDays property determines the length of waiting period.\nDuring the waiting period, the key state of CMK is Pending Deletion, which prevents the CMK from being used in\ncryptographic operations. When the waiting period expires, AWS KMS permanently deletes the CMK.\n\nEnter a value between 7 and 30 days.",
3101 "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-pendingwindowindays",
3102 "stability": "stable",
3103 "summary": "Specifies the number of days in the waiting period before AWS KMS deletes a CMK that has been removed from a CloudFormation stack."
3104 },
3105 "immutable": true,
3106 "locationInModule": {
3107 "filename": "lib/key.ts",
3108 "line": 449
3109 },
3110 "name": "pendingWindow",
3111 "optional": true,
3112 "type": {
3113 "fqn": "@aws-cdk/core.Duration"
3114 }
3115 },
3116 {
3117 "abstract": true,
3118 "docs": {
3119 "default": "- A policy document with permissions for the account root to\nadminister the key will be created.",
3120 "remarks": "NOTE - If the `@aws-cdk/aws-kms:defaultKeyPolicies` feature flag is set (the default for new projects),\nthis policy will *override* the default key policy and become the only key policy for the key. If the\nfeature flag is not set, this policy will be appended to the default key policy.",
3121 "stability": "stable",
3122 "summary": "Custom policy document to attach to the KMS key."
3123 },
3124 "immutable": true,
3125 "locationInModule": {
3126 "filename": "lib/key.ts",
3127 "line": 396
3128 },
3129 "name": "policy",
3130 "optional": true,
3131 "type": {
3132 "fqn": "@aws-cdk/aws-iam.PolicyDocument"
3133 }
3134 },
3135 {
3136 "abstract": true,
3137 "docs": {
3138 "default": "RemovalPolicy.Retain",
3139 "remarks": "This is useful when one wants to\nretain access to data that was encrypted with a key that is being retired.",
3140 "stability": "stable",
3141 "summary": "Whether the encryption key should be retained when it is removed from the Stack."
3142 },
3143 "immutable": true,
3144 "locationInModule": {
3145 "filename": "lib/key.ts",
3146 "line": 416
3147 },
3148 "name": "removalPolicy",
3149 "optional": true,
3150 "type": {
3151 "fqn": "@aws-cdk/core.RemovalPolicy"
3152 }
3153 },
3154 {
3155 "abstract": true,
3156 "docs": {
3157 "default": "- false, unless the `@aws-cdk/aws-kms:defaultKeyPolicies` feature flag is set.",
3158 "deprecated": "redundant with the `@aws-cdk/aws-kms:defaultKeyPolicies` feature flag",
3159 "remarks": "Setting this to true adds a default statement which delegates key\naccess control completely to the identity's IAM policy (similar\nto how it works for other AWS resources). This matches the default behavior\nwhen creating KMS keys via the API or console.\n\nIf the `@aws-cdk/aws-kms:defaultKeyPolicies` feature flag is set (the default for new projects),\nthis flag will always be treated as 'true' and does not need to be explicitly set.",
3160 "see": "https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam",
3161 "stability": "deprecated",
3162 "summary": "Whether the key usage can be granted by IAM policies."
3163 },
3164 "immutable": true,
3165 "locationInModule": {
3166 "filename": "lib/key.ts",
3167 "line": 433
3168 },
3169 "name": "trustAccountIdentities",
3170 "optional": true,
3171 "type": {
3172 "primitive": "boolean"
3173 }
3174 }
3175 ],
3176 "symbolId": "lib/key:KeyProps"
3177 },
3178 "@aws-cdk/aws-kms.KeySpec": {
3179 "assembly": "@aws-cdk/aws-kms",
3180 "docs": {
3181 "stability": "stable",
3182 "summary": "The key spec, represents the cryptographic configuration of keys.",
3183 "example": "const key = new kms.Key(this, 'MyKey', {\n keySpec: kms.KeySpec.ECC_SECG_P256K1, // Default to SYMMETRIC_DEFAULT\n keyUsage: kms.KeyUsage.SIGN_VERIFY, // and ENCRYPT_DECRYPT\n});",
3184 "custom": {
3185 "exampleMetadata": "infused"
3186 }
3187 },
3188 "fqn": "@aws-cdk/aws-kms.KeySpec",
3189 "kind": "enum",
3190 "locationInModule": {
3191 "filename": "lib/key.ts",
3192 "line": 255
3193 },
3194 "members": [
3195 {
3196 "docs": {
3197 "remarks": "Valid usage: ENCRYPT_DECRYPT",
3198 "stability": "stable",
3199 "summary": "The default key spec."
3200 },
3201 "name": "SYMMETRIC_DEFAULT"
3202 },
3203 {
3204 "docs": {
3205 "remarks": "Valid usage: ENCRYPT_DECRYPT and SIGN_VERIFY",
3206 "stability": "stable",
3207 "summary": "RSA with 2048 bits of key."
3208 },
3209 "name": "RSA_2048"
3210 },
3211 {
3212 "docs": {
3213 "remarks": "Valid usage: ENCRYPT_DECRYPT and SIGN_VERIFY",
3214 "stability": "stable",
3215 "summary": "RSA with 3072 bits of key."
3216 },
3217 "name": "RSA_3072"
3218 },
3219 {
3220 "docs": {
3221 "remarks": "Valid usage: ENCRYPT_DECRYPT and SIGN_VERIFY",
3222 "stability": "stable",
3223 "summary": "RSA with 4096 bits of key."
3224 },
3225 "name": "RSA_4096"
3226 },
3227 {
3228 "docs": {
3229 "remarks": "Valid usage: SIGN_VERIFY",
3230 "stability": "stable",
3231 "summary": "NIST FIPS 186-4, Section 6.4, ECDSA signature using the curve specified by the key and SHA-256 for the message digest."
3232 },
3233 "name": "ECC_NIST_P256"
3234 },
3235 {
3236 "docs": {
3237 "remarks": "Valid usage: SIGN_VERIFY",
3238 "stability": "stable",
3239 "summary": "NIST FIPS 186-4, Section 6.4, ECDSA signature using the curve specified by the key and SHA-384 for the message digest."
3240 },
3241 "name": "ECC_NIST_P384"
3242 },
3243 {
3244 "docs": {
3245 "remarks": "Valid usage: SIGN_VERIFY",
3246 "stability": "stable",
3247 "summary": "NIST FIPS 186-4, Section 6.4, ECDSA signature using the curve specified by the key and SHA-512 for the message digest."
3248 },
3249 "name": "ECC_NIST_P521"
3250 },
3251 {
3252 "docs": {
3253 "remarks": "Valid usage: SIGN_VERIFY",
3254 "stability": "stable",
3255 "summary": "Standards for Efficient Cryptography 2, Section 2.4.1, ECDSA signature on the Koblitz curve."
3256 },
3257 "name": "ECC_SECG_P256K1"
3258 }
3259 ],
3260 "name": "KeySpec",
3261 "symbolId": "lib/key:KeySpec"
3262 },
3263 "@aws-cdk/aws-kms.KeyUsage": {
3264 "assembly": "@aws-cdk/aws-kms",
3265 "docs": {
3266 "stability": "stable",
3267 "summary": "The key usage, represents the cryptographic operations of keys.",
3268 "example": "const key = new kms.Key(this, 'MyKey', {\n keySpec: kms.KeySpec.ECC_SECG_P256K1, // Default to SYMMETRIC_DEFAULT\n keyUsage: kms.KeyUsage.SIGN_VERIFY, // and ENCRYPT_DECRYPT\n});",
3269 "custom": {
3270 "exampleMetadata": "infused"
3271 }
3272 },
3273 "fqn": "@aws-cdk/aws-kms.KeyUsage",
3274 "kind": "enum",
3275 "locationInModule": {
3276 "filename": "lib/key.ts",
3277 "line": 319
3278 },
3279 "members": [
3280 {
3281 "docs": {
3282 "stability": "stable",
3283 "summary": "Encryption and decryption."
3284 },
3285 "name": "ENCRYPT_DECRYPT"
3286 },
3287 {
3288 "docs": {
3289 "stability": "stable",
3290 "summary": "Signing and verification."
3291 },
3292 "name": "SIGN_VERIFY"
3293 }
3294 ],
3295 "name": "KeyUsage",
3296 "symbolId": "lib/key:KeyUsage"
3297 },
3298 "@aws-cdk/aws-kms.ViaServicePrincipal": {
3299 "assembly": "@aws-cdk/aws-kms",
3300 "base": "@aws-cdk/aws-iam.PrincipalBase",
3301 "docs": {
3302 "stability": "stable",
3303 "summary": "A principal to allow access to a key if it's being used through another AWS service.",
3304 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as kms from '@aws-cdk/aws-kms';\n\ndeclare const principal: iam.IPrincipal;\nconst viaServicePrincipal = new kms.ViaServicePrincipal('serviceName', /* all optional props */ principal);",
3305 "custom": {
3306 "exampleMetadata": "fixture=_generated"
3307 }
3308 },
3309 "fqn": "@aws-cdk/aws-kms.ViaServicePrincipal",
3310 "initializer": {
3311 "docs": {
3312 "stability": "stable"
3313 },
3314 "locationInModule": {
3315 "filename": "lib/via-service-principal.ts",
3316 "line": 9
3317 },
3318 "parameters": [
3319 {
3320 "name": "serviceName",
3321 "type": {
3322 "primitive": "string"
3323 }
3324 },
3325 {
3326 "name": "basePrincipal",
3327 "optional": true,
3328 "type": {
3329 "fqn": "@aws-cdk/aws-iam.IPrincipal"
3330 }
3331 }
3332 ]
3333 },
3334 "kind": "class",
3335 "locationInModule": {
3336 "filename": "lib/via-service-principal.ts",
3337 "line": 6
3338 },
3339 "methods": [
3340 {
3341 "docs": {
3342 "stability": "stable",
3343 "summary": "Return whether or not this principal is equal to the given principal."
3344 },
3345 "locationInModule": {
3346 "filename": "lib/via-service-principal.ts",
3347 "line": 28
3348 },
3349 "name": "dedupeString",
3350 "overrides": "@aws-cdk/aws-iam.PrincipalBase",
3351 "returns": {
3352 "optional": true,
3353 "type": {
3354 "primitive": "string"
3355 }
3356 }
3357 }
3358 ],
3359 "name": "ViaServicePrincipal",
3360 "properties": [
3361 {
3362 "docs": {
3363 "stability": "stable",
3364 "summary": "Return the policy fragment that identifies this principal in a Policy."
3365 },
3366 "immutable": true,
3367 "locationInModule": {
3368 "filename": "lib/via-service-principal.ts",
3369 "line": 14
3370 },
3371 "name": "policyFragment",
3372 "overrides": "@aws-cdk/aws-iam.PrincipalBase",
3373 "type": {
3374 "fqn": "@aws-cdk/aws-iam.PrincipalPolicyFragment"
3375 }
3376 }
3377 ],
3378 "symbolId": "lib/via-service-principal:ViaServicePrincipal"
3379 }
3380 },
3381 "version": "1.191.0",
3382 "fingerprint": "**********"
3383}
\No newline at end of file