Google Cloud Native v0.28.0, Feb 2 23

google-native.beyondcorp/v1alpha.Connector

Creates a new Connector in a given project and location.

Create Connector Resource

new Connector(name: string, args: ConnectorArgs, opts?: CustomResourceOptions);

@overload
def Connector(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              connector_id: Optional[str] = None,
              display_name: Optional[str] = None,
              labels: Optional[Mapping[str, str]] = None,
              location: Optional[str] = None,
              name: Optional[str] = None,
              principal_info: Optional[PrincipalInfoArgs] = None,
              project: Optional[str] = None,
              request_id: Optional[str] = None,
              resource_info: Optional[ResourceInfoArgs] = None,
              validate_only: Optional[bool] = None)
@overload
def Connector(resource_name: str,
              args: ConnectorArgs,
              opts: Optional[ResourceOptions] = None)

func NewConnector(ctx *Context, name string, args ConnectorArgs, opts ...ResourceOption) (*Connector, error)

public Connector(string name, ConnectorArgs args, CustomResourceOptions? opts = null)

public Connector(String name, ConnectorArgs args)
public Connector(String name, ConnectorArgs args, CustomResourceOptions options)

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

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

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

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

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

PrincipalInfo Pulumi.GoogleNative.BeyondCorp.V1Alpha.Inputs.PrincipalInfoArgs: Principal information about the Identity of the connector.
ConnectorId string: Optional. User-settable connector resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
DisplayName string: Optional. An arbitrary user-provided name for the connector. Cannot exceed 64 characters.
Labels Dictionary<string, string>: Optional. Resource labels to represent user provided metadata.
Location string
Name string: Unique resource name of the connector. The name is ignored when creating a connector.
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 t he 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).
ResourceInfo Pulumi.GoogleNative.BeyondCorp.V1Alpha.Inputs.ResourceInfoArgs: Optional. Resource info of the connector.
ValidateOnly bool: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

PrincipalInfo PrincipalInfoArgs: Principal information about the Identity of the connector.
ConnectorId string: Optional. User-settable connector resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
DisplayName string: Optional. An arbitrary user-provided name for the connector. Cannot exceed 64 characters.
Labels map[string]string: Optional. Resource labels to represent user provided metadata.
Location string
Name string: Unique resource name of the connector. The name is ignored when creating a connector.
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 t he 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).
ResourceInfo ResourceInfoArgs: Optional. Resource info of the connector.
ValidateOnly bool: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

principalInfo PrincipalInfoArgs: Principal information about the Identity of the connector.
connectorId String: Optional. User-settable connector resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
displayName String: Optional. An arbitrary user-provided name for the connector. Cannot exceed 64 characters.
labels Map<String,String>: Optional. Resource labels to represent user provided metadata.
location String
name String: Unique resource name of the connector. The name is ignored when creating a connector.
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 t he 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).
resourceInfo ResourceInfoArgs: Optional. Resource info of the connector.
validateOnly Boolean: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

principalInfo PrincipalInfoArgs: Principal information about the Identity of the connector.
connectorId string: Optional. User-settable connector resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
displayName string: Optional. An arbitrary user-provided name for the connector. Cannot exceed 64 characters.
labels {[key: string]: string}: Optional. Resource labels to represent user provided metadata.
location string
name string: Unique resource name of the connector. The name is ignored when creating a connector.
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 t he 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).
resourceInfo ResourceInfoArgs: Optional. Resource info of the connector.
validateOnly boolean: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

principal_info PrincipalInfoArgs: Principal information about the Identity of the connector.
connector_id str: Optional. User-settable connector resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
display_name str: Optional. An arbitrary user-provided name for the connector. Cannot exceed 64 characters.
labels Mapping[str, str]: Optional. Resource labels to represent user provided metadata.
location str
name str: Unique resource name of the connector. The name is ignored when creating a connector.
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 t he 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).
resource_info ResourceInfoArgs: Optional. Resource info of the connector.
validate_only bool: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.

principalInfo Property Map: Principal information about the Identity of the connector.
connectorId String: Optional. User-settable connector resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.
displayName String: Optional. An arbitrary user-provided name for the connector. Cannot exceed 64 characters.
labels Map<String>: Optional. Resource labels to represent user provided metadata.
location String
name String: Unique resource name of the connector. The name is ignored when creating a connector.
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 t he 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).
resourceInfo Property Map: Optional. Resource info of the connector.
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 Connector 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 connector.
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 connector.
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 connector.
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 connector.
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 connector.
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 connector.
uid String: A unique identifier for the instance generated by the system.
updateTime String: Timestamp when the resource was last modified.

Supporting Types

PrincipalInfo

ServiceAccount Pulumi.GoogleNative.BeyondCorp.V1Alpha.Inputs.ServiceAccount: A GCP service account.

ServiceAccount ServiceAccount: A GCP service account.

serviceAccount ServiceAccount: A GCP service account.

serviceAccount ServiceAccount: A GCP service account.

service_account ServiceAccount: A GCP service account.

serviceAccount Property Map: A GCP service account.

PrincipalInfoResponse

ServiceAccount Pulumi.GoogleNative.BeyondCorp.V1Alpha.Inputs.ServiceAccountResponse: A GCP service account.

ServiceAccount ServiceAccountResponse: A GCP service account.

serviceAccount ServiceAccountResponse: A GCP service account.

serviceAccount ServiceAccountResponse: A GCP service account.

service_account ServiceAccountResponse: A GCP service account.

serviceAccount Property Map: A GCP service account.

ResourceInfo

Id string: Unique Id for the resource.
Resource Dictionary<string, string>: Specific details for the resource.
Status Pulumi.GoogleNative.BeyondCorp.V1Alpha.ResourceInfoStatus: Overall health status. Overall status is derived based on the status of each sub level resources.
Sub List<Pulumi.GoogleNative.BeyondCorp.V1Alpha.Inputs.ResourceInfo>: List of Info for the sub level resources.
Time string: The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

Id string: Unique Id for the resource.
Resource map[string]string: Specific details for the resource.
Status ResourceInfoStatus: Overall health status. Overall status is derived based on the status of each sub level resources.
Sub []ResourceInfo: List of Info for the sub level resources.
Time string: The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

id String: Unique Id for the resource.
resource Map<String,String>: Specific details for the resource.
status ResourceInfoStatus: Overall health status. Overall status is derived based on the status of each sub level resources.
sub List<ResourceInfo>: List of Info for the sub level resources.
time String: The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

id string: Unique Id for the resource.
resource {[key: string]: string}: Specific details for the resource.
status ResourceInfoStatus: Overall health status. Overall status is derived based on the status of each sub level resources.
sub ResourceInfo[]: List of Info for the sub level resources.
time string: The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

id str: Unique Id for the resource.
resource Mapping[str, str]: Specific details for the resource.
status ResourceInfoStatus: Overall health status. Overall status is derived based on the status of each sub level resources.
sub Sequence[ResourceInfo]: List of Info for the sub level resources.
time str: The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

id String: Unique Id for the resource.
resource Map<String>: Specific details for the resource.
status "HEALTH_STATUS_UNSPECIFIED" | "HEALTHY" | "UNHEALTHY" | "UNRESPONSIVE" | "DEGRADED": Overall health status. Overall status is derived based on the status of each sub level resources.
sub List<Property Map>: List of Info for the sub level resources.
time String: The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

ResourceInfoResponse

Resource Dictionary<string, string>: Specific details for the resource.
Status string: Overall health status. Overall status is derived based on the status of each sub level resources.
Sub List<Pulumi.GoogleNative.BeyondCorp.V1Alpha.Inputs.ResourceInfoResponse>: List of Info for the sub level resources.
Time string: The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

Resource map[string]string: Specific details for the resource.
Status string: Overall health status. Overall status is derived based on the status of each sub level resources.
Sub []ResourceInfoResponse: List of Info for the sub level resources.
Time string: The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

resource Map<String,String>: Specific details for the resource.
status String: Overall health status. Overall status is derived based on the status of each sub level resources.
sub List<ResourceInfoResponse>: List of Info for the sub level resources.
time String: The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

resource {[key: string]: string}: Specific details for the resource.
status string: Overall health status. Overall status is derived based on the status of each sub level resources.
sub ResourceInfoResponse[]: List of Info for the sub level resources.
time string: The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

resource Mapping[str, str]: Specific details for the resource.
status str: Overall health status. Overall status is derived based on the status of each sub level resources.
sub Sequence[ResourceInfoResponse]: List of Info for the sub level resources.
time str: The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

resource Map<String>: Specific details for the resource.
status String: Overall health status. Overall status is derived based on the status of each sub level resources.
sub List<Property Map>: List of Info for the sub level resources.
time String: The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

ResourceInfoStatus

HealthStatusUnspecified: HEALTH_STATUS_UNSPECIFIED
Health status is unknown: not initialized or failed to retrieve.
Healthy: HEALTHY
The resource is healthy.
Unhealthy: UNHEALTHY
The resource is unhealthy.
Unresponsive: UNRESPONSIVE
The resource is unresponsive.
Degraded: DEGRADED
Some sub-resources are UNHEALTHY.

ResourceInfoStatusHealthStatusUnspecified: HEALTH_STATUS_UNSPECIFIED
Health status is unknown: not initialized or failed to retrieve.
ResourceInfoStatusHealthy: HEALTHY
The resource is healthy.
ResourceInfoStatusUnhealthy: UNHEALTHY
The resource is unhealthy.
ResourceInfoStatusUnresponsive: UNRESPONSIVE
The resource is unresponsive.
ResourceInfoStatusDegraded: DEGRADED
Some sub-resources are UNHEALTHY.

HealthStatusUnspecified: HEALTH_STATUS_UNSPECIFIED
Health status is unknown: not initialized or failed to retrieve.
Healthy: HEALTHY
The resource is healthy.
Unhealthy: UNHEALTHY
The resource is unhealthy.
Unresponsive: UNRESPONSIVE
The resource is unresponsive.
Degraded: DEGRADED
Some sub-resources are UNHEALTHY.

HealthStatusUnspecified: HEALTH_STATUS_UNSPECIFIED
Health status is unknown: not initialized or failed to retrieve.
Healthy: HEALTHY
The resource is healthy.
Unhealthy: UNHEALTHY
The resource is unhealthy.
Unresponsive: UNRESPONSIVE
The resource is unresponsive.
Degraded: DEGRADED
Some sub-resources are UNHEALTHY.

HEALTH_STATUS_UNSPECIFIED: HEALTH_STATUS_UNSPECIFIED
Health status is unknown: not initialized or failed to retrieve.
HEALTHY: HEALTHY
The resource is healthy.
UNHEALTHY: UNHEALTHY
The resource is unhealthy.
UNRESPONSIVE: UNRESPONSIVE
The resource is unresponsive.
DEGRADED: DEGRADED
Some sub-resources are UNHEALTHY.

"HEALTH_STATUS_UNSPECIFIED": HEALTH_STATUS_UNSPECIFIED
Health status is unknown: not initialized or failed to retrieve.
"HEALTHY": HEALTHY
The resource is healthy.
"UNHEALTHY": UNHEALTHY
The resource is unhealthy.
"UNRESPONSIVE": UNRESPONSIVE
The resource is unresponsive.
"DEGRADED": DEGRADED
Some sub-resources are UNHEALTHY.

ServiceAccount

Email string: Email address of the service account.

Email string: Email address of the service account.

email String: Email address of the service account.

email string: Email address of the service account.

email str: Email address of the service account.

email String: Email address of the service account.

ServiceAccountResponse

Email string: Email address of the service account.

Email string: Email address of the service account.

email String: Email address of the service account.

email string: Email address of the service account.

email str: Email address of the service account.

email String: Email address of the service account.

Package Details

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