@aws-cdk_cloud-assembly-schema.KeyContextQuery

interface KeyContextQuery

LanguageType name
.NETAmazon.CDK.CloudAssembly.Schema.KeyContextQuery
Javasoftware.amazon.awscdk.cloudassembly.schema.KeyContextQuery
Pythonaws_cdk.cloud_assembly_schema.KeyContextQuery
TypeScript (source)@aws-cdk/cloud-assembly-schema » KeyContextQuery

Query input for looking up a KMS Key.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';
const keyContextQuery: cloud_assembly_schema.KeyContextQuery = {
  account: 'account',
  aliasName: 'aliasName',
  region: 'region',

  // the properties below are optional
  lookupRoleArn: 'lookupRoleArn',
};

Properties

NameTypeDescription
accountstringQuery account.
aliasNamestringAlias name used to search the Key.
regionstringQuery region.
lookupRoleArn?stringThe ARN of the role that should be used to look up the missing values.

account

Type: string

Query account.


aliasName

Type: string

Alias name used to search the Key.


region

Type: string

Query region.


lookupRoleArn?

Type: string (optional, default: None)

The ARN of the role that should be used to look up the missing values.