Creates a VPC with the specified CIDR blocks¶

Description¶

Creates a VPC with the specified CIDR blocks.

A VPC must have an associated IPv4 CIDR block. You can choose an IPv4 CIDR block or an IPAM-allocated IPv4 CIDR block. You can optionally associate an IPv6 CIDR block with a VPC. You can choose an IPv6 CIDR block, an Amazon-provided IPv6 CIDR block, an IPAM-allocated IPv6 CIDR block, or an IPv6 CIDR block that you brought to Amazon Web Services. For more information, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.

By default, each instance that you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP option sets in the Amazon VPC User Guide.

You can specify DNS options and tenancy for a VPC when you create it. You can't change the tenancy of a VPC after you create it. For more information, see VPC configuration options in the Amazon VPC User Guide.

Usage¶

ec2_create_vpc(CidrBlock, Ipv6Pool, Ipv6CidrBlock, Ipv4IpamPoolId,
  Ipv4NetmaskLength, Ipv6IpamPoolId, Ipv6NetmaskLength,
  Ipv6CidrBlockNetworkBorderGroup, VpcEncryptionControl,
  TagSpecifications, DryRun, InstanceTenancy, AmazonProvidedIpv6CidrBlock)

Arguments¶

CidrBlock

The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
Ipv6Pool

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
Ipv6CidrBlock

The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
Ipv4IpamPoolId

The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
Ipv4NetmaskLength

The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
Ipv6IpamPoolId

The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
Ipv6NetmaskLength

The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
Ipv6CidrBlockNetworkBorderGroup

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
VpcEncryptionControl

Specifies the encryption control configuration to apply to the VPC during creation. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements.

For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
TagSpecifications

The tags to assign to the VPC.
DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
InstanceTenancy

The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default
AmazonProvidedIpv6CidrBlock

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.

Value¶

A list with the following syntax:

list(
  Vpc = list(
    OwnerId = "string",
    InstanceTenancy = "default"|"dedicated"|"host",
    Ipv6CidrBlockAssociationSet = list(
      list(
        AssociationId = "string",
        Ipv6CidrBlock = "string",
        Ipv6CidrBlockState = list(
          State = "associating"|"associated"|"disassociating"|"disassociated"|"failing"|"failed",
          StatusMessage = "string"
        ),
        NetworkBorderGroup = "string",
        Ipv6Pool = "string",
        Ipv6AddressAttribute = "public"|"private",
        IpSource = "amazon"|"byoip"|"none"
      )
    ),
    CidrBlockAssociationSet = list(
      list(
        AssociationId = "string",
        CidrBlock = "string",
        CidrBlockState = list(
          State = "associating"|"associated"|"disassociating"|"disassociated"|"failing"|"failed",
          StatusMessage = "string"
        )
      )
    ),
    IsDefault = TRUE|FALSE,
    EncryptionControl = list(
      VpcId = "string",
      VpcEncryptionControlId = "string",
      Mode = "monitor"|"enforce",
      State = "enforce-in-progress"|"monitor-in-progress"|"enforce-failed"|"monitor-failed"|"deleting"|"deleted"|"available"|"creating"|"delete-failed",
      StateMessage = "string",
      ResourceExclusions = list(
        InternetGateway = list(
          State = "enabling"|"enabled"|"disabling"|"disabled",
          StateMessage = "string"
        ),
        EgressOnlyInternetGateway = list(
          State = "enabling"|"enabled"|"disabling"|"disabled",
          StateMessage = "string"
        ),
        NatGateway = list(
          State = "enabling"|"enabled"|"disabling"|"disabled",
          StateMessage = "string"
        ),
        VirtualPrivateGateway = list(
          State = "enabling"|"enabled"|"disabling"|"disabled",
          StateMessage = "string"
        ),
        VpcPeering = list(
          State = "enabling"|"enabled"|"disabling"|"disabled",
          StateMessage = "string"
        ),
        Lambda = list(
          State = "enabling"|"enabled"|"disabling"|"disabled",
          StateMessage = "string"
        ),
        VpcLattice = list(
          State = "enabling"|"enabled"|"disabling"|"disabled",
          StateMessage = "string"
        ),
        ElasticFileSystem = list(
          State = "enabling"|"enabled"|"disabling"|"disabled",
          StateMessage = "string"
        )
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    BlockPublicAccessStates = list(
      InternetGatewayBlockMode = "off"|"block-bidirectional"|"block-ingress"
    ),
    VpcId = "string",
    State = "pending"|"available"|"deleting",
    CidrBlock = "string",
    DhcpOptionsId = "string"
  )
)

Request syntax¶

svc$create_vpc(
  CidrBlock = "string",
  Ipv6Pool = "string",
  Ipv6CidrBlock = "string",
  Ipv4IpamPoolId = "string",
  Ipv4NetmaskLength = 123,
  Ipv6IpamPoolId = "string",
  Ipv6NetmaskLength = 123,
  Ipv6CidrBlockNetworkBorderGroup = "string",
  VpcEncryptionControl = list(
    Mode = "monitor"|"enforce",
    InternetGatewayExclusion = "enable"|"disable",
    EgressOnlyInternetGatewayExclusion = "enable"|"disable",
    NatGatewayExclusion = "enable"|"disable",
    VirtualPrivateGatewayExclusion = "enable"|"disable",
    VpcPeeringExclusion = "enable"|"disable",
    LambdaExclusion = "enable"|"disable",
    VpcLatticeExclusion = "enable"|"disable",
    ElasticFileSystemExclusion = "enable"|"disable"
  ),
  TagSpecifications = list(
    list(
      ResourceType = "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"declarative-policies-report"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"image-usage-report"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"outpost-lag"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"service-link-virtual-interface"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-metering-policy"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"vpc-encryption-control"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token"|"capacity-block"|"mac-modification-task"|"ipam-prefix-list-resolver"|"ipam-policy"|"ipam-prefix-list-resolver-target"|"ipam-internet-registry-association"|"secondary-interface"|"secondary-network"|"secondary-subnet"|"capacity-manager-data-export"|"vpn-concentrator"|"ipam-pool-allocation"|"capacity-reservation-cancellation-quote"|"application-status-check"|"capacity-reservation-modification-quote",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  DryRun = TRUE|FALSE,
  InstanceTenancy = "default"|"dedicated"|"host",
  AmazonProvidedIpv6CidrBlock = TRUE|FALSE
)

Examples¶

# This example creates a VPC with the specified CIDR block.
svc$create_vpc(
  CidrBlock = "10.0.0.0/16"
)