1. Packages
  2. AWSx (Pulumi Crosswalk for AWS)
  3. API Docs
  4. ec2
  5. DefaultVpc
AWSx (Pulumi Crosswalk for AWS) v2.16.0 published on Wednesday, Sep 25, 2024 by Pulumi

awsx.ec2.DefaultVpc

Explore with Pulumi AI

awsx logo
AWSx (Pulumi Crosswalk for AWS) v2.16.0 published on Wednesday, Sep 25, 2024 by Pulumi

    Pseudo resource representing the default VPC and associated subnets for an account and region. This does not create any resources. This will be replaced with getDefaultVpc in the future.

    Create DefaultVpc Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DefaultVpc(name: string, args?: DefaultVpcArgs, opts?: CustomResourceOptions);
    @overload
    def DefaultVpc(resource_name: str,
                   args: Optional[DefaultVpcArgs] = None,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DefaultVpc(resource_name: str,
                   opts: Optional[ResourceOptions] = None)
    func NewDefaultVpc(ctx *Context, name string, args *DefaultVpcArgs, opts ...ResourceOption) (*DefaultVpc, error)
    public DefaultVpc(string name, DefaultVpcArgs? args = null, CustomResourceOptions? opts = null)
    public DefaultVpc(String name, DefaultVpcArgs args)
    public DefaultVpc(String name, DefaultVpcArgs args, CustomResourceOptions options)
    
    type: awsx:ec2:DefaultVpc
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DefaultVpcArgs
    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 DefaultVpcArgs
    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 DefaultVpcArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DefaultVpcArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DefaultVpcArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var defaultVpcResource = new Awsx.Ec2.DefaultVpc("defaultVpcResource");
    
    example, err := ec2.NewDefaultVpc(ctx, "defaultVpcResource", nil)
    
    var defaultVpcResource = new DefaultVpc("defaultVpcResource");
    
    default_vpc_resource = awsx.ec2.DefaultVpc("defaultVpcResource")
    
    const defaultVpcResource = new awsx.ec2.DefaultVpc("defaultVpcResource", {});
    
    type: awsx:ec2:DefaultVpc
    properties: {}
    

    DefaultVpc 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 DefaultVpc resource accepts the following input properties:

    Outputs

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

    PrivateSubnetIds List<string>
    PublicSubnetIds List<string>
    VpcId string
    The VPC ID for the default VPC
    PrivateSubnetIds []string
    PublicSubnetIds []string
    VpcId string
    The VPC ID for the default VPC
    privateSubnetIds List<String>
    publicSubnetIds List<String>
    vpcId String
    The VPC ID for the default VPC
    privateSubnetIds string[]
    publicSubnetIds string[]
    vpcId string
    The VPC ID for the default VPC
    private_subnet_ids Sequence[str]
    public_subnet_ids Sequence[str]
    vpc_id str
    The VPC ID for the default VPC
    privateSubnetIds List<String>
    publicSubnetIds List<String>
    vpcId String
    The VPC ID for the default VPC

    Package Details

    Repository
    AWSx (Pulumi Crosswalk for AWS) pulumi/pulumi-awsx
    License
    Apache-2.0
    awsx logo
    AWSx (Pulumi Crosswalk for AWS) v2.16.0 published on Wednesday, Sep 25, 2024 by Pulumi