AWS QuickStart VPC v0.0.2, Oct 15 21

aws-quickstart-vpc.Vpc

Create Vpc Resource

new Vpc(name: string, args: VpcArgs, opts?: CustomResourceOptions);

@overload
def Vpc(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        availability_zone_config: Optional[Sequence[AvailabilityZoneArgs]] = None,
        cidr_block: Optional[str] = None,
        create_additional_private_subnets: Optional[bool] = None,
        create_flow_logs: Optional[bool] = None,
        create_nat_gateways: Optional[bool] = None,
        create_private_subnets: Optional[bool] = None,
        create_public_subnets: Optional[bool] = None,
        enable_dns_hostnames: Optional[bool] = None,
        enable_dns_support: Optional[bool] = None,
        flow_logs_log_format: Optional[str] = None,
        flow_logs_max_aggregation_interval: Optional[float] = None,
        flow_logs_retention_period_in_days: Optional[float] = None,
        flow_logs_traffic_type: Optional[str] = None,
        instance_tenancy: Optional[str] = None)
@overload
def Vpc(resource_name: str,
        args: VpcArgs,
        opts: Optional[ResourceOptions] = None)

func NewVpc(ctx *Context, name string, args VpcArgs, opts ...ResourceOption) (*Vpc, error)

public Vpc(string name, VpcArgs args, CustomResourceOptions? opts = null)

public Vpc(String name, VpcArgs args)
public Vpc(String name, VpcArgs args, CustomResourceOptions options)

type: aws-quickstart-vpc:Vpc
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VpcArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args VpcArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VpcArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VpcArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args VpcArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Vpc Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Vpc resource accepts the following input properties:

AvailabilityZoneConfig List<Pulumi.AwsQuickStartVpc.Inputs.AvailabilityZoneArgs>: The list of Configurations in which to create subnets. You can specify availability zone with a private or a public subnet cidr block. You can also associated a private subnet with a dedicated network ACL.
CidrBlock string: CIDR block for the VPC
CreateAdditionalPrivateSubnets bool: Set to true to create a network ACL protected subnet in each Availability Zone. If false, the CIDR parameters for those subnets will be ignored. If true, it also requires that the 'Create private subnets' parameter is also true to have any effect. Default is true
CreateFlowLogs bool: Enable Flow Logs to capture IP traffic for the VPC. Defaults to true
CreateNatGateways bool: Set to false when creating only private subnets. If true, both CreatePublicSubnets and CreatePrivateSubnets must also be true. Default is true
CreatePrivateSubnets bool: Set to false to create only public subnets. If false, the CIDR parameters for ALL private subnets will be ignored. Default is true.
CreatePublicSubnets bool: Set to false to create only private subnets. If false, CreatePrivateSubnets must be true and the CIDR parameters for ALL public subnets will be ignored. Default is true
EnableDnsHostnames bool: A boolean flag to enable/disable DNS hostnames in the VPC. Defaults false.
EnableDnsSupport bool: A boolean flag to enable/disable DNS support in the VPC. Defaults true.
FlowLogsLogFormat string: The fields to include in the flow log record, in the order in which they should appear. Specify the fields using the ${field-id} format, separated by spaces. Default is ${version} ${account-id} ${interface-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${packets} ${bytes} ${start} ${end} ${action} ${log-status}
FlowLogsMaxAggregationInterval double: The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). Default is 600
FlowLogsRetentionPeriodInDays double: Number of days to retain the VPC Flow Logs in CloudWatch. Defaults to 14.
FlowLogsTrafficType string: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. Default is REJECT.
InstanceTenancy string: The allowed tenancy of instances launched into the VPC. Defaults to default.

AvailabilityZoneConfig []AvailabilityZoneArgs: The list of Configurations in which to create subnets. You can specify availability zone with a private or a public subnet cidr block. You can also associated a private subnet with a dedicated network ACL.
CidrBlock string: CIDR block for the VPC
CreateAdditionalPrivateSubnets bool: Set to true to create a network ACL protected subnet in each Availability Zone. If false, the CIDR parameters for those subnets will be ignored. If true, it also requires that the 'Create private subnets' parameter is also true to have any effect. Default is true
CreateFlowLogs bool: Enable Flow Logs to capture IP traffic for the VPC. Defaults to true
CreateNatGateways bool: Set to false when creating only private subnets. If true, both CreatePublicSubnets and CreatePrivateSubnets must also be true. Default is true
CreatePrivateSubnets bool: Set to false to create only public subnets. If false, the CIDR parameters for ALL private subnets will be ignored. Default is true.
CreatePublicSubnets bool: Set to false to create only private subnets. If false, CreatePrivateSubnets must be true and the CIDR parameters for ALL public subnets will be ignored. Default is true
EnableDnsHostnames bool: A boolean flag to enable/disable DNS hostnames in the VPC. Defaults false.
EnableDnsSupport bool: A boolean flag to enable/disable DNS support in the VPC. Defaults true.
FlowLogsLogFormat string: The fields to include in the flow log record, in the order in which they should appear. Specify the fields using the ${field-id} format, separated by spaces. Default is ${version} ${account-id} ${interface-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${packets} ${bytes} ${start} ${end} ${action} ${log-status}
FlowLogsMaxAggregationInterval float64: The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). Default is 600
FlowLogsRetentionPeriodInDays float64: Number of days to retain the VPC Flow Logs in CloudWatch. Defaults to 14.
FlowLogsTrafficType string: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. Default is REJECT.
InstanceTenancy string: The allowed tenancy of instances launched into the VPC. Defaults to default.

availabilityZoneConfig List<AvailabilityZoneArgs>: The list of Configurations in which to create subnets. You can specify availability zone with a private or a public subnet cidr block. You can also associated a private subnet with a dedicated network ACL.
cidrBlock String: CIDR block for the VPC
createAdditionalPrivateSubnets Boolean: Set to true to create a network ACL protected subnet in each Availability Zone. If false, the CIDR parameters for those subnets will be ignored. If true, it also requires that the 'Create private subnets' parameter is also true to have any effect. Default is true
createFlowLogs Boolean: Enable Flow Logs to capture IP traffic for the VPC. Defaults to true
createNatGateways Boolean: Set to false when creating only private subnets. If true, both CreatePublicSubnets and CreatePrivateSubnets must also be true. Default is true
createPrivateSubnets Boolean: Set to false to create only public subnets. If false, the CIDR parameters for ALL private subnets will be ignored. Default is true.
createPublicSubnets Boolean: Set to false to create only private subnets. If false, CreatePrivateSubnets must be true and the CIDR parameters for ALL public subnets will be ignored. Default is true
enableDnsHostnames Boolean: A boolean flag to enable/disable DNS hostnames in the VPC. Defaults false.
enableDnsSupport Boolean: A boolean flag to enable/disable DNS support in the VPC. Defaults true.
flowLogsLogFormat String: The fields to include in the flow log record, in the order in which they should appear. Specify the fields using the ${field-id} format, separated by spaces. Default is ${version} ${account-id} ${interface-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${packets} ${bytes} ${start} ${end} ${action} ${log-status}
flowLogsMaxAggregationInterval Double: The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). Default is 600
flowLogsRetentionPeriodInDays Double: Number of days to retain the VPC Flow Logs in CloudWatch. Defaults to 14.
flowLogsTrafficType String: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. Default is REJECT.
instanceTenancy String: The allowed tenancy of instances launched into the VPC. Defaults to default.

availabilityZoneConfig AvailabilityZoneArgs[]: The list of Configurations in which to create subnets. You can specify availability zone with a private or a public subnet cidr block. You can also associated a private subnet with a dedicated network ACL.
cidrBlock string: CIDR block for the VPC
createAdditionalPrivateSubnets boolean: Set to true to create a network ACL protected subnet in each Availability Zone. If false, the CIDR parameters for those subnets will be ignored. If true, it also requires that the 'Create private subnets' parameter is also true to have any effect. Default is true
createFlowLogs boolean: Enable Flow Logs to capture IP traffic for the VPC. Defaults to true
createNatGateways boolean: Set to false when creating only private subnets. If true, both CreatePublicSubnets and CreatePrivateSubnets must also be true. Default is true
createPrivateSubnets boolean: Set to false to create only public subnets. If false, the CIDR parameters for ALL private subnets will be ignored. Default is true.
createPublicSubnets boolean: Set to false to create only private subnets. If false, CreatePrivateSubnets must be true and the CIDR parameters for ALL public subnets will be ignored. Default is true
enableDnsHostnames boolean: A boolean flag to enable/disable DNS hostnames in the VPC. Defaults false.
enableDnsSupport boolean: A boolean flag to enable/disable DNS support in the VPC. Defaults true.
flowLogsLogFormat string: The fields to include in the flow log record, in the order in which they should appear. Specify the fields using the ${field-id} format, separated by spaces. Default is ${version} ${account-id} ${interface-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${packets} ${bytes} ${start} ${end} ${action} ${log-status}
flowLogsMaxAggregationInterval number: The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). Default is 600
flowLogsRetentionPeriodInDays number: Number of days to retain the VPC Flow Logs in CloudWatch. Defaults to 14.
flowLogsTrafficType string: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. Default is REJECT.
instanceTenancy string: The allowed tenancy of instances launched into the VPC. Defaults to default.

availability_zone_config Sequence[AvailabilityZoneArgs]: The list of Configurations in which to create subnets. You can specify availability zone with a private or a public subnet cidr block. You can also associated a private subnet with a dedicated network ACL.
cidr_block str: CIDR block for the VPC
create_additional_private_subnets bool: Set to true to create a network ACL protected subnet in each Availability Zone. If false, the CIDR parameters for those subnets will be ignored. If true, it also requires that the 'Create private subnets' parameter is also true to have any effect. Default is true
create_flow_logs bool: Enable Flow Logs to capture IP traffic for the VPC. Defaults to true
create_nat_gateways bool: Set to false when creating only private subnets. If true, both CreatePublicSubnets and CreatePrivateSubnets must also be true. Default is true
create_private_subnets bool: Set to false to create only public subnets. If false, the CIDR parameters for ALL private subnets will be ignored. Default is true.
create_public_subnets bool: Set to false to create only private subnets. If false, CreatePrivateSubnets must be true and the CIDR parameters for ALL public subnets will be ignored. Default is true
enable_dns_hostnames bool: A boolean flag to enable/disable DNS hostnames in the VPC. Defaults false.
enable_dns_support bool: A boolean flag to enable/disable DNS support in the VPC. Defaults true.
flow_logs_log_format str: The fields to include in the flow log record, in the order in which they should appear. Specify the fields using the ${field-id} format, separated by spaces. Default is ${version} ${account-id} ${interface-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${packets} ${bytes} ${start} ${end} ${action} ${log-status}
flow_logs_max_aggregation_interval float: The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). Default is 600
flow_logs_retention_period_in_days float: Number of days to retain the VPC Flow Logs in CloudWatch. Defaults to 14.
flow_logs_traffic_type str: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. Default is REJECT.
instance_tenancy str: The allowed tenancy of instances launched into the VPC. Defaults to default.

availabilityZoneConfig List<Property Map>: The list of Configurations in which to create subnets. You can specify availability zone with a private or a public subnet cidr block. You can also associated a private subnet with a dedicated network ACL.
cidrBlock String: CIDR block for the VPC
createAdditionalPrivateSubnets Boolean: Set to true to create a network ACL protected subnet in each Availability Zone. If false, the CIDR parameters for those subnets will be ignored. If true, it also requires that the 'Create private subnets' parameter is also true to have any effect. Default is true
createFlowLogs Boolean: Enable Flow Logs to capture IP traffic for the VPC. Defaults to true
createNatGateways Boolean: Set to false when creating only private subnets. If true, both CreatePublicSubnets and CreatePrivateSubnets must also be true. Default is true
createPrivateSubnets Boolean: Set to false to create only public subnets. If false, the CIDR parameters for ALL private subnets will be ignored. Default is true.
createPublicSubnets Boolean: Set to false to create only private subnets. If false, CreatePrivateSubnets must be true and the CIDR parameters for ALL public subnets will be ignored. Default is true
enableDnsHostnames Boolean: A boolean flag to enable/disable DNS hostnames in the VPC. Defaults false.
enableDnsSupport Boolean: A boolean flag to enable/disable DNS support in the VPC. Defaults true.
flowLogsLogFormat String: The fields to include in the flow log record, in the order in which they should appear. Specify the fields using the ${field-id} format, separated by spaces. Default is ${version} ${account-id} ${interface-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${packets} ${bytes} ${start} ${end} ${action} ${log-status}
flowLogsMaxAggregationInterval Number: The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). Default is 600
flowLogsRetentionPeriodInDays Number: Number of days to retain the VPC Flow Logs in CloudWatch. Defaults to 14.
flowLogsTrafficType String: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. Default is REJECT.
instanceTenancy String: The allowed tenancy of instances launched into the VPC. Defaults to default.

Outputs

All input properties are implicitly available as output properties. Additionally, the Vpc resource produces the following output properties:

VpcID string: The VPC ID
NatGatewayIPs List<string>: The IPs of the EIPs associated with the Nat Gateways
PrivateSubnetIDs List<string>: The IDs of the Private Subnets Created
PublicSubnetIDs List<string>: The IDs of the Public Subnets Created

VpcID string: The VPC ID
NatGatewayIPs []string: The IPs of the EIPs associated with the Nat Gateways
PrivateSubnetIDs []string: The IDs of the Private Subnets Created
PublicSubnetIDs []string: The IDs of the Public Subnets Created

vpcID String: The VPC ID
natGatewayIPs List<String>: The IPs of the EIPs associated with the Nat Gateways
privateSubnetIDs List<String>: The IDs of the Private Subnets Created
publicSubnetIDs List<String>: The IDs of the Public Subnets Created

vpcID string: The VPC ID
natGatewayIPs string[]: The IPs of the EIPs associated with the Nat Gateways
privateSubnetIDs string[]: The IDs of the Private Subnets Created
publicSubnetIDs string[]: The IDs of the Public Subnets Created

vpc_id str: The VPC ID
nat_gateway_ips Sequence[str]: The IPs of the EIPs associated with the Nat Gateways
private_subnet_ids Sequence[str]: The IDs of the Private Subnets Created
public_subnet_ids Sequence[str]: The IDs of the Public Subnets Created

vpcID String: The VPC ID
natGatewayIPs List<String>: The IPs of the EIPs associated with the Nat Gateways
privateSubnetIDs List<String>: The IDs of the Private Subnets Created
publicSubnetIDs List<String>: The IDs of the Public Subnets Created

Supporting Types

AvailabilityZone

AvailabilityZone string: The availability zone name to deploy the subnet into
PrivateSubnetACidr string: CIDR block for a private subnet located in the specified availability zone
PrivateSubnetBCidr string: CIDR block for the associated private subnet (2) with a dedicated network ACL located in the specified availability zone. This subnet will only be created if CreateAdditionalPrivateSubnets is true.
PublicSubnetCidr string: CIDR block for the public subnet located in the specified availability zone

AvailabilityZone string: The availability zone name to deploy the subnet into
PrivateSubnetACidr string: CIDR block for a private subnet located in the specified availability zone
PrivateSubnetBCidr string: CIDR block for the associated private subnet (2) with a dedicated network ACL located in the specified availability zone. This subnet will only be created if CreateAdditionalPrivateSubnets is true.
PublicSubnetCidr string: CIDR block for the public subnet located in the specified availability zone

availabilityZone String: The availability zone name to deploy the subnet into
privateSubnetACidr String: CIDR block for a private subnet located in the specified availability zone
privateSubnetBCidr String: CIDR block for the associated private subnet (2) with a dedicated network ACL located in the specified availability zone. This subnet will only be created if CreateAdditionalPrivateSubnets is true.
publicSubnetCidr String: CIDR block for the public subnet located in the specified availability zone

availabilityZone string: The availability zone name to deploy the subnet into
privateSubnetACidr string: CIDR block for a private subnet located in the specified availability zone
privateSubnetBCidr string: CIDR block for the associated private subnet (2) with a dedicated network ACL located in the specified availability zone. This subnet will only be created if CreateAdditionalPrivateSubnets is true.
publicSubnetCidr string: CIDR block for the public subnet located in the specified availability zone

availability_zone str: The availability zone name to deploy the subnet into
private_subnet_a_cidr str: CIDR block for a private subnet located in the specified availability zone
private_subnet_b_cidr str: CIDR block for the associated private subnet (2) with a dedicated network ACL located in the specified availability zone. This subnet will only be created if CreateAdditionalPrivateSubnets is true.
public_subnet_cidr str: CIDR block for the public subnet located in the specified availability zone

availabilityZone String: The availability zone name to deploy the subnet into
privateSubnetACidr String: CIDR block for a private subnet located in the specified availability zone
privateSubnetBCidr String: CIDR block for the associated private subnet (2) with a dedicated network ACL located in the specified availability zone. This subnet will only be created if CreateAdditionalPrivateSubnets is true.
publicSubnetCidr String: CIDR block for the public subnet located in the specified availability zone

Package Details

Repository: AWS QuickStart VPC
License