interface KeyContextQuery

Language	Type name
.NET	Amazon.CDK.cloud_assembly_schema.KeyContextQuery
Go	github.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#KeyContextQuery
Java	software.amazon.awscdk.cloud_assembly_schema.KeyContextQuery
Python	aws_cdk.cloud_assembly_schema.KeyContextQuery
TypeScript (source)	aws-cdk-lib » 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 { cloud_assembly_schema } from 'aws-cdk-lib';

declare const assumeRoleAdditionalOptions: any;
const keyContextQuery: cloud_assembly_schema.KeyContextQuery = {
  account: 'account',
  aliasName: 'aliasName',
  region: 'region',

  // the properties below are optional
  assumeRoleAdditionalOptions: {
    assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
  },
  lookupRoleArn: 'lookupRoleArn',
  lookupRoleExternalId: 'lookupRoleExternalId',
};

Properties

Name	Type	Description
account	string	Query account.
aliasName	string	Alias name used to search the Key.
region	string	Query region.
assumeRoleAdditionalOptions?	{ [string]: any }	Additional options to pass to STS when assuming the lookup role.
lookupRoleArn?	string	The ARN of the role that should be used to look up the missing values.
lookupRoleExternalId?	string	The ExternalId that needs to be supplied while assuming this role.

---

account

Type: string

Query account.

---

aliasName

Type: string

Alias name used to search the Key.

---

region

Type: string

Query region.

---

assumeRoleAdditionalOptions?

Type: { [string]: any } (optional, default: No additional options.)

Additional options to pass to STS when assuming the lookup role.

• RoleArn should not be used. Use the dedicated lookupRoleArn property instead.
• ExternalId should not be used. Use the dedicated lookupRoleExternalId instead.

See also: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

---

lookupRoleArn?

Type: string (optional, default: None)

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

---

lookupRoleExternalId?

Type: string (optional, default: No ExternalId will be supplied)

The ExternalId that needs to be supplied while assuming this role.