Interface IVpcContextQuery
Query input for looking up a VPC.
Namespace: Amazon.CDK.CloudAssembly.Schema
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IVpcContextQuery
Syntax (vb)
Public Interface IVpcContextQuery
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CloudAssembly.Schema;
var vpcContextQuery = new VpcContextQuery {
Account = "account",
Filter = new Dictionary<string, string> {
{ "filterKey", "filter" }
},
Region = "region",
// the properties below are optional
LookupRoleArn = "lookupRoleArn",
ReturnAsymmetricSubnets = false,
ReturnVpnGateways = false,
SubnetGroupNameTag = "subnetGroupNameTag"
};
Synopsis
Properties
Account | Query account. |
Filter | Filters to apply to the VPC. |
LookupRoleArn | The ARN of the role that should be used to look up the missing values. |
Region | Query region. |
ReturnAsymmetricSubnets | Whether to populate the subnetGroups field of the |
ReturnVpnGateways | Whether to populate the |
SubnetGroupNameTag | Optional tag for subnet group name. |
Properties
Account
Query account.
string Account { get; }
Property Value
System.String
Filter
Filters to apply to the VPC.
IDictionary<string, string> Filter { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Filter parameters are the same as passed to DescribeVpcs.
See: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html
LookupRoleArn
The ARN of the role that should be used to look up the missing values.
virtual string LookupRoleArn { get; }
Property Value
System.String
Remarks
Default: - None
Region
Query region.
string Region { get; }
Property Value
System.String
ReturnAsymmetricSubnets
Whether to populate the subnetGroups field of the VpcContextResponse
, which contains potentially asymmetric subnet groups.
virtual Nullable<bool> ReturnAsymmetricSubnets { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
ReturnVpnGateways
Whether to populate the vpnGatewayId
field of the VpcContextResponse
, which contains the VPN Gateway ID, if one exists.
virtual Nullable<bool> ReturnVpnGateways { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
You can explicitly disable this in order to avoid the lookup if you know the VPC does not have a VPN Gatway attached.
Default: true
SubnetGroupNameTag
Optional tag for subnet group name.
virtual string SubnetGroupNameTag { get; }
Property Value
System.String
Remarks
If not provided, we'll look at the aws-cdk:subnet-name tag. If the subnet does not have the specified tag, we'll use its type as the name.
Default: 'aws-cdk:subnet-name'