Skip to content
v2.274.0

AmiContextQuery Struct ​

Query to AMI context provider.

Example ​

ts
// 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 ​

accountstringaccountstraccountStringAccountstringAccount*stringrequired#
Query account.
assumeRoleAdditionalOptionsoptional{ [key: string]: any }assume_role_additional_optionsoptionaltyping.Mapping[str, Any]assumeRoleAdditionalOptionsoptionalMap<String, Object>AssumeRoleAdditionalOptionsoptionalIDictionary<string, object>AssumeRoleAdditionalOptionsoptional*map[string]interface{}#
Additional options to pass to STS when assuming the lookup role.

Default: No additional options.

  • RoleArn should not be used. Use the dedicated lookupRoleArn property instead.
  • ExternalId should not be used. Use the dedicated lookupRoleExternalId instead.
filters{ [key: string]: string[] }filterstyping.Mapping[str, typing.List[str]]filtersMap<String, List<String>>FiltersIDictionary<string, string[]>Filters*map[string]*[]*stringrequired#
Filters to DescribeImages call.
lookupRoleArnoptionalstringlookup_role_arnoptionalstrlookupRoleArnoptionalStringLookupRoleArnoptionalstringLookupRoleArnoptional*string= None#
The ARN of the role that should be used to look up the missing values.
lookupRoleExternalIdoptionalstringlookup_role_external_idoptionalstrlookupRoleExternalIdoptionalStringLookupRoleExternalIdoptionalstringLookupRoleExternalIdoptional*string#
The ExternalId that needs to be supplied while assuming this role.

Default: No ExternalId will be supplied

ownersoptionalstring[]ownersoptionaltyping.List[str]ownersoptionalList<String>Ownersoptionalstring[]Ownersoptional*[]*string#
Owners to DescribeImages call.

Default: All owners

regionstringregionstrregionStringRegionstringRegion*stringrequired#
Query region.