1. Packages
  2. Google Cloud Native
  3. API Docs
  4. compute
  5. compute/v1
  6. getTargetVpnGateway

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

google-native.compute/v1.getTargetVpnGateway

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

    Returns the specified target VPN gateway.

    Using getTargetVpnGateway

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTargetVpnGateway(args: GetTargetVpnGatewayArgs, opts?: InvokeOptions): Promise<GetTargetVpnGatewayResult>
    function getTargetVpnGatewayOutput(args: GetTargetVpnGatewayOutputArgs, opts?: InvokeOptions): Output<GetTargetVpnGatewayResult>
    def get_target_vpn_gateway(project: Optional[str] = None,
                               region: Optional[str] = None,
                               target_vpn_gateway: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetTargetVpnGatewayResult
    def get_target_vpn_gateway_output(project: Optional[pulumi.Input[str]] = None,
                               region: Optional[pulumi.Input[str]] = None,
                               target_vpn_gateway: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetTargetVpnGatewayResult]
    func LookupTargetVpnGateway(ctx *Context, args *LookupTargetVpnGatewayArgs, opts ...InvokeOption) (*LookupTargetVpnGatewayResult, error)
    func LookupTargetVpnGatewayOutput(ctx *Context, args *LookupTargetVpnGatewayOutputArgs, opts ...InvokeOption) LookupTargetVpnGatewayResultOutput

    > Note: This function is named LookupTargetVpnGateway in the Go SDK.

    public static class GetTargetVpnGateway 
    {
        public static Task<GetTargetVpnGatewayResult> InvokeAsync(GetTargetVpnGatewayArgs args, InvokeOptions? opts = null)
        public static Output<GetTargetVpnGatewayResult> Invoke(GetTargetVpnGatewayInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTargetVpnGatewayResult> getTargetVpnGateway(GetTargetVpnGatewayArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:compute/v1:getTargetVpnGateway
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Region string
    TargetVpnGateway string
    Project string
    Region string
    TargetVpnGateway string
    Project string
    region String
    targetVpnGateway String
    project String
    region string
    targetVpnGateway string
    project string
    region String
    targetVpnGateway String
    project String

    getTargetVpnGateway Result

    The following output properties are available:

    CreationTimestamp string

    Creation timestamp in RFC3339 text format.

    Description string

    An optional description of this resource. Provide this property when you create the resource.

    ForwardingRules List<string>

    A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.

    Kind string

    Type of resource. Always compute#targetVpnGateway for target VPN gateways.

    LabelFingerprint 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.

    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.

    Region string

    URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

    SelfLink 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.

    CreationTimestamp string

    Creation timestamp in RFC3339 text format.

    Description string

    An optional description of this resource. Provide this property when you create the resource.

    ForwardingRules []string

    A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.

    Kind string

    Type of resource. Always compute#targetVpnGateway for target VPN gateways.

    LabelFingerprint 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.

    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.

    Region string

    URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

    SelfLink 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.

    creationTimestamp String

    Creation timestamp in RFC3339 text format.

    description String

    An optional description of this resource. Provide this property when you create the resource.

    forwardingRules List<String>

    A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.

    kind String

    Type of resource. Always compute#targetVpnGateway for target VPN gateways.

    labelFingerprint 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.

    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.

    region String

    URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

    selfLink 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.

    creationTimestamp string

    Creation timestamp in RFC3339 text format.

    description string

    An optional description of this resource. Provide this property when you create the resource.

    forwardingRules string[]

    A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.

    kind string

    Type of resource. Always compute#targetVpnGateway for target VPN gateways.

    labelFingerprint 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.

    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.

    region string

    URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

    selfLink 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.

    description str

    An optional description of this resource. Provide this property when you create the resource.

    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.

    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.

    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.

    region str

    URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

    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.

    creationTimestamp String

    Creation timestamp in RFC3339 text format.

    description String

    An optional description of this resource. Provide this property when you create the resource.

    forwardingRules List<String>

    A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.

    kind String

    Type of resource. Always compute#targetVpnGateway for target VPN gateways.

    labelFingerprint 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.

    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.

    region String

    URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

    selfLink 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-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi