REST Resource: projects.locations.appConnections

Resource: AppConnection

A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "displayName": string,
  "uid": string,
  "type": enum (Type),
  "applicationEndpoint": {
    object (ApplicationEndpoint)
  },
  "connectors": [
    string
  ],
  "state": enum (State),
  "gateway": {
    object (Gateway)
  }
}
Fields
name

string

Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection.

createTime

string (Timestamp format)

Output only. Timestamp when the resource was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Timestamp when the resource was last modified.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Optional. Resource labels to represent user provided metadata.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayName

string

Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters.

uid

string

Output only. A unique identifier for the instance generated by the system.

type

enum (Type)

Required. The type of network connectivity used by the AppConnection.

applicationEndpoint

object (ApplicationEndpoint)

Required. Address of the remote application endpoint for the BeyondCorp AppConnection.

connectors[]

string

Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection.

state

enum (State)

Output only. The current state of the AppConnection.

gateway

object (Gateway)

Optional. Gateway used by the AppConnection.

Type

Enum containing list of all possible network connectivity options supported by BeyondCorp AppConnection.

Enums
TYPE_UNSPECIFIED Default value. This value is unused.
TCP_PROXY TCP Proxy based BeyondCorp AppConnection. API will default to this if unset.

ApplicationEndpoint

ApplicationEndpoint represents a remote application endpoint.

JSON representation
{
  "host": string,
  "port": integer
}
Fields
host

string

Required. Hostname or IP address of the remote application endpoint.

port

integer

Required. Port of the remote application endpoint.

State

Represents the different states of a AppConnection.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
CREATING AppConnection is being created.
CREATED AppConnection has been created.
UPDATING AppConnection's configuration is being updated.
DELETING AppConnection is being deleted.
DOWN AppConnection is down and may be restored in the future. This happens when CCFE sends ProjectState = OFF.

Gateway

Gateway represents a user facing component that serves as an entrance to enable connectivity.

JSON representation
{
  "type": enum (Type),
  "uri": string,
  "ingressPort": integer,
  "appGateway": string
}
Fields
type

enum (Type)

Required. The type of hosting used by the gateway.

uri

string

Output only. Server-defined URI for this resource.

ingressPort

integer

Output only. Ingress port reserved on the gateways for this AppConnection, if not specified or zero, the default port is 19443.

appGateway

string

Required. AppGateway name in following format: projects/{project_id}/locations/{locationId}/appgateways/{gateway_id}

Type

Enum listing possible gateway hosting options.

Enums
TYPE_UNSPECIFIED Default value. This value is unused.
GCP_REGIONAL_MIG Gateway hosted in a GCP regional managed instance group.

Methods

create

Creates a new AppConnection in a given project and location.

delete

Deletes a single AppConnection.

get

Gets details of a single AppConnection.

getIamPolicy

Gets the access control policy for a resource.

list

Lists AppConnections in a given project and location.

patch

Updates the parameters of a single AppConnection.

resolve

Resolves AppConnections details for a given AppConnector.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.