@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
128 lines (127 loc) • 8.58 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Specifies a virtual private cloud (VPC).
* To add an IPv6 CIDR block to the VPC, see [AWS::EC2::VPCCidrBlock](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html).
* For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.
*/
export declare class Vpc extends pulumi.CustomResource {
/**
* Get an existing Vpc resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Vpc;
/**
* Returns true if the given object is an instance of Vpc. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Vpc;
/**
* 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``.
* You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
*/
readonly cidrBlock: pulumi.Output<string | undefined>;
/**
* The association IDs of the IPv4 CIDR blocks for the VPC. For example, [ vpc-cidr-assoc-0280ab6b ].
*/
readonly cidrBlockAssociations: pulumi.Output<string[]>;
/**
* The ID of the default network ACL for the VPC. For example, acl-814dafe3.
*/
readonly defaultNetworkAcl: pulumi.Output<string>;
/**
* The ID of the default security group for the VPC. For example, sg-b178e0d3.
*/
readonly defaultSecurityGroup: pulumi.Output<string>;
/**
* Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
* You can only enable DNS hostnames if you've enabled DNS support.
*/
readonly enableDnsHostnames: pulumi.Output<boolean | undefined>;
/**
* Indicates whether the DNS resolution is supported for the VPC. If enabled, 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 network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
*/
readonly enableDnsSupport: pulumi.Output<boolean | undefined>;
/**
* The allowed tenancy of instances launched into the VPC.
* + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.
* + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.
*
* Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.
*/
readonly instanceTenancy: pulumi.Output<string | undefined>;
/**
* The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
* You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
*/
readonly ipv4IpamPoolId: pulumi.Output<string | undefined>;
/**
* 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?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
*/
readonly ipv4NetmaskLength: pulumi.Output<number | undefined>;
/**
* The IPv6 CIDR blocks for the VPC. For example, [ 2001:db8:1234:1a00::/56 ].
*/
readonly ipv6CidrBlocks: pulumi.Output<string[]>;
/**
* The tags for the VPC.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The ID of the VPC.
*/
readonly vpcId: pulumi.Output<string>;
/**
* Create a Vpc resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: VpcArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Vpc resource.
*/
export interface VpcArgs {
/**
* 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``.
* You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
*/
cidrBlock?: pulumi.Input<string>;
/**
* Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
* You can only enable DNS hostnames if you've enabled DNS support.
*/
enableDnsHostnames?: pulumi.Input<boolean>;
/**
* Indicates whether the DNS resolution is supported for the VPC. If enabled, 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 network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
*/
enableDnsSupport?: pulumi.Input<boolean>;
/**
* The allowed tenancy of instances launched into the VPC.
* + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.
* + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.
*
* Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.
*/
instanceTenancy?: pulumi.Input<string>;
/**
* The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
* You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
*/
ipv4IpamPoolId?: pulumi.Input<string>;
/**
* 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?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
*/
ipv4NetmaskLength?: pulumi.Input<number>;
/**
* The tags for the VPC.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}