AmiContextQuery Struct

Query to AMI context provider.

Source: node_modules/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/context-queries.d.ts
Type last changed: v2.160.0 · 24 Sep 2024

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'],
};

python

from aws_cdk.cloud_assembly_schema import AmiContextQuery
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import cloud_assembly_schema

# assume_role_additional_options: Any

ami_context_query = AmiContextQuery(
    account="account",
    filters={
        "filters_key": ["filters"]
    },
    region="region",

    # the properties below are optional
    assume_role_additional_options={
        "assume_role_additional_options_key": assume_role_additional_options
    },
    lookup_role_arn="lookupRoleArn",
    lookup_role_external_id="lookupRoleExternalId",
    owners=["owners"]
)

java

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cloud_assembly_schema.*;

Object assumeRoleAdditionalOptions;

AmiContextQuery amiContextQuery = AmiContextQuery.builder()
        .account("account")
        .filters(Map.of(
                "filtersKey", List.of("filters")))
        .region("region")

        // the properties below are optional
        .assumeRoleAdditionalOptions(Map.of(
                "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
        .lookupRoleArn("lookupRoleArn")
        .lookupRoleExternalId("lookupRoleExternalId")
        .owners(List.of("owners"))
        .build();

csharp

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Cloud_assembly_schema;

var assumeRoleAdditionalOptions;

var amiContextQuery = new AmiContextQuery {
    Account = "account",
    Filters = new Dictionary<string, string[]> {
        { "filtersKey", new [] { "filters" } }
    },
    Region = "region",

    // the properties below are optional
    AssumeRoleAdditionalOptions = new Dictionary<string, object> {
        { "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions }
    },
    LookupRoleArn = "lookupRoleArn",
    LookupRoleExternalId = "lookupRoleExternalId",
    Owners = new [] { "owners" }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var assumeRoleAdditionalOptions interface{}

amiContextQuery := &AmiContextQuery{
	Account: jsii.String("account"),
	Filters: map[string][]*string{
		"filtersKey": []*string{
			jsii.String("filters"),
		},
	},
	Region: jsii.String("region"),

	// the properties below are optional
	AssumeRoleAdditionalOptions: map[string]interface{}{
		"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
	},
	LookupRoleArn: jsii.String("lookupRoleArn"),
	LookupRoleExternalId: jsii.String("lookupRoleExternalId"),
	Owners: []*string{
		jsii.String("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.

AmiContextQuery Struct ​

Example ​

Properties ​

AmiContextQuery Struct

Example

Properties