Class VpcProps

Configuration for Vpc.

Inheritance
System.Object
VpcProps
Implements
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class VpcProps : Object, IVpcProps
Syntax (vb)
Public Class VpcProps
    Inherits Object
    Implements IVpcProps
Remarks

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.EC2;


Vpc vpc = new Vpc(this, "Vpc", new VpcProps {
    Cidr = "10.0.0.0/16"
});

VpcConnector vpcConnector = new VpcConnector(this, "VpcConnector", new VpcConnectorProps {
    Vpc = vpc,
    VpcSubnets = vpc.SelectSubnets(new SubnetSelection { SubnetType = SubnetType.PUBLIC }),
    VpcConnectorName = "MyVpcConnector"
});

new Service(this, "Service", new ServiceProps {
    Source = Source.FromEcrPublic(new EcrPublicProps {
        ImageConfiguration = new ImageConfiguration { Port = 8000 },
        ImageIdentifier = "public.ecr.aws/aws-containers/hello-app-runner:latest"
    }),
    VpcConnector = vpcConnector
});

Synopsis

Constructors

VpcProps()

Properties

Cidr

The CIDR range to use for the VPC, e.g. '10.0.0.0/16'.
DefaultInstanceTenancy

The default tenancy of instances launched into the VPC.
EnableDnsHostnames

Indicates whether the instances launched in the VPC get public DNS hostnames.
EnableDnsSupport

Indicates whether the DNS resolution is supported for the VPC.
FlowLogs

Flow logs to add to this VPC.
GatewayEndpoints

Gateway endpoints to add to this VPC.
MaxAzs

Define the maximum number of AZs to use in this region.
NatGatewayProvider

What type of NAT provider to use.
NatGateways

The number of NAT Gateways/Instances to create.
NatGatewaySubnets

Configures the subnets which will have NAT Gateways/Instances.
SubnetConfiguration

Configure the subnets to build for each AZ.
VpcName

The VPC name.
VpnConnections

VPN connections to this VPC.
VpnGateway

Indicates whether a VPN gateway should be created and attached to this VPC.
VpnGatewayAsn

The private Autonomous System Number (ASN) for the VPN gateway.
VpnRoutePropagation

Where to propagate VPN routes.

Constructors

VpcProps()

public VpcProps()

Properties

Cidr

The CIDR range to use for the VPC, e.g. '10.0.0.0/16'.

public string Cidr { get; set; }
Property Value

System.String

Remarks

Should be a minimum of /28 and maximum size of /16. The range will be split across all subnets per Availability Zone.

Default: Vpc.DEFAULT_CIDR_RANGE

DefaultInstanceTenancy

The default tenancy of instances launched into the VPC.

public Nullable<DefaultInstanceTenancy> DefaultInstanceTenancy { get; set; }
Property Value

System.Nullable<DefaultInstanceTenancy>

Remarks

By setting this to dedicated tenancy, instances will be launched on hardware dedicated to a single AWS customer, unless specifically specified at instance launch time. Please note, not all instance types are usable with Dedicated tenancy.

Default: DefaultInstanceTenancy.Default (shared) tenancy

EnableDnsHostnames

Indicates whether the instances launched in the VPC get public DNS hostnames.

public Nullable<bool> EnableDnsHostnames { get; set; }
Property Value

System.Nullable<System.Boolean>

Remarks

If this attribute is true, instances in the VPC get public DNS hostnames, but only if the enableDnsSupport attribute is also set to true.

Default: true

EnableDnsSupport

Indicates whether the DNS resolution is supported for the VPC.

public Nullable<bool> EnableDnsSupport { get; set; }
Property Value

System.Nullable<System.Boolean>

Remarks

If this attribute is false, the Amazon-provided DNS server in the VPC that resolves public DNS hostnames to IP addresses is not enabled. If this attribute is true, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC IPv4 network range plus two will succeed.

Default: true

FlowLogs

Flow logs to add to this VPC.

public IDictionary<string, IFlowLogOptions> FlowLogs { get; set; }
Property Value

System.Collections.Generic.IDictionary<System.String, IFlowLogOptions>

Remarks

Default: - No flow logs.

GatewayEndpoints

Gateway endpoints to add to this VPC.

public IDictionary<string, IGatewayVpcEndpointOptions> GatewayEndpoints { get; set; }
Property Value

System.Collections.Generic.IDictionary<System.String, IGatewayVpcEndpointOptions>

Remarks

Default: - None.

MaxAzs

Define the maximum number of AZs to use in this region.

public Nullable<double> MaxAzs { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

If the region has more AZs than you want to use (for example, because of EIP limits), pick a lower number here. The AZs will be sorted and picked from the start of the list.

If you pick a higher number than the number of AZs in the region, all AZs in the region will be selected. To use "all AZs" available to your account, use a high number (such as 99).

Be aware that environment-agnostic stacks will be created with access to only 2 AZs, so to use more than 2 AZs, be sure to specify the account and region on your stack.

Default: 3

NatGatewayProvider

What type of NAT provider to use.

public NatProvider NatGatewayProvider { get; set; }
Property Value

NatProvider

Remarks

Select between NAT gateways or NAT instances. NAT gateways may not be available in all AWS regions.

Default: NatProvider.gateway()

NatGateways

The number of NAT Gateways/Instances to create.

public Nullable<double> NatGateways { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

The type of NAT gateway or instance will be determined by the natGatewayProvider parameter.

You can set this number lower than the number of Availability Zones in your VPC in order to save on NAT cost. Be aware you may be charged for cross-AZ data traffic instead.

Default: - One NAT gateway/instance per Availability Zone

NatGatewaySubnets

Configures the subnets which will have NAT Gateways/Instances.

public ISubnetSelection NatGatewaySubnets { get; set; }
Property Value

ISubnetSelection

Remarks

You can pick a specific group of subnets by specifying the group name; the picked subnets must be public subnets.

Only necessary if you have more than one public subnet group.

Default: - All public subnets.

SubnetConfiguration

Configure the subnets to build for each AZ.

public ISubnetConfiguration[] SubnetConfiguration { get; set; }
Property Value

ISubnetConfiguration[]

Remarks

Each entry in this list configures a Subnet Group; each group will contain a subnet for each Availability Zone.

For example, if you want 1 public subnet, 1 private subnet, and 1 isolated subnet in each AZ provide the following:

new Vpc(this, "VPC", new VpcProps {
    SubnetConfiguration = new [] { new SubnetConfiguration {
        CidrMask = 24,
        Name = "ingress",
        SubnetType = SubnetType.PUBLIC
    }, new SubnetConfiguration {
        CidrMask = 24,
        Name = "application",
        SubnetType = SubnetType.PRIVATE_WITH_NAT
    }, new SubnetConfiguration {
        CidrMask = 28,
        Name = "rds",
        SubnetType = SubnetType.PRIVATE_ISOLATED
    } }
});

Default: - The VPC CIDR will be evenly divided between 1 public and 1 private subnet per AZ.

VpcName

The VPC name.

public string VpcName { get; set; }
Property Value

System.String

Remarks

Since the VPC resource doesn't support providing a physical name, the value provided here will be recorded in the Name tag

Default: this.node.path

VpnConnections

VPN connections to this VPC.

public IDictionary<string, IVpnConnectionOptions> VpnConnections { get; set; }
Property Value

System.Collections.Generic.IDictionary<System.String, IVpnConnectionOptions>

Remarks

Default: - No connections.

VpnGateway

Indicates whether a VPN gateway should be created and attached to this VPC.

public Nullable<bool> VpnGateway { get; set; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: - true when vpnGatewayAsn or vpnConnections is specified

VpnGatewayAsn

The private Autonomous System Number (ASN) for the VPN gateway.

public Nullable<double> VpnGatewayAsn { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

Default: - Amazon default ASN.

VpnRoutePropagation

Where to propagate VPN routes.

public ISubnetSelection[] VpnRoutePropagation { get; set; }
Property Value

ISubnetSelection[]

Remarks

Default: - On the route tables associated with private subnets. If no private subnets exists, isolated subnets are used. If no isolated subnets exists, public subnets are used.

Implements