Google Cloud Native v0.28.0, Feb 2 23

google-native.beyondcorp/v1alpha.getConnection

Gets details of a single Connection.

Using getConnection

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 getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>

def get_connection(connection_id: Optional[str] = None,
                   location: Optional[str] = None,
                   project: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(connection_id: Optional[pulumi.Input[str]] = None,
                   location: Optional[pulumi.Input[str]] = None,
                   project: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]

func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput

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

public static class GetConnection 
{
    public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:beyondcorp/v1alpha:getConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

ConnectionId string
Location string
Project string

ConnectionId string
Location string
Project string

connectionId String
location String
project String

connectionId string
location string
project string

connection_id str
location str
project str

connectionId String
location String
project String

getConnection Result

The following output properties are available:

ApplicationEndpoint Pulumi.GoogleNative.BeyondCorp.V1Alpha.Outputs.ApplicationEndpointResponse: Address of the remote application endpoint for the BeyondCorp Connection.
Connectors List<string>: Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
CreateTime string: Timestamp when the resource was created.
DisplayName string: Optional. An arbitrary user-provided name for the connection. Cannot exceed 64 characters.
Gateway Pulumi.GoogleNative.BeyondCorp.V1Alpha.Outputs.GatewayResponse: Optional. Gateway used by the connection.
Labels Dictionary<string, string>: Optional. Resource labels to represent user provided metadata.
Name string: Unique resource name of the connection. The name is ignored when creating a connection.
State string: The current state of the connection.
Type string: The type of network connectivity used by the connection.
Uid string: A unique identifier for the instance generated by the system.
UpdateTime string: Timestamp when the resource was last modified.

ApplicationEndpoint ApplicationEndpointResponse: Address of the remote application endpoint for the BeyondCorp Connection.
Connectors []string: Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
CreateTime string: Timestamp when the resource was created.
DisplayName string: Optional. An arbitrary user-provided name for the connection. Cannot exceed 64 characters.
Gateway GatewayResponse: Optional. Gateway used by the connection.
Labels map[string]string: Optional. Resource labels to represent user provided metadata.
Name string: Unique resource name of the connection. The name is ignored when creating a connection.
State string: The current state of the connection.
Type string: The type of network connectivity used by the connection.
Uid string: A unique identifier for the instance generated by the system.
UpdateTime string: Timestamp when the resource was last modified.

applicationEndpoint ApplicationEndpointResponse: Address of the remote application endpoint for the BeyondCorp Connection.
connectors List<String>: Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
createTime String: Timestamp when the resource was created.
displayName String: Optional. An arbitrary user-provided name for the connection. Cannot exceed 64 characters.
gateway GatewayResponse: Optional. Gateway used by the connection.
labels Map<String,String>: Optional. Resource labels to represent user provided metadata.
name String: Unique resource name of the connection. The name is ignored when creating a connection.
state String: The current state of the connection.
type String: The type of network connectivity used by the connection.
uid String: A unique identifier for the instance generated by the system.
updateTime String: Timestamp when the resource was last modified.

applicationEndpoint ApplicationEndpointResponse: Address of the remote application endpoint for the BeyondCorp Connection.
connectors string[]: Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
createTime string: Timestamp when the resource was created.
displayName string: Optional. An arbitrary user-provided name for the connection. Cannot exceed 64 characters.
gateway GatewayResponse: Optional. Gateway used by the connection.
labels {[key: string]: string}: Optional. Resource labels to represent user provided metadata.
name string: Unique resource name of the connection. The name is ignored when creating a connection.
state string: The current state of the connection.
type string: The type of network connectivity used by the connection.
uid string: A unique identifier for the instance generated by the system.
updateTime string: Timestamp when the resource was last modified.

application_endpoint ApplicationEndpointResponse: Address of the remote application endpoint for the BeyondCorp Connection.
connectors Sequence[str]: Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
create_time str: Timestamp when the resource was created.
display_name str: Optional. An arbitrary user-provided name for the connection. Cannot exceed 64 characters.
gateway GatewayResponse: Optional. Gateway used by the connection.
labels Mapping[str, str]: Optional. Resource labels to represent user provided metadata.
name str: Unique resource name of the connection. The name is ignored when creating a connection.
state str: The current state of the connection.
type str: The type of network connectivity used by the connection.
uid str: A unique identifier for the instance generated by the system.
update_time str: Timestamp when the resource was last modified.

applicationEndpoint Property Map: Address of the remote application endpoint for the BeyondCorp Connection.
connectors List<String>: Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
createTime String: Timestamp when the resource was created.
displayName String: Optional. An arbitrary user-provided name for the connection. Cannot exceed 64 characters.
gateway Property Map: Optional. Gateway used by the connection.
labels Map<String>: Optional. Resource labels to represent user provided metadata.
name String: Unique resource name of the connection. The name is ignored when creating a connection.
state String: The current state of the connection.
type String: The type of network connectivity used by the connection.
uid String: A unique identifier for the instance generated by the system.
updateTime String: Timestamp when the resource was last modified.

Supporting Types

ApplicationEndpointResponse

Host string: Hostname or IP address of the remote application endpoint.
Port int: Port of the remote application endpoint.

Host string: Hostname or IP address of the remote application endpoint.
Port int: Port of the remote application endpoint.

host String: Hostname or IP address of the remote application endpoint.
port Integer: Port of the remote application endpoint.

host string: Hostname or IP address of the remote application endpoint.
port number: Port of the remote application endpoint.

host str: Hostname or IP address of the remote application endpoint.
port int: Port of the remote application endpoint.

host String: Hostname or IP address of the remote application endpoint.
port Number: Port of the remote application endpoint.

GatewayResponse

Type string: The type of hosting used by the gateway.
Uri string: Server-defined URI for this resource.
UserPort int: User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.

Type string: The type of hosting used by the gateway.
Uri string: Server-defined URI for this resource.
UserPort int: User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.

type String: The type of hosting used by the gateway.
uri String: Server-defined URI for this resource.
userPort Integer: User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.

type string: The type of hosting used by the gateway.
uri string: Server-defined URI for this resource.
userPort number: User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.

type str: The type of hosting used by the gateway.
uri str: Server-defined URI for this resource.
user_port int: User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.

type String: The type of hosting used by the gateway.
uri String: Server-defined URI for this resource.
userPort Number: User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0