MDAA TS Docs
    Preparing search index...

    Interface MdaaKmsKeyProps

    interface MdaaKmsKeyProps {
        alias?: string;
        createOutputs?: boolean;
        createParams?: boolean;
        description?: string;
        keyAdminRoles?: MdaaResolvableRole[];
        keySpec?: KeySpec;
        keyUsage?: KeyUsage;
        keyUserRoles?: MdaaResolvableRole[];
        naming: IMdaaResourceNaming;
        pendingWindow?: Duration;
        policy?: PolicyDocument;
        tier?: ParameterTier;
    }

    Hierarchy (View Summary)

    Index

    Properties

    alias? createOutputs? createParams? description? keyAdminRoles? keySpec? keyUsage? keyUserRoles? naming pendingWindow? policy? tier?

    Properties

    alias?: string
    createOutputs?: boolean

    Flag controlling CloudFormation output and stack export creation for construct resources

    createParams?: boolean

    Flag controlling SSM parameter creation for construct resource references enabling

    description?: string

    Human-readable description of the KMS key explaining its purpose and intended usage

    keyAdminRoles?: MdaaResolvableRole[]

    Resolved roles granted key admin permissions. Cross-account roles are automatically handled as ARN-based principals; same-account roles use the aws:userId condition.

    keySpec?: KeySpec
    keyUsage?: KeyUsage
    keyUserRoles?: MdaaResolvableRole[]

    Resolved roles granted key usage permissions. Cross-account roles are automatically handled as ARN-based principals; same-account roles use the aws:userId condition.

    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    pendingWindow?: Duration
    policy?: PolicyDocument
    tier?: ParameterTier

    Tier for the SSM parameters this construct publishes. Only Advanced-tier parameters can be shared with another account through AWS RAM, and Advanced-tier parameters are billed, so leave this unset unless a parameter is being shared.

    - ParameterTier.STANDARD, as applied by SSM

    Settings

    Member Visibility

    On This Page

    Properties