AWS CDK Reference

Appearance

v2.274.0

SecurityGroupContextQuery Struct ​

Query input for looking up a security group.

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 ​

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 securityGroupContextQuery: cloud_assembly_schema.SecurityGroupContextQuery = {
  account: 'account',
  region: 'region',

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

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.
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

regionstringregionstrregionStringRegionstringRegion*stringrequired#
Query region.
securityGroupIdoptionalstringsecurity_group_idoptionalstrsecurityGroupIdoptionalStringSecurityGroupIdoptionalstringSecurityGroupIdoptional*string= None#
Security group id.
securityGroupNameoptionalstringsecurity_group_nameoptionalstrsecurityGroupNameoptionalStringSecurityGroupNameoptionalstringSecurityGroupNameoptional*string= None#
Security group name.
vpcIdoptionalstringvpc_idoptionalstrvpcIdoptionalStringVpcIdoptionalstringVpcIdoptional*string= None#
VPC ID.