GradientEdge CDK Utils
    Preparing search index...
    interface KmsKeyProps {
        admins?: IPrincipal[];
        alias?: string;
        description?: string;
        enabled?: boolean;
        enableKeyRotation?: boolean;
        keySpec?: KeySpec;
        keyUsage?: KeyUsage;
        multiRegion?: boolean;
        pendingWindow?: Duration;
        policy?: PolicyDocument;
        removalPolicy?: RemovalPolicy;
        rotationPeriod?: Duration;
    }

    Hierarchy

    • KeyProps
      • KmsKeyProps
    Index

    Properties

    admins?: IPrincipal[]

    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).

    []
    
    alias?: string

    Initial alias to add to the key

    More aliases can be added later by calling addAlias.

    - No alias is added for the key.
    
    description?: string

    A description of the key. Use a description that helps your users decide whether the key is appropriate for a particular task.

    - No description.
    
    enabled?: boolean

    Indicates whether the key is available for use.

    - Key is enabled.
    
    enableKeyRotation?: boolean

    Indicates whether AWS KMS rotates the key.

    false
    
    keySpec?: KeySpec

    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.

    KeySpec.SYMMETRIC_DEFAULT
    
    keyUsage?: KeyUsage

    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.

    KeyUsage.ENCRYPT_DECRYPT
    
    multiRegion?: boolean

    Creates a multi-Region primary key that you can replicate in other AWS Regions.

    You can't change the multiRegion value after the KMS key is created.

    IMPORTANT: 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. This prevents you from accidentally deleting a KMS key by changing an immutable property value.

    pendingWindow?: Duration

    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.

    policy?: PolicyDocument

    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.

    - A policy document with permissions for the account root to
    administer the key will be created.
    removalPolicy?: RemovalPolicy

    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.

    RemovalPolicy.Retain
    
    rotationPeriod?: Duration

    The period between each automatic rotation.

    - set by CFN to 365 days.