Docs
PackagesGoogle Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.compute/v1.TargetVpnGateway
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a target VPN gateway in the specified project and region using the data included in the request.
Create TargetVpnGateway Resource
new TargetVpnGateway(name: string, args: TargetVpnGatewayArgs, opts?: CustomResourceOptions);@overload
def TargetVpnGateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
network: Optional[str] = None,
project: Optional[str] = None,
region: Optional[str] = None,
request_id: Optional[str] = None)
@overload
def TargetVpnGateway(resource_name: str,
args: TargetVpnGatewayArgs,
opts: Optional[ResourceOptions] = None)func NewTargetVpnGateway(ctx *Context, name string, args TargetVpnGatewayArgs, opts ...ResourceOption) (*TargetVpnGateway, error)public TargetVpnGateway(string name, TargetVpnGatewayArgs args, CustomResourceOptions? opts = null)
public TargetVpnGateway(String name, TargetVpnGatewayArgs args)
public TargetVpnGateway(String name, TargetVpnGatewayArgs args, CustomResourceOptions options)
type: google-native:compute/v1:TargetVpnGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TargetVpnGatewayArgs
- 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 TargetVpnGatewayArgs
- 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 TargetVpnGatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TargetVpnGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TargetVpnGatewayArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
TargetVpnGateway 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 TargetVpnGateway resource accepts the following input properties:
- Region string
- Description string
An optional description of this resource. Provide this property when you create the resource.
- Labels Dictionary<string, string>
Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
- Name string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- Network string
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
- Project string
- Request
Id string An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- Region string
- Description string
An optional description of this resource. Provide this property when you create the resource.
- Labels map[string]string
Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
- Name string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- Network string
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
- Project string
- Request
Id string An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- region String
- description String
An optional description of this resource. Provide this property when you create the resource.
- labels Map<String,String>
Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
- name String
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- network String
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
- project String
- request
Id String An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- region string
- description string
An optional description of this resource. Provide this property when you create the resource.
- labels {[key: string]: string}
Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
- name string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- network string
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
- project string
- request
Id string An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- region str
- description str
An optional description of this resource. Provide this property when you create the resource.
- labels Mapping[str, str]
Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
- name str
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- network str
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
- project str
- request_
id str An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- region String
- description String
An optional description of this resource. Provide this property when you create the resource.
- labels Map<String>
Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
- name String
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- network String
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
- project String
- request
Id String An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Outputs
All input properties are implicitly available as output properties. Additionally, the TargetVpnGateway resource produces the following output properties:
- Creation
Timestamp string Creation timestamp in RFC3339 text format.
- Forwarding
Rules List<string> A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
- Id string
The provider-assigned unique ID for this managed resource.
- Kind string
Type of resource. Always compute#targetVpnGateway for target VPN gateways.
- Label
Fingerprint string A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.
- Self
Link string Server-defined URL for the resource.
- Status string
The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
- Tunnels List<string>
A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
- Creation
Timestamp string Creation timestamp in RFC3339 text format.
- Forwarding
Rules []string A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
- Id string
The provider-assigned unique ID for this managed resource.
- Kind string
Type of resource. Always compute#targetVpnGateway for target VPN gateways.
- Label
Fingerprint string A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.
- Self
Link string Server-defined URL for the resource.
- Status string
The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
- Tunnels []string
A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
- creation
Timestamp String Creation timestamp in RFC3339 text format.
- forwarding
Rules List<String> A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
- id String
The provider-assigned unique ID for this managed resource.
- kind String
Type of resource. Always compute#targetVpnGateway for target VPN gateways.
- label
Fingerprint String A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.
- self
Link String Server-defined URL for the resource.
- status String
The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
- tunnels List<String>
A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
- creation
Timestamp string Creation timestamp in RFC3339 text format.
- forwarding
Rules string[] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
- id string
The provider-assigned unique ID for this managed resource.
- kind string
Type of resource. Always compute#targetVpnGateway for target VPN gateways.
- label
Fingerprint string A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.
- self
Link string Server-defined URL for the resource.
- status string
The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
- tunnels string[]
A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
- creation_
timestamp str Creation timestamp in RFC3339 text format.
- forwarding_
rules Sequence[str] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
- id str
The provider-assigned unique ID for this managed resource.
- kind str
Type of resource. Always compute#targetVpnGateway for target VPN gateways.
- label_
fingerprint str A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.
- self_
link str Server-defined URL for the resource.
- status str
The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
- tunnels Sequence[str]
A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
- creation
Timestamp String Creation timestamp in RFC3339 text format.
- forwarding
Rules List<String> A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
- id String
The provider-assigned unique ID for this managed resource.
- kind String
Type of resource. Always compute#targetVpnGateway for target VPN gateways.
- label
Fingerprint String A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.
- self
Link String Server-defined URL for the resource.
- status String
The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
- tunnels List<String>
A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.