interface AmiContextQuery

Language	Type name
.NET	Amazon.CDK.cloud_assembly_schema.AmiContextQuery
Go	github.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#AmiContextQuery
Java	software.amazon.awscdk.cloud_assembly_schema.AmiContextQuery
Python	aws_cdk.cloud_assembly_schema.AmiContextQuery
TypeScript (source)	aws-cdk-lib » cloud_assembly_schema » AmiContextQuery

Query to AMI context provider.

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 amiContextQuery: cloud_assembly_schema.AmiContextQuery = {
  account: 'account',
  filters: {
    filtersKey: ['filters'],
  },
  region: 'region',

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

Properties

Name	Type	Description
account	string	Query account.
filters	{ [string]: string[] }	Filters to DescribeImages call.
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.
owners?	string[]	Owners to DescribeImages call.

---

account

Type: string

Query account.

---

filters

Type: { [string]: string[] }

Filters to DescribeImages call.

---

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.

---

owners?

Type: string[] (optional, default: All owners)

Owners to DescribeImages call.