Google Cloud (GCP) Classic

v6.44.0 published on Tuesday, Nov 29, 2022 by Pulumi

Peering

Import

This resource does not support import.

Create Peering Resource

new Peering(name: string, args: PeeringArgs, opts?: CustomResourceOptions);
@overload
def Peering(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            authorized_network: Optional[str] = None,
            domain_resource: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            peering_id: Optional[str] = None,
            project: Optional[str] = None,
            status: Optional[str] = None,
            status_message: Optional[str] = None)
@overload
def Peering(resource_name: str,
            args: PeeringArgs,
            opts: Optional[ResourceOptions] = None)
func NewPeering(ctx *Context, name string, args PeeringArgs, opts ...ResourceOption) (*Peering, error)
public Peering(string name, PeeringArgs args, CustomResourceOptions? opts = null)
public Peering(String name, PeeringArgs args)
public Peering(String name, PeeringArgs args, CustomResourceOptions options)
type: gcp:activedirectory:Peering
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

AuthorizedNetwork string

The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.

DomainResource string

Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form projects/{projectId}/locations/global/domains/{domainName}

PeeringId string

(Required)

Labels Dictionary<string, string>

Resource labels that can contain user-provided metadata

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Status string

The current state of this Peering.

StatusMessage string

Additional information about the current status of this peering, if available.

AuthorizedNetwork string

The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.

DomainResource string

Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form projects/{projectId}/locations/global/domains/{domainName}

PeeringId string

(Required)

Labels map[string]string

Resource labels that can contain user-provided metadata

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Status string

The current state of this Peering.

StatusMessage string

Additional information about the current status of this peering, if available.

authorizedNetwork String

The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.

domainResource String

Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form projects/{projectId}/locations/global/domains/{domainName}

peeringId String

(Required)

labels Map<String,String>

Resource labels that can contain user-provided metadata

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

status String

The current state of this Peering.

statusMessage String

Additional information about the current status of this peering, if available.

authorizedNetwork string

The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.

domainResource string

Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form projects/{projectId}/locations/global/domains/{domainName}

peeringId string

(Required)

labels {[key: string]: string}

Resource labels that can contain user-provided metadata

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

status string

The current state of this Peering.

statusMessage string

Additional information about the current status of this peering, if available.

authorized_network str

The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.

domain_resource str

Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form projects/{projectId}/locations/global/domains/{domainName}

peering_id str

(Required)

labels Mapping[str, str]

Resource labels that can contain user-provided metadata

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

status str

The current state of this Peering.

status_message str

Additional information about the current status of this peering, if available.

authorizedNetwork String

The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.

domainResource String

Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form projects/{projectId}/locations/global/domains/{domainName}

peeringId String

(Required)

labels Map<String>

Resource labels that can contain user-provided metadata

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

status String

The current state of this Peering.

statusMessage String

Additional information about the current status of this peering, if available.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Name string

Unique name of the peering in this scope including projects and location using the form: projects/{projectId}/locations/global/peerings/{peeringId}.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Unique name of the peering in this scope including projects and location using the form: projects/{projectId}/locations/global/peerings/{peeringId}.

id String

The provider-assigned unique ID for this managed resource.

name String

Unique name of the peering in this scope including projects and location using the form: projects/{projectId}/locations/global/peerings/{peeringId}.

id string

The provider-assigned unique ID for this managed resource.

name string

Unique name of the peering in this scope including projects and location using the form: projects/{projectId}/locations/global/peerings/{peeringId}.

id str

The provider-assigned unique ID for this managed resource.

name str

Unique name of the peering in this scope including projects and location using the form: projects/{projectId}/locations/global/peerings/{peeringId}.

id String

The provider-assigned unique ID for this managed resource.

name String

Unique name of the peering in this scope including projects and location using the form: projects/{projectId}/locations/global/peerings/{peeringId}.

Look up Existing Peering Resource

Get an existing Peering 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?: PeeringState, opts?: CustomResourceOptions): Peering
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorized_network: Optional[str] = None,
        domain_resource: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        peering_id: Optional[str] = None,
        project: Optional[str] = None,
        status: Optional[str] = None,
        status_message: Optional[str] = None) -> Peering
func GetPeering(ctx *Context, name string, id IDInput, state *PeeringState, opts ...ResourceOption) (*Peering, error)
public static Peering Get(string name, Input<string> id, PeeringState? state, CustomResourceOptions? opts = null)
public static Peering get(String name, Output<String> id, PeeringState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
AuthorizedNetwork string

The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.

DomainResource string

Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form projects/{projectId}/locations/global/domains/{domainName}

Labels Dictionary<string, string>

Resource labels that can contain user-provided metadata

Name string

Unique name of the peering in this scope including projects and location using the form: projects/{projectId}/locations/global/peerings/{peeringId}.

PeeringId string

(Required)

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Status string

The current state of this Peering.

StatusMessage string

Additional information about the current status of this peering, if available.

AuthorizedNetwork string

The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.

DomainResource string

Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form projects/{projectId}/locations/global/domains/{domainName}

Labels map[string]string

Resource labels that can contain user-provided metadata

Name string

Unique name of the peering in this scope including projects and location using the form: projects/{projectId}/locations/global/peerings/{peeringId}.

PeeringId string

(Required)

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Status string

The current state of this Peering.

StatusMessage string

Additional information about the current status of this peering, if available.

authorizedNetwork String

The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.

domainResource String

Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form projects/{projectId}/locations/global/domains/{domainName}

labels Map<String,String>

Resource labels that can contain user-provided metadata

name String

Unique name of the peering in this scope including projects and location using the form: projects/{projectId}/locations/global/peerings/{peeringId}.

peeringId String

(Required)

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

status String

The current state of this Peering.

statusMessage String

Additional information about the current status of this peering, if available.

authorizedNetwork string

The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.

domainResource string

Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form projects/{projectId}/locations/global/domains/{domainName}

labels {[key: string]: string}

Resource labels that can contain user-provided metadata

name string

Unique name of the peering in this scope including projects and location using the form: projects/{projectId}/locations/global/peerings/{peeringId}.

peeringId string

(Required)

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

status string

The current state of this Peering.

statusMessage string

Additional information about the current status of this peering, if available.

authorized_network str

The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.

domain_resource str

Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form projects/{projectId}/locations/global/domains/{domainName}

labels Mapping[str, str]

Resource labels that can contain user-provided metadata

name str

Unique name of the peering in this scope including projects and location using the form: projects/{projectId}/locations/global/peerings/{peeringId}.

peering_id str

(Required)

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

status str

The current state of this Peering.

status_message str

Additional information about the current status of this peering, if available.

authorizedNetwork String

The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.

domainResource String

Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form projects/{projectId}/locations/global/domains/{domainName}

labels Map<String>

Resource labels that can contain user-provided metadata

name String

Unique name of the peering in this scope including projects and location using the form: projects/{projectId}/locations/global/peerings/{peeringId}.

peeringId String

(Required)

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

status String

The current state of this Peering.

statusMessage String

Additional information about the current status of this peering, if available.

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.