KeyProps

All Known Implementing Classes:: KeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:53.879Z")
public interface KeyProps

Construction properties for a KMS Key object.

Example:

 IRole myTrustedAdminRole = Role.fromRoleArn(this, "TrustedRole", "arn:aws:iam:....");
 // Creates a limited admin policy and assigns to the account root.
 PolicyDocument myCustomPolicy = PolicyDocument.Builder.create()
         .statements(List.of(PolicyStatement.Builder.create()
                 .actions(List.of("kms:Create*", "kms:Describe*", "kms:Enable*", "kms:List*", "kms:Put*"))
                 .principals(List.of(new AccountRootPrincipal()))
                 .resources(List.of("*"))
                 .build()))
         .build();
 Key key = Key.Builder.create(this, "MyKey")
         .policy(myCustomPolicy)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class KeyProps.Builder
A builder for KeyProps

static class KeyProps.Jsii$Proxy
An implementation for KeyProps

Nested Classes
Modifier and Type	Interface and Description
`static class`	`KeyProps.Builder` A builder for `KeyProps`
`static class`	`KeyProps.Jsii$Proxy` An implementation for `KeyProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`static KeyProps.Builder`	`builder()`
`default java.util.List<IPrincipal>`	`getAdmins()` A list of principals to add as key administrators to the key policy.
`default java.lang.String`	`getAlias()` Initial alias to add to the key.
`default java.lang.String`	`getDescription()` A description of the key.
`default java.lang.Boolean`	`getEnabled()` Indicates whether the key is available for use.
`default java.lang.Boolean`	`getEnableKeyRotation()` Indicates whether AWS KMS rotates the key.
`default KeySpec`	`getKeySpec()` The cryptographic configuration of the key.
`default KeyUsage`	`getKeyUsage()` The cryptographic operations for which the key can be used.
`default Duration`	`getPendingWindow()` Specifies the number of days in the waiting period before AWS KMS deletes a CMK that has been removed from a CloudFormation stack.
`default PolicyDocument`	`getPolicy()` Custom policy document to attach to the KMS key.
`default RemovalPolicy`	`getRemovalPolicy()` Whether the encryption key should be retained when it is removed from the Stack.
`default java.lang.Boolean`	`getTrustAccountIdentities()` Deprecated. redundant with the `@aws-cdk/aws-kms:defaultKeyPolicies` feature flag

- Method Detail
  - getAdmins
```
default java.util.List<IPrincipal> getAdmins()
```
    A list of principals to add as key administrators to the key policy.
    Key administrators have permissions to manage the key (e.g., change permissions, revoke), but do not have permissions to use the key in cryptographic operations (e.g., encrypt, decrypt).
    These principals will be added to the default key policy (if none specified), or to the specified policy (if provided).
    Default: []
  - getAlias
```
default java.lang.String getAlias()
```
    Initial alias to add to the key.
    More aliases can be added later by calling addAlias.
    Default: - No alias is added for the key.
  - getDescription
```
default java.lang.String getDescription()
```
    A description of the key.
    Use a description that helps your users decide whether the key is appropriate for a particular task.
    Default: - No description.
  - getEnabled
```
default java.lang.Boolean getEnabled()
```
    Indicates whether the key is available for use.
    Default: - Key is enabled.
  - getEnableKeyRotation
```
default java.lang.Boolean getEnableKeyRotation()
```
    Indicates whether AWS KMS rotates the key.
    Default: false
  - getKeySpec
```
default KeySpec getKeySpec()
```
    The cryptographic configuration of the key. The valid value depends on usage of the key.
    IMPORTANT: If you change this property of an existing key, the existing key is scheduled for deletion and a new key is created with the specified value.
    Default: KeySpec.SYMMETRIC_DEFAULT
  - getKeyUsage
```
default KeyUsage getKeyUsage()
```
    The cryptographic operations for which the key can be used.
    IMPORTANT: If you change this property of an existing key, the existing key is scheduled for deletion and a new key is created with the specified value.
    Default: KeyUsage.ENCRYPT_DECRYPT
  - getPendingWindow
```
default Duration getPendingWindow()
```
    Specifies the number of days in the waiting period before AWS KMS deletes a CMK that has been removed from a CloudFormation stack.
    When you remove a customer master key (CMK) from a CloudFormation stack, AWS KMS schedules the CMK 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 CMK is Pending Deletion, which prevents the CMK from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the CMK.
    Enter a value between 7 and 30 days.
    Default: - 30 days
    
    See Also:
    
    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-pendingwindowindays
  - getPolicy
```
default PolicyDocument getPolicy()
```
    Custom policy document to attach to the KMS key.
    NOTE - If the @aws-cdk/aws-kms:defaultKeyPolicies feature flag is set (the default for new projects), this policy will override the default key policy and become the only key policy for the key. If the feature flag is not set, this policy will be appended to the default key policy.
    Default: - A policy document with permissions for the account root to administer the key will be created.
  - getRemovalPolicy
```
default RemovalPolicy getRemovalPolicy()
```
    Whether the encryption key should be retained when it is removed from the Stack.
    This is useful when one wants to retain access to data that was encrypted with a key that is being retired.
    Default: RemovalPolicy.Retain
  - getTrustAccountIdentities
```
@Deprecated
default java.lang.Boolean getTrustAccountIdentities()
```
    Deprecated. redundant with the `@aws-cdk/aws-kms:defaultKeyPolicies` feature flag
    
    (deprecated) Whether the key usage can be granted by IAM policies.
    Setting this to true adds a default statement which delegates key access control completely to the identity's IAM policy (similar to how it works for other AWS resources). This matches the default behavior when creating KMS keys via the API or console.
    If the @aws-cdk/aws-kms:defaultKeyPolicies feature flag is set (the default for new projects), this flag will always be treated as 'true' and does not need to be explicitly set.
    Default: - false, unless the `@aws-cdk/aws-kms:defaultKeyPolicies` feature flag is set.
    
    See Also:
    
    https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam
  - builder
```
static KeyProps.Builder builder()
```
    Returns:
    
    a KeyProps.Builder of KeyProps

Interface KeyProps

Nested Class Summary

Method Summary

Method Detail

getAdmins

getAlias

getDescription

getEnabled

getEnableKeyRotation

getKeySpec

getKeyUsage

getPendingWindow

getPolicy

getRemovalPolicy

getTrustAccountIdentities

builder