Package software.amazon.awscdk.services.ec2

Class Vpc.Builder

java.lang.Object
software.amazon.awscdk.services.ec2.Vpc.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Vpc>
Enclosing class:
Vpc
@Stability(Stable) public static final class Vpc.Builder extends Object implements software.amazon.jsii.Builder<Vpc>
A fluent builder for Vpc.

  • Method Details

    • create

      @Stability(Stable) public static Vpc.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of Vpc.Builder.

    • availabilityZones

      @Stability(Stable) public Vpc.Builder availabilityZones(List<String> availabilityZones)
      Availability zones this VPC spans.

      Specify this option only if you do not specify maxAzs.

      Default: - a subset of AZs of the stack

      Parameters:
      availabilityZones - Availability zones this VPC spans. This parameter is required.
      Returns:
      this

    • cidr

      @Stability(Deprecated) @Deprecated public Vpc.Builder cidr(String cidr)
      Deprecated.
      Use ipAddresses instead
      (deprecated) The CIDR range to use for the VPC, e.g. '10.0.0.0/16'.

      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

      Parameters:
      cidr - The CIDR range to use for the VPC, e.g. '10.0.0.0/16'. This parameter is required.
      Returns:
      this

    • createInternetGateway

      @Stability(Stable) public Vpc.Builder createInternetGateway(Boolean createInternetGateway)
      If set to false then disable the creation of the default internet gateway.

      Default: true

      Parameters:
      createInternetGateway - If set to false then disable the creation of the default internet gateway. This parameter is required.
      Returns:
      this

    • defaultInstanceTenancy

      @Stability(Stable) public Vpc.Builder defaultInstanceTenancy(DefaultInstanceTenancy defaultInstanceTenancy)
      The default tenancy of instances launched into the VPC.

      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

      Parameters:
      defaultInstanceTenancy - The default tenancy of instances launched into the VPC. This parameter is required.
      Returns:
      this

    • enableDnsHostnames

      @Stability(Stable) public Vpc.Builder enableDnsHostnames(Boolean enableDnsHostnames)
      Indicates whether the instances launched in the VPC get public DNS hostnames.

      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

      Parameters:
      enableDnsHostnames - Indicates whether the instances launched in the VPC get public DNS hostnames. This parameter is required.
      Returns:
      this

    • enableDnsSupport

      @Stability(Stable) public Vpc.Builder enableDnsSupport(Boolean enableDnsSupport)
      Indicates whether the DNS resolution is supported for the VPC.

      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

      Parameters:
      enableDnsSupport - Indicates whether the DNS resolution is supported for the VPC. This parameter is required.
      Returns:
      this

    • flowLogs

      @Stability(Stable) public Vpc.Builder flowLogs(Map<String,? extends FlowLogOptions> flowLogs)
      Flow logs to add to this VPC.

      Default: - No flow logs.

      Parameters:
      flowLogs - Flow logs to add to this VPC. This parameter is required.
      Returns:
      this

    • gatewayEndpoints

      @Stability(Stable) public Vpc.Builder gatewayEndpoints(Map<String,? extends GatewayVpcEndpointOptions> gatewayEndpoints)
      Gateway endpoints to add to this VPC.

      Default: - None.

      Parameters:
      gatewayEndpoints - Gateway endpoints to add to this VPC. This parameter is required.
      Returns:
      this

    • ipAddresses

      @Stability(Stable) public Vpc.Builder ipAddresses(IIpAddresses ipAddresses)
      The Provider to use to allocate IPv4 Space to your VPC.

      Options include static allocation or from a pool.

      Note this is specific to IPv4 addresses.

      Default: ec2.IpAddresses.cidr

      Parameters:
      ipAddresses - The Provider to use to allocate IPv4 Space to your VPC. This parameter is required.
      Returns:
      this

    • ipProtocol

      @Stability(Stable) public Vpc.Builder ipProtocol(IpProtocol ipProtocol)
      The protocol of the vpc.

      Options are IPv4 only or dual stack.

      Default: IpProtocol.IPV4_ONLY

      Parameters:
      ipProtocol - The protocol of the vpc. This parameter is required.
      Returns:
      this

    • ipv6Addresses

      @Stability(Stable) public Vpc.Builder ipv6Addresses(IIpv6Addresses ipv6Addresses)
      The Provider to use to allocate IPv6 Space to your VPC.

      Options include amazon provided CIDR block.

      Note this is specific to IPv6 addresses.

      Default: Ipv6Addresses.amazonProvided

      Parameters:
      ipv6Addresses - The Provider to use to allocate IPv6 Space to your VPC. This parameter is required.
      Returns:
      this

    • maxAzs

      @Stability(Stable) public Vpc.Builder maxAzs(Number maxAzs)
      Define the maximum number of AZs to use in this region.

      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.

      Specify this option only if you do not specify availabilityZones.

      Default: 3

      Parameters:
      maxAzs - Define the maximum number of AZs to use in this region. This parameter is required.
      Returns:
      this

    • natGatewayProvider

      @Stability(Stable) public Vpc.Builder natGatewayProvider(NatProvider natGatewayProvider)
      What type of NAT provider to use.

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

      Default: NatProvider.gateway()

      Parameters:
      natGatewayProvider - What type of NAT provider to use. This parameter is required.
      Returns:
      this

    • natGateways

      @Stability(Stable) public Vpc.Builder natGateways(Number natGateways)
      The number of NAT Gateways/Instances to create.

      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

      Parameters:
      natGateways - The number of NAT Gateways/Instances to create. This parameter is required.
      Returns:
      this

    • natGatewaySubnets

      @Stability(Stable) public Vpc.Builder natGatewaySubnets(SubnetSelection natGatewaySubnets)
      Configures the subnets which will have NAT Gateways/Instances.

      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.

      Parameters:
      natGatewaySubnets - Configures the subnets which will have NAT Gateways/Instances. This parameter is required.
      Returns:
      this

    • reservedAzs

      @Stability(Stable) public Vpc.Builder reservedAzs(Number reservedAzs)
      Define the number of AZs to reserve.

      When specified, the IP space is reserved for the azs but no actual resources are provisioned.

      Default: 0

      Parameters:
      reservedAzs - Define the number of AZs to reserve. This parameter is required.
      Returns:
      this

    • restrictDefaultSecurityGroup

      @Stability(Stable) public Vpc.Builder restrictDefaultSecurityGroup(Boolean restrictDefaultSecurityGroup)
      If set to true then the default inbound & outbound rules will be removed from the default security group.

      Default: true if '@aws-cdk/aws-ec2:restrictDefaultSecurityGroup' is enabled, false otherwise

      Parameters:
      restrictDefaultSecurityGroup - If set to true then the default inbound & outbound rules will be removed from the default security group. This parameter is required.
      Returns:
      this

    • subnetConfiguration

      @Stability(Stable) public Vpc.Builder subnetConfiguration(List<? extends SubnetConfiguration> subnetConfiguration)
      Configure the subnets to build for each AZ.

      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: 

       Vpc.Builder.create(this, "VPC")
         .subnetConfiguration(List.of(SubnetConfiguration.builder()
                 .cidrMask(24)
                 .name("ingress")
                 .subnetType(SubnetType.PUBLIC)
                 .build(), SubnetConfiguration.builder()
                 .cidrMask(24)
                 .name("application")
                 .subnetType(SubnetType.PRIVATE_WITH_EGRESS)
                 .build(), SubnetConfiguration.builder()
                 .cidrMask(28)
                 .name("rds")
                 .subnetType(SubnetType.PRIVATE_ISOLATED)
                 .build()))
         .build();

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

      Parameters:
      subnetConfiguration - Configure the subnets to build for each AZ. This parameter is required.
      Returns:
      this

    • vpcName

      @Stability(Stable) public Vpc.Builder vpcName(String vpcName)
      The VPC name.

      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

      Parameters:
      vpcName - The VPC name. This parameter is required.
      Returns:
      this

    • vpnConnections

      @Stability(Stable) public Vpc.Builder vpnConnections(Map<String,? extends VpnConnectionOptions> vpnConnections)
      VPN connections to this VPC.

      Default: - No connections.

      Parameters:
      vpnConnections - VPN connections to this VPC. This parameter is required.
      Returns:
      this

    • vpnGateway

      @Stability(Stable) public Vpc.Builder vpnGateway(Boolean vpnGateway)
      Indicates whether a VPN gateway should be created and attached to this VPC.

      Default: - true when vpnGatewayAsn or vpnConnections is specified

      Parameters:
      vpnGateway - Indicates whether a VPN gateway should be created and attached to this VPC. This parameter is required.
      Returns:
      this

    • vpnGatewayAsn

      @Stability(Stable) public Vpc.Builder vpnGatewayAsn(Number vpnGatewayAsn)
      The private Autonomous System Number (ASN) for the VPN gateway.

      Default: - Amazon default ASN.

      Parameters:
      vpnGatewayAsn - The private Autonomous System Number (ASN) for the VPN gateway. This parameter is required.
      Returns:
      this

    • vpnRoutePropagation

      @Stability(Stable) public Vpc.Builder vpnRoutePropagation(List<? extends SubnetSelection> vpnRoutePropagation)
      Where to propagate VPN routes.

      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.

      Parameters:
      vpnRoutePropagation - Where to propagate VPN routes. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public Vpc build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Vpc>
      Returns:
      a newly built instance of Vpc.