timescale 1.15.0, Feb 21 25

timescale 1.15.0 published on Friday, Feb 21, 2025 by timescale

timescale.PeeringConnection

Explore with Pulumi AI

timescale 1.15.0 published on Friday, Feb 21, 2025 by timescale

Create PeeringConnection Resource

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

Constructor syntax

new PeeringConnection(name: string, args: PeeringConnectionArgs, opts?: CustomResourceOptions);

@overload
def PeeringConnection(resource_name: str,
                      args: PeeringConnectionArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def PeeringConnection(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      peer_account_id: Optional[str] = None,
                      peer_region_code: Optional[str] = None,
                      peer_vpc_id: Optional[str] = None,
                      timescale_vpc_id: Optional[float] = None)

func NewPeeringConnection(ctx *Context, name string, args PeeringConnectionArgs, opts ...ResourceOption) (*PeeringConnection, error)

public PeeringConnection(string name, PeeringConnectionArgs args, CustomResourceOptions? opts = null)

public PeeringConnection(String name, PeeringConnectionArgs args)
public PeeringConnection(String name, PeeringConnectionArgs args, CustomResourceOptions options)

type: timescale:PeeringConnection
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 PeeringConnectionArgs: 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 PeeringConnectionArgs: 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 PeeringConnectionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args PeeringConnectionArgs: 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 peeringConnectionResource = new Timescale.PeeringConnection("peeringConnectionResource", new()
{
    PeerAccountId = "string",
    PeerRegionCode = "string",
    PeerVpcId = "string",
    TimescaleVpcId = 0,
});

example, err := timescale.NewPeeringConnection(ctx, "peeringConnectionResource", &timescale.PeeringConnectionArgs{
PeerAccountId: pulumi.String("string"),
PeerRegionCode: pulumi.String("string"),
PeerVpcId: pulumi.String("string"),
TimescaleVpcId: pulumi.Float64(0),
})

var peeringConnectionResource = new PeeringConnection("peeringConnectionResource", PeeringConnectionArgs.builder()
    .peerAccountId("string")
    .peerRegionCode("string")
    .peerVpcId("string")
    .timescaleVpcId(0)
    .build());

peering_connection_resource = timescale.PeeringConnection("peeringConnectionResource",
    peer_account_id="string",
    peer_region_code="string",
    peer_vpc_id="string",
    timescale_vpc_id=0)

const peeringConnectionResource = new timescale.PeeringConnection("peeringConnectionResource", {
    peerAccountId: "string",
    peerRegionCode: "string",
    peerVpcId: "string",
    timescaleVpcId: 0,
});

type: timescale:PeeringConnection
properties:
    peerAccountId: string
    peerRegionCode: string
    peerVpcId: string
    timescaleVpcId: 0

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

PeerAccountId string: AWS account ID where the VPC to be paired
PeerRegionCode string: Region code for the VPC to be paired
PeerVpcId string: AWS ID for the VPC to be paired
TimescaleVpcId double: Timescale internal ID for a vpc

PeerAccountId string: AWS account ID where the VPC to be paired
PeerRegionCode string: Region code for the VPC to be paired
PeerVpcId string: AWS ID for the VPC to be paired
TimescaleVpcId float64: Timescale internal ID for a vpc

peerAccountId String: AWS account ID where the VPC to be paired
peerRegionCode String: Region code for the VPC to be paired
peerVpcId String: AWS ID for the VPC to be paired
timescaleVpcId Double: Timescale internal ID for a vpc

peerAccountId string: AWS account ID where the VPC to be paired
peerRegionCode string: Region code for the VPC to be paired
peerVpcId string: AWS ID for the VPC to be paired
timescaleVpcId number: Timescale internal ID for a vpc

peer_account_id str: AWS account ID where the VPC to be paired
peer_region_code str: Region code for the VPC to be paired
peer_vpc_id str: AWS ID for the VPC to be paired
timescale_vpc_id float: Timescale internal ID for a vpc

peerAccountId String: AWS account ID where the VPC to be paired
peerRegionCode String: Region code for the VPC to be paired
peerVpcId String: AWS ID for the VPC to be paired
timescaleVpcId Number: Timescale internal ID for a vpc

Outputs

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

ErrorMessage string
Id string: The provider-assigned unique ID for this managed resource.
PeerCidr string: CIDR for the VPC to be paired
PeeringConnectionId double: Timescale internal ID for a peering connection
ProvisionedId string: AWS ID of the peering connection (starts with pcx-...)
Status string: Peering connection status
VpcId string: AWS VPC ID of the timescale instance VPC

ErrorMessage string
Id string: The provider-assigned unique ID for this managed resource.
PeerCidr string: CIDR for the VPC to be paired
PeeringConnectionId float64: Timescale internal ID for a peering connection
ProvisionedId string: AWS ID of the peering connection (starts with pcx-...)
Status string: Peering connection status
VpcId string: AWS VPC ID of the timescale instance VPC

errorMessage String
id String: The provider-assigned unique ID for this managed resource.
peerCidr String: CIDR for the VPC to be paired
peeringConnectionId Double: Timescale internal ID for a peering connection
provisionedId String: AWS ID of the peering connection (starts with pcx-...)
status String: Peering connection status
vpcId String: AWS VPC ID of the timescale instance VPC

errorMessage string
id string: The provider-assigned unique ID for this managed resource.
peerCidr string: CIDR for the VPC to be paired
peeringConnectionId number: Timescale internal ID for a peering connection
provisionedId string: AWS ID of the peering connection (starts with pcx-...)
status string: Peering connection status
vpcId string: AWS VPC ID of the timescale instance VPC

error_message str
id str: The provider-assigned unique ID for this managed resource.
peer_cidr str: CIDR for the VPC to be paired
peering_connection_id float: Timescale internal ID for a peering connection
provisioned_id str: AWS ID of the peering connection (starts with pcx-...)
status str: Peering connection status
vpc_id str: AWS VPC ID of the timescale instance VPC

errorMessage String
id String: The provider-assigned unique ID for this managed resource.
peerCidr String: CIDR for the VPC to be paired
peeringConnectionId Number: Timescale internal ID for a peering connection
provisionedId String: AWS ID of the peering connection (starts with pcx-...)
status String: Peering connection status
vpcId String: AWS VPC ID of the timescale instance VPC

Look up Existing PeeringConnection Resource

Get an existing PeeringConnection 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?: PeeringConnectionState, opts?: CustomResourceOptions): PeeringConnection

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        error_message: Optional[str] = None,
        peer_account_id: Optional[str] = None,
        peer_cidr: Optional[str] = None,
        peer_region_code: Optional[str] = None,
        peer_vpc_id: Optional[str] = None,
        peering_connection_id: Optional[float] = None,
        provisioned_id: Optional[str] = None,
        status: Optional[str] = None,
        timescale_vpc_id: Optional[float] = None,
        vpc_id: Optional[str] = None) -> PeeringConnection

func GetPeeringConnection(ctx *Context, name string, id IDInput, state *PeeringConnectionState, opts ...ResourceOption) (*PeeringConnection, error)

public static PeeringConnection Get(string name, Input<string> id, PeeringConnectionState? state, CustomResourceOptions? opts = null)

public static PeeringConnection get(String name, Output<String> id, PeeringConnectionState state, CustomResourceOptions options)

resources:  _:    type: timescale:PeeringConnection    get:      id: ${id}

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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:

ErrorMessage string
PeerAccountId string: AWS account ID where the VPC to be paired
PeerCidr string: CIDR for the VPC to be paired
PeerRegionCode string: Region code for the VPC to be paired
PeerVpcId string: AWS ID for the VPC to be paired
PeeringConnectionId double: Timescale internal ID for a peering connection
ProvisionedId string: AWS ID of the peering connection (starts with pcx-...)
Status string: Peering connection status
TimescaleVpcId double: Timescale internal ID for a vpc
VpcId string: AWS VPC ID of the timescale instance VPC

ErrorMessage string
PeerAccountId string: AWS account ID where the VPC to be paired
PeerCidr string: CIDR for the VPC to be paired
PeerRegionCode string: Region code for the VPC to be paired
PeerVpcId string: AWS ID for the VPC to be paired
PeeringConnectionId float64: Timescale internal ID for a peering connection
ProvisionedId string: AWS ID of the peering connection (starts with pcx-...)
Status string: Peering connection status
TimescaleVpcId float64: Timescale internal ID for a vpc
VpcId string: AWS VPC ID of the timescale instance VPC

errorMessage String
peerAccountId String: AWS account ID where the VPC to be paired
peerCidr String: CIDR for the VPC to be paired
peerRegionCode String: Region code for the VPC to be paired
peerVpcId String: AWS ID for the VPC to be paired
peeringConnectionId Double: Timescale internal ID for a peering connection
provisionedId String: AWS ID of the peering connection (starts with pcx-...)
status String: Peering connection status
timescaleVpcId Double: Timescale internal ID for a vpc
vpcId String: AWS VPC ID of the timescale instance VPC

errorMessage string
peerAccountId string: AWS account ID where the VPC to be paired
peerCidr string: CIDR for the VPC to be paired
peerRegionCode string: Region code for the VPC to be paired
peerVpcId string: AWS ID for the VPC to be paired
peeringConnectionId number: Timescale internal ID for a peering connection
provisionedId string: AWS ID of the peering connection (starts with pcx-...)
status string: Peering connection status
timescaleVpcId number: Timescale internal ID for a vpc
vpcId string: AWS VPC ID of the timescale instance VPC

error_message str
peer_account_id str: AWS account ID where the VPC to be paired
peer_cidr str: CIDR for the VPC to be paired
peer_region_code str: Region code for the VPC to be paired
peer_vpc_id str: AWS ID for the VPC to be paired
peering_connection_id float: Timescale internal ID for a peering connection
provisioned_id str: AWS ID of the peering connection (starts with pcx-...)
status str: Peering connection status
timescale_vpc_id float: Timescale internal ID for a vpc
vpc_id str: AWS VPC ID of the timescale instance VPC

errorMessage String
peerAccountId String: AWS account ID where the VPC to be paired
peerCidr String: CIDR for the VPC to be paired
peerRegionCode String: Region code for the VPC to be paired
peerVpcId String: AWS ID for the VPC to be paired
peeringConnectionId Number: Timescale internal ID for a peering connection
provisionedId String: AWS ID of the peering connection (starts with pcx-...)
status String: Peering connection status
timescaleVpcId Number: Timescale internal ID for a vpc
vpcId String: AWS VPC ID of the timescale instance VPC

Package Details

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

timescale 1.15.0 published on Friday, Feb 21, 2025 by timescale

timescale/terraform-provider-timescale

timescale.PeeringConnection

On this page

On this page

Create PeeringConnection Resource

Constructor syntax

Parameters

Constructor example

PeeringConnection Resource Properties

Inputs

Outputs

Look up Existing PeeringConnection Resource

Package Details

On this page

On this page