Type Alias KeyProvider

{
 *   arn: "arn:aws:kms:eu-west-1:111222334455:key/mrk-1237c011a37erft67ei987c7612q456",
 *   current: false,
 *   description: "test description",
 *   multiRegion: true,
 *   name: "test name",
 *   replicaKeys: [
 *     {
 *       arn: "arn:aws:kms:eu-west-3:111222334455:key/mrk-1237c011a37erft67ei987c7612q456",
 *       region: "eu-west-3"
 *     }
 *   ]
 * }
type KeyProvider = {
    arn: string;
    arnFingerPrint?: string;
    createdAt?: string;
    current?: boolean;
    demotedFromCurrentAt?: string;
    description?: string;
    keyProvider?: "AWS-KMS";
    multiRegion?: boolean;
    name: string;
    promotedToCurrentAt?: string;
    replicaKeys?: { arn?: string; region?: string }[];
    tenantId?: string;
}
Index

Properties

arn arnFingerPrint? createdAt? current? demotedFromCurrentAt? description? keyProvider? multiRegion? name promotedToCurrentAt? replicaKeys? tenantId?

Properties

arn: string

The provider resource notation for the key.

arnFingerPrint?: string

The ARN fingerprint.

createdAt?: string

When key entry was created.

current?: boolean

Indicates whether the key is being used to encrypt/decrypt secrets.

demotedFromCurrentAt?: string

When the key was demoted from being current to non active.

description?: string

Description of key provider entry.

keyProvider?: "AWS-KMS"

Key Provider type.

multiRegion?: boolean

Indicates whether the key has multi-region configurations and has replica key in qcs secondary region.

name: string

Name of key provider entry.

promotedToCurrentAt?: string

When the key was promoted to being the current active one.

replicaKeys?: { arn?: string; region?: string }[]

Type declaration

  • Optionalarn?: string

    Replica key keeps list of backup keys from the supported qcs secondary region.

  • Optionalregion?: string

    Region indicates the backup qcs-region link to the primary region.

tenantId?: string

Tenant ID.

Settings

Member Visibility

On This Page

Properties