Crypto KMS
    Preparing search index...

    Interface AwsKmsOptions

    Configuration for the AWS KMS provider.

    const opts: AwsKmsOptions = {
      region: "us-east-1",
      credentials: { accessKeyId: "AKIA...", secretAccessKey: "wJal..." },
    };
    interface AwsKmsOptions {
        region: string;
        credentials?: {
            accessKeyId: string;
            secretAccessKey: string;
            sessionToken?: string;
        };
        endpoint?: string;
    }
    Index
    region credentials? endpoint?
    region: string

    AWS region (e.g. "us-east-1").

    credentials?: {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    }

    Optional AWS credentials override.

    Type Declaration

    • accessKeyId: string

      AWS access key ID.

    • secretAccessKey: string

      AWS secret access key.

    • OptionalsessionToken?: string

      Optional AWS session token for temporary credentials.

    endpoint?: string

    Optional endpoint override (for LocalStack, etc.).

    Settings
    Member Visibility

    On This Page
    Properties