Skip to content
v2.277.0

SecurityGroupContextQuery Struct ​

Query input for looking up a security group.

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',
};
python
from aws_cdk.cloud_assembly_schema import SecurityGroupContextQuery
# 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

security_group_context_query = SecurityGroupContextQuery(
    account="account",
    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",
    security_group_id="securityGroupId",
    security_group_name="securityGroupName",
    vpc_id="vpcId"
)
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;

SecurityGroupContextQuery securityGroupContextQuery = SecurityGroupContextQuery.builder()
        .account("account")
        .region("region")

        // the properties below are optional
        .assumeRoleAdditionalOptions(Map.of(
                "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
        .lookupRoleArn("lookupRoleArn")
        .lookupRoleExternalId("lookupRoleExternalId")
        .securityGroupId("securityGroupId")
        .securityGroupName("securityGroupName")
        .vpcId("vpcId")
        .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 securityGroupContextQuery = new SecurityGroupContextQuery {
    Account = "account",
    Region = "region",

    // the properties below are optional
    AssumeRoleAdditionalOptions = new Dictionary<string, object> {
        { "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions }
    },
    LookupRoleArn = "lookupRoleArn",
    LookupRoleExternalId = "lookupRoleExternalId",
    SecurityGroupId = "securityGroupId",
    SecurityGroupName = "securityGroupName",
    VpcId = "vpcId"
};
go
// 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{}

securityGroupContextQuery := &SecurityGroupContextQuery{
	Account: jsii.String("account"),
	Region: jsii.String("region"),

	// the properties below are optional
	AssumeRoleAdditionalOptions: map[string]interface{}{
		"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
	},
	LookupRoleArn: jsii.String("lookupRoleArn"),
	LookupRoleExternalId: jsii.String("lookupRoleExternalId"),
	SecurityGroupId: jsii.String("securityGroupId"),
	SecurityGroupName: jsii.String("securityGroupName"),
	VpcId: jsii.String("vpcId"),
}

Properties ​

accountstringaccountstraccountStringAccountstringAccount*string required #
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*string required #
Query region.
securityGroupIdoptionalstringsecurity_group_idoptionalstrsecurityGroupIdoptionalStringSecurityGroupIdoptionalstringSecurityGroupIdoptional*string = None #
Security group id.
securityGroupNameoptionalstringsecurity_group_nameoptionalstrsecurityGroupNameoptionalStringSecurityGroupNameoptionalstringSecurityGroupNameoptional*string = None #
Security group name.
vpcIdoptionalstringvpc_idoptionalstrvpcIdoptionalStringVpcIdoptionalstringVpcIdoptional*string = None #
VPC ID.