1. Packages
  2. Timescale Provider
  3. API Docs
  4. Vpcs
timescale 1.15.0 published on Friday, Feb 21, 2025 by timescale

timescale.Vpcs

Explore with Pulumi AI

Schema for a VPC. Import can be done using your VPCs name

Create Vpcs Resource

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

Constructor syntax

new Vpcs(name: string, args: VpcsArgs, opts?: CustomResourceOptions);
@overload
def Vpcs(resource_name: str,
         args: VpcsArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Vpcs(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         cidr: Optional[str] = None,
         region_code: Optional[str] = None,
         name: Optional[str] = None,
         timeouts: Optional[VpcsTimeoutsArgs] = None)
func NewVpcs(ctx *Context, name string, args VpcsArgs, opts ...ResourceOption) (*Vpcs, error)
public Vpcs(string name, VpcsArgs args, CustomResourceOptions? opts = null)
public Vpcs(String name, VpcsArgs args)
public Vpcs(String name, VpcsArgs args, CustomResourceOptions options)
type: timescale:Vpcs
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VpcsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VpcsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VpcsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VpcsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VpcsArgs
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 vpcsResource = new Timescale.Vpcs("vpcsResource", new()
{
    Cidr = "string",
    RegionCode = "string",
    Name = "string",
    Timeouts = new Timescale.Inputs.VpcsTimeoutsArgs
    {
        Create = "string",
    },
});
Copy
example, err := timescale.NewVpcs(ctx, "vpcsResource", &timescale.VpcsArgs{
Cidr: pulumi.String("string"),
RegionCode: pulumi.String("string"),
Name: pulumi.String("string"),
Timeouts: &.VpcsTimeoutsArgs{
Create: pulumi.String("string"),
},
})
Copy
var vpcsResource = new Vpcs("vpcsResource", VpcsArgs.builder()
    .cidr("string")
    .regionCode("string")
    .name("string")
    .timeouts(VpcsTimeoutsArgs.builder()
        .create("string")
        .build())
    .build());
Copy
vpcs_resource = timescale.Vpcs("vpcsResource",
    cidr="string",
    region_code="string",
    name="string",
    timeouts={
        "create": "string",
    })
Copy
const vpcsResource = new timescale.Vpcs("vpcsResource", {
    cidr: "string",
    regionCode: "string",
    name: "string",
    timeouts: {
        create: "string",
    },
});
Copy
type: timescale:Vpcs
properties:
    cidr: string
    name: string
    regionCode: string
    timeouts:
        create: string
Copy

Vpcs Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Vpcs resource accepts the following input properties:

Cidr This property is required. string
The IPv4 CIDR block
RegionCode This property is required. string
The region for this VPC.
Name string
VPC Name is the configurable name assigned to this vpc. If none is provided, a default will be generated by the provider.
Timeouts VpcsTimeouts
Cidr This property is required. string
The IPv4 CIDR block
RegionCode This property is required. string
The region for this VPC.
Name string
VPC Name is the configurable name assigned to this vpc. If none is provided, a default will be generated by the provider.
Timeouts VpcsTimeoutsArgs
cidr This property is required. String
The IPv4 CIDR block
regionCode This property is required. String
The region for this VPC.
name String
VPC Name is the configurable name assigned to this vpc. If none is provided, a default will be generated by the provider.
timeouts VpcsTimeouts
cidr This property is required. string
The IPv4 CIDR block
regionCode This property is required. string
The region for this VPC.
name string
VPC Name is the configurable name assigned to this vpc. If none is provided, a default will be generated by the provider.
timeouts VpcsTimeouts
cidr This property is required. str
The IPv4 CIDR block
region_code This property is required. str
The region for this VPC.
name str
VPC Name is the configurable name assigned to this vpc. If none is provided, a default will be generated by the provider.
timeouts VpcsTimeoutsArgs
cidr This property is required. String
The IPv4 CIDR block
regionCode This property is required. String
The region for this VPC.
name String
VPC Name is the configurable name assigned to this vpc. If none is provided, a default will be generated by the provider.
timeouts Property Map

Outputs

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

Created string
ErrorMessage string
Id string
The provider-assigned unique ID for this managed resource.
ProjectId string
ProvisionedId string
Status string
Updated string
VpcsId double
The ID of this resource.
Created string
ErrorMessage string
Id string
The provider-assigned unique ID for this managed resource.
ProjectId string
ProvisionedId string
Status string
Updated string
VpcsId float64
The ID of this resource.
created String
errorMessage String
id String
The provider-assigned unique ID for this managed resource.
projectId String
provisionedId String
status String
updated String
vpcsId Double
The ID of this resource.
created string
errorMessage string
id string
The provider-assigned unique ID for this managed resource.
projectId string
provisionedId string
status string
updated string
vpcsId number
The ID of this resource.
created str
error_message str
id str
The provider-assigned unique ID for this managed resource.
project_id str
provisioned_id str
status str
updated str
vpcs_id float
The ID of this resource.
created String
errorMessage String
id String
The provider-assigned unique ID for this managed resource.
projectId String
provisionedId String
status String
updated String
vpcsId Number
The ID of this resource.

Look up Existing Vpcs Resource

Get an existing Vpcs resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VpcsState, opts?: CustomResourceOptions): Vpcs
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cidr: Optional[str] = None,
        created: Optional[str] = None,
        error_message: Optional[str] = None,
        name: Optional[str] = None,
        project_id: Optional[str] = None,
        provisioned_id: Optional[str] = None,
        region_code: Optional[str] = None,
        status: Optional[str] = None,
        timeouts: Optional[VpcsTimeoutsArgs] = None,
        updated: Optional[str] = None,
        vpcs_id: Optional[float] = None) -> Vpcs
func GetVpcs(ctx *Context, name string, id IDInput, state *VpcsState, opts ...ResourceOption) (*Vpcs, error)
public static Vpcs Get(string name, Input<string> id, VpcsState? state, CustomResourceOptions? opts = null)
public static Vpcs get(String name, Output<String> id, VpcsState state, CustomResourceOptions options)
resources:  _:    type: timescale:Vpcs    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Cidr string
The IPv4 CIDR block
Created string
ErrorMessage string
Name string
VPC Name is the configurable name assigned to this vpc. If none is provided, a default will be generated by the provider.
ProjectId string
ProvisionedId string
RegionCode string
The region for this VPC.
Status string
Timeouts VpcsTimeouts
Updated string
VpcsId double
The ID of this resource.
Cidr string
The IPv4 CIDR block
Created string
ErrorMessage string
Name string
VPC Name is the configurable name assigned to this vpc. If none is provided, a default will be generated by the provider.
ProjectId string
ProvisionedId string
RegionCode string
The region for this VPC.
Status string
Timeouts VpcsTimeoutsArgs
Updated string
VpcsId float64
The ID of this resource.
cidr String
The IPv4 CIDR block
created String
errorMessage String
name String
VPC Name is the configurable name assigned to this vpc. If none is provided, a default will be generated by the provider.
projectId String
provisionedId String
regionCode String
The region for this VPC.
status String
timeouts VpcsTimeouts
updated String
vpcsId Double
The ID of this resource.
cidr string
The IPv4 CIDR block
created string
errorMessage string
name string
VPC Name is the configurable name assigned to this vpc. If none is provided, a default will be generated by the provider.
projectId string
provisionedId string
regionCode string
The region for this VPC.
status string
timeouts VpcsTimeouts
updated string
vpcsId number
The ID of this resource.
cidr str
The IPv4 CIDR block
created str
error_message str
name str
VPC Name is the configurable name assigned to this vpc. If none is provided, a default will be generated by the provider.
project_id str
provisioned_id str
region_code str
The region for this VPC.
status str
timeouts VpcsTimeoutsArgs
updated str
vpcs_id float
The ID of this resource.
cidr String
The IPv4 CIDR block
created String
errorMessage String
name String
VPC Name is the configurable name assigned to this vpc. If none is provided, a default will be generated by the provider.
projectId String
provisionedId String
regionCode String
The region for this VPC.
status String
timeouts Property Map
updated String
vpcsId Number
The ID of this resource.

Supporting Types

VpcsTimeouts
, VpcsTimeoutsArgs

Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Package Details

Repository
timescale timescale/terraform-provider-timescale
License
Notes
This Pulumi package is based on the timescale Terraform Provider.