Connector
Serverless VPC Access connector resource.
To get more information about Connector, see:
- API documentation
- How-to Guides
Create a Connector Resource
new Connector(name: string, args: ConnectorArgs, opts?: CustomResourceOptions);def Connector(resource_name, opts=None, ip_cidr_range=None, max_throughput=None, min_throughput=None, name=None, network=None, project=None, region=None, __props__=None);func NewConnector(ctx *Context, name string, args ConnectorArgs, opts ...ResourceOption) (*Connector, error)public Connector(string name, ConnectorArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args ConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
Connector Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The Connector resource accepts the following input properties:
- Ip
Cidr stringRange The range of internal addresses that follows RFC 4632 notation. Example:
10.132.0.0/28.- Network string
Name of a VPC network.
- Region string
Region where the VPC Access connector resides
- Max
Throughput int Maximum throughput of the connector in Mbps, must be greater than
min_throughput. Default is 1000.- Min
Throughput int Minimum throughput of the connector in Mbps. Default and min is 200.
- Name string
The name of the resource (Max 25 characters).
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Ip
Cidr stringRange The range of internal addresses that follows RFC 4632 notation. Example:
10.132.0.0/28.- Network string
Name of a VPC network.
- Region string
Region where the VPC Access connector resides
- Max
Throughput int Maximum throughput of the connector in Mbps, must be greater than
min_throughput. Default is 1000.- Min
Throughput int Minimum throughput of the connector in Mbps. Default and min is 200.
- Name string
The name of the resource (Max 25 characters).
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- ip
Cidr stringRange The range of internal addresses that follows RFC 4632 notation. Example:
10.132.0.0/28.- network string
Name of a VPC network.
- region string
Region where the VPC Access connector resides
- max
Throughput number Maximum throughput of the connector in Mbps, must be greater than
min_throughput. Default is 1000.- min
Throughput number Minimum throughput of the connector in Mbps. Default and min is 200.
- name string
The name of the resource (Max 25 characters).
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- ip_
cidr_ strrange The range of internal addresses that follows RFC 4632 notation. Example:
10.132.0.0/28.- network str
Name of a VPC network.
- region str
Region where the VPC Access connector resides
- max_
throughput float Maximum throughput of the connector in Mbps, must be greater than
min_throughput. Default is 1000.- min_
throughput float Minimum throughput of the connector in Mbps. Default and min is 200.
- name str
The name of the resource (Max 25 characters).
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the Connector resource produces the following output properties:
Look up an Existing Connector Resource
Get an existing Connector 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?: ConnectorState, opts?: CustomResourceOptions): Connectorstatic get(resource_name, id, opts=None, ip_cidr_range=None, max_throughput=None, min_throughput=None, name=None, network=None, project=None, region=None, self_link=None, state=None, __props__=None);func GetConnector(ctx *Context, name string, id IDInput, state *ConnectorState, opts ...ResourceOption) (*Connector, error)public static Connector Get(string name, Input<string> id, ConnectorState? state, CustomResourceOptions? opts = null)- 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.
The following state arguments are supported:
- Ip
Cidr stringRange The range of internal addresses that follows RFC 4632 notation. Example:
10.132.0.0/28.- Max
Throughput int Maximum throughput of the connector in Mbps, must be greater than
min_throughput. Default is 1000.- Min
Throughput int Minimum throughput of the connector in Mbps. Default and min is 200.
- Name string
The name of the resource (Max 25 characters).
- Network string
Name of a VPC network.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
Region where the VPC Access connector resides
- Self
Link string The fully qualified name of this VPC connector
- State string
State of the VPC access connector.
- Ip
Cidr stringRange The range of internal addresses that follows RFC 4632 notation. Example:
10.132.0.0/28.- Max
Throughput int Maximum throughput of the connector in Mbps, must be greater than
min_throughput. Default is 1000.- Min
Throughput int Minimum throughput of the connector in Mbps. Default and min is 200.
- Name string
The name of the resource (Max 25 characters).
- Network string
Name of a VPC network.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
Region where the VPC Access connector resides
- Self
Link string The fully qualified name of this VPC connector
- State string
State of the VPC access connector.
- ip
Cidr stringRange The range of internal addresses that follows RFC 4632 notation. Example:
10.132.0.0/28.- max
Throughput number Maximum throughput of the connector in Mbps, must be greater than
min_throughput. Default is 1000.- min
Throughput number Minimum throughput of the connector in Mbps. Default and min is 200.
- name string
The name of the resource (Max 25 characters).
- network string
Name of a VPC network.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region string
Region where the VPC Access connector resides
- self
Link string The fully qualified name of this VPC connector
- state string
State of the VPC access connector.
- ip_
cidr_ strrange The range of internal addresses that follows RFC 4632 notation. Example:
10.132.0.0/28.- max_
throughput float Maximum throughput of the connector in Mbps, must be greater than
min_throughput. Default is 1000.- min_
throughput float Minimum throughput of the connector in Mbps. Default and min is 200.
- name str
The name of the resource (Max 25 characters).
- network str
Name of a VPC network.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region str
Region where the VPC Access connector resides
- self_
link str The fully qualified name of this VPC connector
- state str
State of the VPC access connector.
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.