1. Packages
  2. Cloudamqp Provider
  3. API Docs
  4. VpcGcpPeering
CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi

cloudamqp.VpcGcpPeering

Explore with Pulumi AI

Import

Peering network URI

This is required to be able to import the correct peering. Following the same format as the argument

reference.

hcl

https://www.googleapis.com/compute/v1/projects/PROJECT-NAME/global/networks/VPC-NETWORK-NAME

Create VpcGcpPeering Resource

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

Constructor syntax

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

@overload
def VpcGcpPeering(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  peer_network_uri: Optional[str] = None,
                  instance_id: Optional[int] = None,
                  sleep: Optional[int] = None,
                  timeout: Optional[int] = None,
                  vpc_id: Optional[str] = None,
                  wait_on_peering_status: Optional[bool] = None)
func NewVpcGcpPeering(ctx *Context, name string, args VpcGcpPeeringArgs, opts ...ResourceOption) (*VpcGcpPeering, error)
public VpcGcpPeering(string name, VpcGcpPeeringArgs args, CustomResourceOptions? opts = null)
public VpcGcpPeering(String name, VpcGcpPeeringArgs args)
public VpcGcpPeering(String name, VpcGcpPeeringArgs args, CustomResourceOptions options)
type: cloudamqp:VpcGcpPeering
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. VpcGcpPeeringArgs
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. VpcGcpPeeringArgs
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. VpcGcpPeeringArgs
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. VpcGcpPeeringArgs
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. VpcGcpPeeringArgs
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 vpcGcpPeeringResource = new CloudAmqp.VpcGcpPeering("vpcGcpPeeringResource", new()
{
    PeerNetworkUri = "string",
    InstanceId = 0,
    Sleep = 0,
    Timeout = 0,
    VpcId = "string",
    WaitOnPeeringStatus = false,
});
Copy
example, err := cloudamqp.NewVpcGcpPeering(ctx, "vpcGcpPeeringResource", &cloudamqp.VpcGcpPeeringArgs{
	PeerNetworkUri:      pulumi.String("string"),
	InstanceId:          pulumi.Int(0),
	Sleep:               pulumi.Int(0),
	Timeout:             pulumi.Int(0),
	VpcId:               pulumi.String("string"),
	WaitOnPeeringStatus: pulumi.Bool(false),
})
Copy
var vpcGcpPeeringResource = new VpcGcpPeering("vpcGcpPeeringResource", VpcGcpPeeringArgs.builder()
    .peerNetworkUri("string")
    .instanceId(0)
    .sleep(0)
    .timeout(0)
    .vpcId("string")
    .waitOnPeeringStatus(false)
    .build());
Copy
vpc_gcp_peering_resource = cloudamqp.VpcGcpPeering("vpcGcpPeeringResource",
    peer_network_uri="string",
    instance_id=0,
    sleep=0,
    timeout=0,
    vpc_id="string",
    wait_on_peering_status=False)
Copy
const vpcGcpPeeringResource = new cloudamqp.VpcGcpPeering("vpcGcpPeeringResource", {
    peerNetworkUri: "string",
    instanceId: 0,
    sleep: 0,
    timeout: 0,
    vpcId: "string",
    waitOnPeeringStatus: false,
});
Copy
type: cloudamqp:VpcGcpPeering
properties:
    instanceId: 0
    peerNetworkUri: string
    sleep: 0
    timeout: 0
    vpcId: string
    waitOnPeeringStatus: false
Copy

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

PeerNetworkUri This property is required. string
Network URI of the VPC network to which you will peer with. See examples above for the format.
InstanceId int

The CloudAMQP instance identifier.

Deprecated: from [v1.16.0], will be removed in next major version (v2.0)

Sleep int

Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds.

Note: Available from [v1.29.0]

Timeout int

Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds.

Note: Available from [v1.29.0]

VpcId string

The managed VPC identifier.

Note: Available from [v1.16.0], will be required in next major version (v2.0)

WaitOnPeeringStatus bool

Makes the resource wait until the peering is connected. Default set to false.

Note: Available from [v1.28.0]

PeerNetworkUri This property is required. string
Network URI of the VPC network to which you will peer with. See examples above for the format.
InstanceId int

The CloudAMQP instance identifier.

Deprecated: from [v1.16.0], will be removed in next major version (v2.0)

Sleep int

Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds.

Note: Available from [v1.29.0]

Timeout int

Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds.

Note: Available from [v1.29.0]

VpcId string

The managed VPC identifier.

Note: Available from [v1.16.0], will be required in next major version (v2.0)

WaitOnPeeringStatus bool

Makes the resource wait until the peering is connected. Default set to false.

Note: Available from [v1.28.0]

peerNetworkUri This property is required. String
Network URI of the VPC network to which you will peer with. See examples above for the format.
instanceId Integer

The CloudAMQP instance identifier.

Deprecated: from [v1.16.0], will be removed in next major version (v2.0)

sleep Integer

Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout Integer

Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds.

Note: Available from [v1.29.0]

vpcId String

The managed VPC identifier.

Note: Available from [v1.16.0], will be required in next major version (v2.0)

waitOnPeeringStatus Boolean

Makes the resource wait until the peering is connected. Default set to false.

Note: Available from [v1.28.0]

peerNetworkUri This property is required. string
Network URI of the VPC network to which you will peer with. See examples above for the format.
instanceId number

The CloudAMQP instance identifier.

Deprecated: from [v1.16.0], will be removed in next major version (v2.0)

sleep number

Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout number

Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds.

Note: Available from [v1.29.0]

vpcId string

The managed VPC identifier.

Note: Available from [v1.16.0], will be required in next major version (v2.0)

waitOnPeeringStatus boolean

Makes the resource wait until the peering is connected. Default set to false.

Note: Available from [v1.28.0]

peer_network_uri This property is required. str
Network URI of the VPC network to which you will peer with. See examples above for the format.
instance_id int

The CloudAMQP instance identifier.

Deprecated: from [v1.16.0], will be removed in next major version (v2.0)

sleep int

Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout int

Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds.

Note: Available from [v1.29.0]

vpc_id str

The managed VPC identifier.

Note: Available from [v1.16.0], will be required in next major version (v2.0)

wait_on_peering_status bool

Makes the resource wait until the peering is connected. Default set to false.

Note: Available from [v1.28.0]

peerNetworkUri This property is required. String
Network URI of the VPC network to which you will peer with. See examples above for the format.
instanceId Number

The CloudAMQP instance identifier.

Deprecated: from [v1.16.0], will be removed in next major version (v2.0)

sleep Number

Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout Number

Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds.

Note: Available from [v1.29.0]

vpcId String

The managed VPC identifier.

Note: Available from [v1.16.0], will be required in next major version (v2.0)

waitOnPeeringStatus Boolean

Makes the resource wait until the peering is connected. Default set to false.

Note: Available from [v1.28.0]

Outputs

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

AutoCreateRoutes bool
VPC peering auto created routes
Id string
The provider-assigned unique ID for this managed resource.
State string
VPC peering state
StateDetails string
VPC peering state details
AutoCreateRoutes bool
VPC peering auto created routes
Id string
The provider-assigned unique ID for this managed resource.
State string
VPC peering state
StateDetails string
VPC peering state details
autoCreateRoutes Boolean
VPC peering auto created routes
id String
The provider-assigned unique ID for this managed resource.
state String
VPC peering state
stateDetails String
VPC peering state details
autoCreateRoutes boolean
VPC peering auto created routes
id string
The provider-assigned unique ID for this managed resource.
state string
VPC peering state
stateDetails string
VPC peering state details
auto_create_routes bool
VPC peering auto created routes
id str
The provider-assigned unique ID for this managed resource.
state str
VPC peering state
state_details str
VPC peering state details
autoCreateRoutes Boolean
VPC peering auto created routes
id String
The provider-assigned unique ID for this managed resource.
state String
VPC peering state
stateDetails String
VPC peering state details

Look up Existing VpcGcpPeering Resource

Get an existing VpcGcpPeering 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?: VpcGcpPeeringState, opts?: CustomResourceOptions): VpcGcpPeering
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_create_routes: Optional[bool] = None,
        instance_id: Optional[int] = None,
        peer_network_uri: Optional[str] = None,
        sleep: Optional[int] = None,
        state: Optional[str] = None,
        state_details: Optional[str] = None,
        timeout: Optional[int] = None,
        vpc_id: Optional[str] = None,
        wait_on_peering_status: Optional[bool] = None) -> VpcGcpPeering
func GetVpcGcpPeering(ctx *Context, name string, id IDInput, state *VpcGcpPeeringState, opts ...ResourceOption) (*VpcGcpPeering, error)
public static VpcGcpPeering Get(string name, Input<string> id, VpcGcpPeeringState? state, CustomResourceOptions? opts = null)
public static VpcGcpPeering get(String name, Output<String> id, VpcGcpPeeringState state, CustomResourceOptions options)
resources:  _:    type: cloudamqp:VpcGcpPeering    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:
AutoCreateRoutes bool
VPC peering auto created routes
InstanceId int

The CloudAMQP instance identifier.

Deprecated: from [v1.16.0], will be removed in next major version (v2.0)

PeerNetworkUri string
Network URI of the VPC network to which you will peer with. See examples above for the format.
Sleep int

Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds.

Note: Available from [v1.29.0]

State string
VPC peering state
StateDetails string
VPC peering state details
Timeout int

Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds.

Note: Available from [v1.29.0]

VpcId string

The managed VPC identifier.

Note: Available from [v1.16.0], will be required in next major version (v2.0)

WaitOnPeeringStatus bool

Makes the resource wait until the peering is connected. Default set to false.

Note: Available from [v1.28.0]

AutoCreateRoutes bool
VPC peering auto created routes
InstanceId int

The CloudAMQP instance identifier.

Deprecated: from [v1.16.0], will be removed in next major version (v2.0)

PeerNetworkUri string
Network URI of the VPC network to which you will peer with. See examples above for the format.
Sleep int

Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds.

Note: Available from [v1.29.0]

State string
VPC peering state
StateDetails string
VPC peering state details
Timeout int

Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds.

Note: Available from [v1.29.0]

VpcId string

The managed VPC identifier.

Note: Available from [v1.16.0], will be required in next major version (v2.0)

WaitOnPeeringStatus bool

Makes the resource wait until the peering is connected. Default set to false.

Note: Available from [v1.28.0]

autoCreateRoutes Boolean
VPC peering auto created routes
instanceId Integer

The CloudAMQP instance identifier.

Deprecated: from [v1.16.0], will be removed in next major version (v2.0)

peerNetworkUri String
Network URI of the VPC network to which you will peer with. See examples above for the format.
sleep Integer

Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds.

Note: Available from [v1.29.0]

state String
VPC peering state
stateDetails String
VPC peering state details
timeout Integer

Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds.

Note: Available from [v1.29.0]

vpcId String

The managed VPC identifier.

Note: Available from [v1.16.0], will be required in next major version (v2.0)

waitOnPeeringStatus Boolean

Makes the resource wait until the peering is connected. Default set to false.

Note: Available from [v1.28.0]

autoCreateRoutes boolean
VPC peering auto created routes
instanceId number

The CloudAMQP instance identifier.

Deprecated: from [v1.16.0], will be removed in next major version (v2.0)

peerNetworkUri string
Network URI of the VPC network to which you will peer with. See examples above for the format.
sleep number

Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds.

Note: Available from [v1.29.0]

state string
VPC peering state
stateDetails string
VPC peering state details
timeout number

Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds.

Note: Available from [v1.29.0]

vpcId string

The managed VPC identifier.

Note: Available from [v1.16.0], will be required in next major version (v2.0)

waitOnPeeringStatus boolean

Makes the resource wait until the peering is connected. Default set to false.

Note: Available from [v1.28.0]

auto_create_routes bool
VPC peering auto created routes
instance_id int

The CloudAMQP instance identifier.

Deprecated: from [v1.16.0], will be removed in next major version (v2.0)

peer_network_uri str
Network URI of the VPC network to which you will peer with. See examples above for the format.
sleep int

Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds.

Note: Available from [v1.29.0]

state str
VPC peering state
state_details str
VPC peering state details
timeout int

Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds.

Note: Available from [v1.29.0]

vpc_id str

The managed VPC identifier.

Note: Available from [v1.16.0], will be required in next major version (v2.0)

wait_on_peering_status bool

Makes the resource wait until the peering is connected. Default set to false.

Note: Available from [v1.28.0]

autoCreateRoutes Boolean
VPC peering auto created routes
instanceId Number

The CloudAMQP instance identifier.

Deprecated: from [v1.16.0], will be removed in next major version (v2.0)

peerNetworkUri String
Network URI of the VPC network to which you will peer with. See examples above for the format.
sleep Number

Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds.

Note: Available from [v1.29.0]

state String
VPC peering state
stateDetails String
VPC peering state details
timeout Number

Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds.

Note: Available from [v1.29.0]

vpcId String

The managed VPC identifier.

Note: Available from [v1.16.0], will be required in next major version (v2.0)

waitOnPeeringStatus Boolean

Makes the resource wait until the peering is connected. Default set to false.

Note: Available from [v1.28.0]

Package Details

Repository
CloudAMQP pulumi/pulumi-cloudamqp
License
Apache-2.0
Notes
This Pulumi package is based on the cloudamqp Terraform Provider.