Google Cloud Native v0.30.0, Apr 14 23

google-native.beyondcorp/v1alpha.Connection

Explore with Pulumi AI

Creates a new Connection in a given project and location.

Create Connection Resource

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);

@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               application_endpoint: Optional[ApplicationEndpointArgs] = None,
               connection_id: Optional[str] = None,
               connectors: Optional[Sequence[str]] = None,
               display_name: Optional[str] = None,
               gateway: Optional[GatewayArgs] = None,
               labels: Optional[Mapping[str, str]] = None,
               location: Optional[str] = None,
               name: Optional[str] = None,
               project: Optional[str] = None,
               request_id: Optional[str] = None,
               type: Optional[ConnectionType] = None,
               validate_only: Optional[bool] = None)
@overload
def Connection(resource_name: str,
               args: ConnectionArgs,
               opts: Optional[ResourceOptions] = None)

func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)

public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)

public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)

type: google-native:beyondcorp/v1alpha:Connection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConnectionArgs: 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 ConnectionArgs: 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 ConnectionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Connection 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 Connection resource accepts the following input properties:

ApplicationEndpoint Pulumi.GoogleNative.BeyondCorp.V1Alpha.Inputs.ApplicationEndpointArgs: Address of the remote application endpoint for the BeyondCorp Connection.
Type Pulumi.GoogleNative.BeyondCorp.V1Alpha.ConnectionType: The type of network connectivity used by the connection.
ConnectionId string: Optional. User-settable connection resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
Connectors List<string>: Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
DisplayName string: Optional. An arbitrary user-provided name for the connection. Cannot exceed 64 characters.
Gateway Pulumi.GoogleNative.BeyondCorp.V1Alpha.Inputs.GatewayArgs: Optional. Gateway used by the connection.
Labels Dictionary<string, string>: Optional. Resource labels to represent user provided metadata.
Location string
Name string: Unique resource name of the connection. The name is ignored when creating a connection.
Project string
RequestId string: Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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).
ValidateOnly bool: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

ApplicationEndpoint ApplicationEndpointArgs: Address of the remote application endpoint for the BeyondCorp Connection.
Type ConnectionType: The type of network connectivity used by the connection.
ConnectionId string: Optional. User-settable connection resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
Connectors []string: Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
DisplayName string: Optional. An arbitrary user-provided name for the connection. Cannot exceed 64 characters.
Gateway GatewayArgs: Optional. Gateway used by the connection.
Labels map[string]string: Optional. Resource labels to represent user provided metadata.
Location string
Name string: Unique resource name of the connection. The name is ignored when creating a connection.
Project string
RequestId string: Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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).
ValidateOnly bool: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

applicationEndpoint ApplicationEndpointArgs: Address of the remote application endpoint for the BeyondCorp Connection.
type ConnectionType: The type of network connectivity used by the connection.
connectionId String: Optional. User-settable connection resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
connectors List<String>: Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
displayName String: Optional. An arbitrary user-provided name for the connection. Cannot exceed 64 characters.
gateway GatewayArgs: Optional. Gateway used by the connection.
labels Map<String,String>: Optional. Resource labels to represent user provided metadata.
location String
name String: Unique resource name of the connection. The name is ignored when creating a connection.
project String
requestId String: Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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).
validateOnly Boolean: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

applicationEndpoint ApplicationEndpointArgs: Address of the remote application endpoint for the BeyondCorp Connection.
type ConnectionType: The type of network connectivity used by the connection.
connectionId string: Optional. User-settable connection resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
connectors string[]: Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
displayName string: Optional. An arbitrary user-provided name for the connection. Cannot exceed 64 characters.
gateway GatewayArgs: Optional. Gateway used by the connection.
labels {[key: string]: string}: Optional. Resource labels to represent user provided metadata.
location string
name string: Unique resource name of the connection. The name is ignored when creating a connection.
project string
requestId string: Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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).
validateOnly boolean: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

application_endpoint ApplicationEndpointArgs: Address of the remote application endpoint for the BeyondCorp Connection.
type ConnectionType: The type of network connectivity used by the connection.
connection_id str: Optional. User-settable connection resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
connectors Sequence[str]: Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
display_name str: Optional. An arbitrary user-provided name for the connection. Cannot exceed 64 characters.
gateway GatewayArgs: Optional. Gateway used by the connection.
labels Mapping[str, str]: Optional. Resource labels to represent user provided metadata.
location str
name str: Unique resource name of the connection. The name is ignored when creating a connection.
project str
request_id str: Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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).
validate_only bool: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

applicationEndpoint Property Map: Address of the remote application endpoint for the BeyondCorp Connection.
type "TYPE_UNSPECIFIED" | "TCP_PROXY": The type of network connectivity used by the connection.
connectionId String: Optional. User-settable connection resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
connectors List<String>: Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
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.
location String
name String: Unique resource name of the connection. The name is ignored when creating a connection.
project String
requestId String: Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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).
validateOnly Boolean: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

Outputs

All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:

CreateTime string: Timestamp when the resource was created.
Id string: The provider-assigned unique ID for this managed resource.
State string: The current state of the connection.
Uid string: A unique identifier for the instance generated by the system.
UpdateTime string: Timestamp when the resource was last modified.

CreateTime string: Timestamp when the resource was created.
Id string: The provider-assigned unique ID for this managed resource.
State string: The current state of the connection.
Uid string: A unique identifier for the instance generated by the system.
UpdateTime string: Timestamp when the resource was last modified.

createTime String: Timestamp when the resource was created.
id String: The provider-assigned unique ID for this managed resource.
state String: The current state of the connection.
uid String: A unique identifier for the instance generated by the system.
updateTime String: Timestamp when the resource was last modified.

createTime string: Timestamp when the resource was created.
id string: The provider-assigned unique ID for this managed resource.
state string: The current state of the connection.
uid string: A unique identifier for the instance generated by the system.
updateTime string: Timestamp when the resource was last modified.

create_time str: Timestamp when the resource was created.
id str: The provider-assigned unique ID for this managed resource.
state str: The current state of the connection.
uid str: A unique identifier for the instance generated by the system.
update_time str: Timestamp when the resource was last modified.

createTime String: Timestamp when the resource was created.
id String: The provider-assigned unique ID for this managed resource.
state String: The current state of 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

ApplicationEndpoint

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.

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.

ConnectionType

TypeUnspecified: TYPE_UNSPECIFIED
Default value. This value is unused.
TcpProxy: TCP_PROXY
TCP Proxy based BeyondCorp Connection. API will default to this if unset.

ConnectionTypeTypeUnspecified: TYPE_UNSPECIFIED
Default value. This value is unused.
ConnectionTypeTcpProxy: TCP_PROXY
TCP Proxy based BeyondCorp Connection. API will default to this if unset.

TypeUnspecified: TYPE_UNSPECIFIED
Default value. This value is unused.
TcpProxy: TCP_PROXY
TCP Proxy based BeyondCorp Connection. API will default to this if unset.

TypeUnspecified: TYPE_UNSPECIFIED
Default value. This value is unused.
TcpProxy: TCP_PROXY
TCP Proxy based BeyondCorp Connection. API will default to this if unset.

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

"TYPE_UNSPECIFIED": TYPE_UNSPECIFIED
Default value. This value is unused.
"TCP_PROXY": TCP_PROXY
TCP Proxy based BeyondCorp Connection. API will default to this if unset.

Gateway

Type Pulumi.GoogleNative.BeyondCorp.V1Alpha.GatewayType: The type of hosting used by the gateway.

Type GatewayType: The type of hosting used by the gateway.

type GatewayType: The type of hosting used by the gateway.

type GatewayType: The type of hosting used by the gateway.

type GatewayType: The type of hosting used by the gateway.

type "TYPE_UNSPECIFIED" | "GCP_REGIONAL_MIG": The type of hosting used by the gateway.

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.

GatewayType

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

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

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

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

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

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

Package Details

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