interface SecurityGroupContextQuery

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

Query input for looking up a security group.

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

Name	Type	Description
account	string	Query account.
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.
securityGroupId?	string	Security group id.
securityGroupName?	string	Security group name.
vpcId?	string	VPC ID.

---

account

Type: string

Query account.

---

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.

---

securityGroupId?

Type: string (optional, default: None)

Security group id.

---

securityGroupName?

Type: string (optional, default: None)

Security group name.

---

vpcId?

Type: string (optional, default: None)

VPC ID.