1. Packages
  2. Google Cloud Native
  3. API Docs
  4. beyondcorp
  5. beyondcorp/v1alpha
  6. Connection

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.beyondcorp/v1alpha.Connection

Explore with Pulumi AI

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Creates a new Connection in a given project and location.

Create Connection Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
@overload
def Connection(resource_name: str,
               args: ConnectionArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               application_endpoint: Optional[ApplicationEndpointArgs] = None,
               type: Optional[ConnectionType] = 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)
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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ConnectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var connectionResource = new GoogleNative.BeyondCorp.V1Alpha.Connection("connectionResource", new()
{
    ApplicationEndpoint = new GoogleNative.BeyondCorp.V1Alpha.Inputs.ApplicationEndpointArgs
    {
        Host = "string",
        Port = 0,
    },
    Type = GoogleNative.BeyondCorp.V1Alpha.ConnectionType.TypeUnspecified,
    ConnectionId = "string",
    Connectors = new[]
    {
        "string",
    },
    DisplayName = "string",
    Gateway = new GoogleNative.BeyondCorp.V1Alpha.Inputs.GatewayArgs
    {
        Type = GoogleNative.BeyondCorp.V1Alpha.GatewayType.TypeUnspecified,
    },
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Name = "string",
    Project = "string",
    RequestId = "string",
});
Copy
example, err := beyondcorpv1alpha.NewConnection(ctx, "connectionResource", &beyondcorpv1alpha.ConnectionArgs{
	ApplicationEndpoint: &beyondcorp.ApplicationEndpointArgs{
		Host: pulumi.String("string"),
		Port: pulumi.Int(0),
	},
	Type:         beyondcorpv1alpha.ConnectionTypeTypeUnspecified,
	ConnectionId: pulumi.String("string"),
	Connectors: pulumi.StringArray{
		pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	Gateway: &beyondcorp.GatewayArgs{
		Type: beyondcorpv1alpha.GatewayTypeTypeUnspecified,
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location:  pulumi.String("string"),
	Name:      pulumi.String("string"),
	Project:   pulumi.String("string"),
	RequestId: pulumi.String("string"),
})
Copy
var connectionResource = new Connection("connectionResource", ConnectionArgs.builder()
    .applicationEndpoint(ApplicationEndpointArgs.builder()
        .host("string")
        .port(0)
        .build())
    .type("TYPE_UNSPECIFIED")
    .connectionId("string")
    .connectors("string")
    .displayName("string")
    .gateway(GatewayArgs.builder()
        .type("TYPE_UNSPECIFIED")
        .build())
    .labels(Map.of("string", "string"))
    .location("string")
    .name("string")
    .project("string")
    .requestId("string")
    .build());
Copy
connection_resource = google_native.beyondcorp.v1alpha.Connection("connectionResource",
    application_endpoint={
        "host": "string",
        "port": 0,
    },
    type=google_native.beyondcorp.v1alpha.ConnectionType.TYPE_UNSPECIFIED,
    connection_id="string",
    connectors=["string"],
    display_name="string",
    gateway={
        "type": google_native.beyondcorp.v1alpha.GatewayType.TYPE_UNSPECIFIED,
    },
    labels={
        "string": "string",
    },
    location="string",
    name="string",
    project="string",
    request_id="string")
Copy
const connectionResource = new google_native.beyondcorp.v1alpha.Connection("connectionResource", {
    applicationEndpoint: {
        host: "string",
        port: 0,
    },
    type: google_native.beyondcorp.v1alpha.ConnectionType.TypeUnspecified,
    connectionId: "string",
    connectors: ["string"],
    displayName: "string",
    gateway: {
        type: google_native.beyondcorp.v1alpha.GatewayType.TypeUnspecified,
    },
    labels: {
        string: "string",
    },
    location: "string",
    name: "string",
    project: "string",
    requestId: "string",
});
Copy
type: google-native:beyondcorp/v1alpha:Connection
properties:
    applicationEndpoint:
        host: string
        port: 0
    connectionId: string
    connectors:
        - string
    displayName: string
    gateway:
        type: TYPE_UNSPECIFIED
    labels:
        string: string
    location: string
    name: string
    project: string
    requestId: string
    type: TYPE_UNSPECIFIED
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Connection resource accepts the following input properties:

ApplicationEndpoint This property is required. Pulumi.GoogleNative.BeyondCorp.V1Alpha.Inputs.ApplicationEndpoint
Address of the remote application endpoint for the BeyondCorp Connection.
Type This property is required. 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.Gateway
Optional. Gateway used by the connection.
Labels Dictionary<string, string>
Optional. Resource labels to represent user provided metadata.
Location Changes to this property will trigger replacement. string
Name string
Unique resource name of the connection. The name is ignored when creating a connection.
Project Changes to this property will trigger replacement. 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).
ApplicationEndpoint This property is required. ApplicationEndpointArgs
Address of the remote application endpoint for the BeyondCorp Connection.
Type This property is required. 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 Changes to this property will trigger replacement. string
Name string
Unique resource name of the connection. The name is ignored when creating a connection.
Project Changes to this property will trigger replacement. 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).
applicationEndpoint This property is required. ApplicationEndpoint
Address of the remote application endpoint for the BeyondCorp Connection.
type This property is required. 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 Gateway
Optional. Gateway used by the connection.
labels Map<String,String>
Optional. Resource labels to represent user provided metadata.
location Changes to this property will trigger replacement. String
name String
Unique resource name of the connection. The name is ignored when creating a connection.
project Changes to this property will trigger replacement. 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).
applicationEndpoint This property is required. ApplicationEndpoint
Address of the remote application endpoint for the BeyondCorp Connection.
type This property is required. 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 Gateway
Optional. Gateway used by the connection.
labels {[key: string]: string}
Optional. Resource labels to represent user provided metadata.
location Changes to this property will trigger replacement. string
name string
Unique resource name of the connection. The name is ignored when creating a connection.
project Changes to this property will trigger replacement. 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).
application_endpoint This property is required. ApplicationEndpointArgs
Address of the remote application endpoint for the BeyondCorp Connection.
type This property is required. 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 Changes to this property will trigger replacement. str
name str
Unique resource name of the connection. The name is ignored when creating a connection.
project Changes to this property will trigger replacement. 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).
applicationEndpoint This property is required. Property Map
Address of the remote application endpoint for the BeyondCorp Connection.
type This property is required. "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 Changes to this property will trigger replacement. String
name String
Unique resource name of the connection. The name is ignored when creating a connection.
project Changes to this property will trigger replacement. 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).

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
, ApplicationEndpointArgs

Host This property is required. string
Hostname or IP address of the remote application endpoint.
Port This property is required. int
Port of the remote application endpoint.
Host This property is required. string
Hostname or IP address of the remote application endpoint.
Port This property is required. int
Port of the remote application endpoint.
host This property is required. String
Hostname or IP address of the remote application endpoint.
port This property is required. Integer
Port of the remote application endpoint.
host This property is required. string
Hostname or IP address of the remote application endpoint.
port This property is required. number
Port of the remote application endpoint.
host This property is required. str
Hostname or IP address of the remote application endpoint.
port This property is required. int
Port of the remote application endpoint.
host This property is required. String
Hostname or IP address of the remote application endpoint.
port This property is required. Number
Port of the remote application endpoint.

ApplicationEndpointResponse
, ApplicationEndpointResponseArgs

Host This property is required. string
Hostname or IP address of the remote application endpoint.
Port This property is required. int
Port of the remote application endpoint.
Host This property is required. string
Hostname or IP address of the remote application endpoint.
Port This property is required. int
Port of the remote application endpoint.
host This property is required. String
Hostname or IP address of the remote application endpoint.
port This property is required. Integer
Port of the remote application endpoint.
host This property is required. string
Hostname or IP address of the remote application endpoint.
port This property is required. number
Port of the remote application endpoint.
host This property is required. str
Hostname or IP address of the remote application endpoint.
port This property is required. int
Port of the remote application endpoint.
host This property is required. String
Hostname or IP address of the remote application endpoint.
port This property is required. Number
Port of the remote application endpoint.

ConnectionType
, ConnectionTypeArgs

TypeUnspecified
TYPE_UNSPECIFIEDDefault value. This value is unused.
TcpProxy
TCP_PROXYTCP Proxy based BeyondCorp Connection. API will default to this if unset.
ConnectionTypeTypeUnspecified
TYPE_UNSPECIFIEDDefault value. This value is unused.
ConnectionTypeTcpProxy
TCP_PROXYTCP Proxy based BeyondCorp Connection. API will default to this if unset.
TypeUnspecified
TYPE_UNSPECIFIEDDefault value. This value is unused.
TcpProxy
TCP_PROXYTCP Proxy based BeyondCorp Connection. API will default to this if unset.
TypeUnspecified
TYPE_UNSPECIFIEDDefault value. This value is unused.
TcpProxy
TCP_PROXYTCP Proxy based BeyondCorp Connection. API will default to this if unset.
TYPE_UNSPECIFIED
TYPE_UNSPECIFIEDDefault value. This value is unused.
TCP_PROXY
TCP_PROXYTCP Proxy based BeyondCorp Connection. API will default to this if unset.
"TYPE_UNSPECIFIED"
TYPE_UNSPECIFIEDDefault value. This value is unused.
"TCP_PROXY"
TCP_PROXYTCP Proxy based BeyondCorp Connection. API will default to this if unset.

Gateway
, GatewayArgs

Type This property is required. Pulumi.GoogleNative.BeyondCorp.V1Alpha.GatewayType
The type of hosting used by the gateway.
Type This property is required. GatewayType
The type of hosting used by the gateway.
type This property is required. GatewayType
The type of hosting used by the gateway.
type This property is required. GatewayType
The type of hosting used by the gateway.
type This property is required. GatewayType
The type of hosting used by the gateway.
type This property is required. "TYPE_UNSPECIFIED" | "GCP_REGIONAL_MIG"
The type of hosting used by the gateway.

GatewayResponse
, GatewayResponseArgs

Type This property is required. string
The type of hosting used by the gateway.
Uri This property is required. string
Server-defined URI for this resource.
UserPort This property is required. int
User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.
Type This property is required. string
The type of hosting used by the gateway.
Uri This property is required. string
Server-defined URI for this resource.
UserPort This property is required. int
User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.
type This property is required. String
The type of hosting used by the gateway.
uri This property is required. String
Server-defined URI for this resource.
userPort This property is required. Integer
User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.
type This property is required. string
The type of hosting used by the gateway.
uri This property is required. string
Server-defined URI for this resource.
userPort This property is required. number
User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.
type This property is required. str
The type of hosting used by the gateway.
uri This property is required. str
Server-defined URI for this resource.
user_port This property is required. int
User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.
type This property is required. String
The type of hosting used by the gateway.
uri This property is required. String
Server-defined URI for this resource.
userPort This property is required. Number
User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.

GatewayType
, GatewayTypeArgs

TypeUnspecified
TYPE_UNSPECIFIEDDefault value. This value is unused.
GcpRegionalMig
GCP_REGIONAL_MIGGateway hosted in a GCP regional managed instance group.
GatewayTypeTypeUnspecified
TYPE_UNSPECIFIEDDefault value. This value is unused.
GatewayTypeGcpRegionalMig
GCP_REGIONAL_MIGGateway hosted in a GCP regional managed instance group.
TypeUnspecified
TYPE_UNSPECIFIEDDefault value. This value is unused.
GcpRegionalMig
GCP_REGIONAL_MIGGateway hosted in a GCP regional managed instance group.
TypeUnspecified
TYPE_UNSPECIFIEDDefault value. This value is unused.
GcpRegionalMig
GCP_REGIONAL_MIGGateway hosted in a GCP regional managed instance group.
TYPE_UNSPECIFIED
TYPE_UNSPECIFIEDDefault value. This value is unused.
GCP_REGIONAL_MIG
GCP_REGIONAL_MIGGateway hosted in a GCP regional managed instance group.
"TYPE_UNSPECIFIED"
TYPE_UNSPECIFIEDDefault value. This value is unused.
"GCP_REGIONAL_MIG"
GCP_REGIONAL_MIGGateway hosted in a GCP regional managed instance group.

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.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi