Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. beyondcorp
  5. beyondcorp/v1alpha
  6. Connector

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
pulumi/pulumi-google-native

google-native.beyondcorp/v1alpha.Connector

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
pulumi/pulumi-google-native

Creates a new Connector in a given project and location.

Create Connector Resource

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

Constructor syntax

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

@overload
def Connector(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              principal_info: Optional[PrincipalInfoArgs] = 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,
              project: Optional[str] = None,
              request_id: Optional[str] = None,
              resource_info: Optional[ResourceInfoArgs] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ConnectorArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. ConnectorArgs
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. ConnectorArgs
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. ConnectorArgs
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 connectorResource = new GoogleNative.BeyondCorp.V1Alpha.Connector("connectorResource", new()
{
    PrincipalInfo = new GoogleNative.BeyondCorp.V1Alpha.Inputs.PrincipalInfoArgs
    {
        ServiceAccount = new GoogleNative.BeyondCorp.V1Alpha.Inputs.ServiceAccountArgs
        {
            Email = "string",
        },
    },
    ConnectorId = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Name = "string",
    Project = "string",
    RequestId = "string",
    ResourceInfo = new GoogleNative.BeyondCorp.V1Alpha.Inputs.ResourceInfoArgs
    {
        Id = "string",
        Resource = 
        {
            { "string", "string" },
        },
        Status = GoogleNative.BeyondCorp.V1Alpha.ResourceInfoStatus.HealthStatusUnspecified,
        Sub = new[]
        {
            resourceInfo,
        },
        Time = "string",
    },
});
Copy
example, err := beyondcorpv1alpha.NewConnector(ctx, "connectorResource", &beyondcorpv1alpha.ConnectorArgs{
	PrincipalInfo: &beyondcorp.PrincipalInfoArgs{
		ServiceAccount: &beyondcorp.ServiceAccountArgs{
			Email: pulumi.String("string"),
		},
	},
	ConnectorId: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location:  pulumi.String("string"),
	Name:      pulumi.String("string"),
	Project:   pulumi.String("string"),
	RequestId: pulumi.String("string"),
	ResourceInfo: &beyondcorp.ResourceInfoArgs{
		Id: pulumi.String("string"),
		Resource: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Status: beyondcorpv1alpha.ResourceInfoStatusHealthStatusUnspecified,
		Sub: beyondcorp.ResourceInfoArray{
			resourceInfo,
		},
		Time: pulumi.String("string"),
	},
})
Copy
var connectorResource = new Connector("connectorResource", ConnectorArgs.builder()
    .principalInfo(PrincipalInfoArgs.builder()
        .serviceAccount(ServiceAccountArgs.builder()
            .email("string")
            .build())
        .build())
    .connectorId("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .name("string")
    .project("string")
    .requestId("string")
    .resourceInfo(ResourceInfoArgs.builder()
        .id("string")
        .resource(Map.of("string", "string"))
        .status("HEALTH_STATUS_UNSPECIFIED")
        .sub(resourceInfo)
        .time("string")
        .build())
    .build());
Copy
connector_resource = google_native.beyondcorp.v1alpha.Connector("connectorResource",
    principal_info={
        "service_account": {
            "email": "string",
        },
    },
    connector_id="string",
    display_name="string",
    labels={
        "string": "string",
    },
    location="string",
    name="string",
    project="string",
    request_id="string",
    resource_info={
        "id": "string",
        "resource": {
            "string": "string",
        },
        "status": google_native.beyondcorp.v1alpha.ResourceInfoStatus.HEALTH_STATUS_UNSPECIFIED,
        "sub": [resource_info],
        "time": "string",
    })
Copy
const connectorResource = new google_native.beyondcorp.v1alpha.Connector("connectorResource", {
    principalInfo: {
        serviceAccount: {
            email: "string",
        },
    },
    connectorId: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    location: "string",
    name: "string",
    project: "string",
    requestId: "string",
    resourceInfo: {
        id: "string",
        resource: {
            string: "string",
        },
        status: google_native.beyondcorp.v1alpha.ResourceInfoStatus.HealthStatusUnspecified,
        sub: [resourceInfo],
        time: "string",
    },
});
Copy
type: google-native:beyondcorp/v1alpha:Connector
properties:
    connectorId: string
    displayName: string
    labels:
        string: string
    location: string
    name: string
    principalInfo:
        serviceAccount:
            email: string
    project: string
    requestId: string
    resourceInfo:
        id: string
        resource:
            string: string
        status: HEALTH_STATUS_UNSPECIFIED
        sub:
            - ${resourceInfo}
        time: string
Copy

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

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

The Connector resource accepts the following input properties:

PrincipalInfo This property is required. Pulumi.GoogleNative.BeyondCorp.V1Alpha.Inputs.PrincipalInfo
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 Changes to this property will trigger replacement. string
Name string
Unique resource name of the connector. The name is ignored when creating a connector.
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).
ResourceInfo Pulumi.GoogleNative.BeyondCorp.V1Alpha.Inputs.ResourceInfo
Optional. Resource info of the connector.
PrincipalInfo This property is required. 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 Changes to this property will trigger replacement. string
Name string
Unique resource name of the connector. The name is ignored when creating a connector.
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).
ResourceInfo ResourceInfoArgs
Optional. Resource info of the connector.
principalInfo This property is required. PrincipalInfo
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 Changes to this property will trigger replacement. String
name String
Unique resource name of the connector. The name is ignored when creating a connector.
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).
resourceInfo ResourceInfo
Optional. Resource info of the connector.
principalInfo This property is required. PrincipalInfo
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 Changes to this property will trigger replacement. string
name string
Unique resource name of the connector. The name is ignored when creating a connector.
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).
resourceInfo ResourceInfo
Optional. Resource info of the connector.
principal_info This property is required. 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 Changes to this property will trigger replacement. str
name str
Unique resource name of the connector. The name is ignored when creating a connector.
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).
resource_info ResourceInfoArgs
Optional. Resource info of the connector.
principalInfo This property is required. 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 Changes to this property will trigger replacement. String
name String
Unique resource name of the connector. The name is ignored when creating a connector.
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).
resourceInfo Property Map
Optional. Resource info of the connector.

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

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

ServiceAccount This property is required. ServiceAccountResponse
A GCP service account.
serviceAccount This property is required. ServiceAccountResponse
A GCP service account.
serviceAccount This property is required. ServiceAccountResponse
A GCP service account.
service_account This property is required. ServiceAccountResponse
A GCP service account.
serviceAccount This property is required. Property Map
A GCP service account.

ResourceInfo
, ResourceInfoArgs

Id This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
, ResourceInfoResponseArgs

Resource This property is required. Dictionary<string, string>
Specific details for the resource.
Status This property is required. string
Overall health status. Overall status is derived based on the status of each sub level resources.
Sub This property is required. List<Pulumi.GoogleNative.BeyondCorp.V1Alpha.Inputs.ResourceInfoResponse>
List of Info for the sub level resources.
Time This property is required. string
The timestamp to collect the info. It is suggested to be set by the topmost level resource only.
Resource This property is required. map[string]string
Specific details for the resource.
Status This property is required. string
Overall health status. Overall status is derived based on the status of each sub level resources.
Sub This property is required. []ResourceInfoResponse
List of Info for the sub level resources.
Time This property is required. string
The timestamp to collect the info. It is suggested to be set by the topmost level resource only.
resource This property is required. Map<String,String>
Specific details for the resource.
status This property is required. String
Overall health status. Overall status is derived based on the status of each sub level resources.
sub This property is required. List<ResourceInfoResponse>
List of Info for the sub level resources.
time This property is required. String
The timestamp to collect the info. It is suggested to be set by the topmost level resource only.
resource This property is required. {[key: string]: string}
Specific details for the resource.
status This property is required. string
Overall health status. Overall status is derived based on the status of each sub level resources.
sub This property is required. ResourceInfoResponse[]
List of Info for the sub level resources.
time This property is required. string
The timestamp to collect the info. It is suggested to be set by the topmost level resource only.
resource This property is required. Mapping[str, str]
Specific details for the resource.
status This property is required. str
Overall health status. Overall status is derived based on the status of each sub level resources.
sub This property is required. Sequence[ResourceInfoResponse]
List of Info for the sub level resources.
time This property is required. str
The timestamp to collect the info. It is suggested to be set by the topmost level resource only.
resource This property is required. Map<String>
Specific details for the resource.
status This property is required. String
Overall health status. Overall status is derived based on the status of each sub level resources.
sub This property is required. List<Property Map>
List of Info for the sub level resources.
time This property is required. String
The timestamp to collect the info. It is suggested to be set by the topmost level resource only.

ResourceInfoStatus
, ResourceInfoStatusArgs

HealthStatusUnspecified
HEALTH_STATUS_UNSPECIFIEDHealth status is unknown: not initialized or failed to retrieve.
Healthy
HEALTHYThe resource is healthy.
Unhealthy
UNHEALTHYThe resource is unhealthy.
Unresponsive
UNRESPONSIVEThe resource is unresponsive.
Degraded
DEGRADEDSome sub-resources are UNHEALTHY.
ResourceInfoStatusHealthStatusUnspecified
HEALTH_STATUS_UNSPECIFIEDHealth status is unknown: not initialized or failed to retrieve.
ResourceInfoStatusHealthy
HEALTHYThe resource is healthy.
ResourceInfoStatusUnhealthy
UNHEALTHYThe resource is unhealthy.
ResourceInfoStatusUnresponsive
UNRESPONSIVEThe resource is unresponsive.
ResourceInfoStatusDegraded
DEGRADEDSome sub-resources are UNHEALTHY.
HealthStatusUnspecified
HEALTH_STATUS_UNSPECIFIEDHealth status is unknown: not initialized or failed to retrieve.
Healthy
HEALTHYThe resource is healthy.
Unhealthy
UNHEALTHYThe resource is unhealthy.
Unresponsive
UNRESPONSIVEThe resource is unresponsive.
Degraded
DEGRADEDSome sub-resources are UNHEALTHY.
HealthStatusUnspecified
HEALTH_STATUS_UNSPECIFIEDHealth status is unknown: not initialized or failed to retrieve.
Healthy
HEALTHYThe resource is healthy.
Unhealthy
UNHEALTHYThe resource is unhealthy.
Unresponsive
UNRESPONSIVEThe resource is unresponsive.
Degraded
DEGRADEDSome sub-resources are UNHEALTHY.
HEALTH_STATUS_UNSPECIFIED
HEALTH_STATUS_UNSPECIFIEDHealth status is unknown: not initialized or failed to retrieve.
HEALTHY
HEALTHYThe resource is healthy.
UNHEALTHY
UNHEALTHYThe resource is unhealthy.
UNRESPONSIVE
UNRESPONSIVEThe resource is unresponsive.
DEGRADED
DEGRADEDSome sub-resources are UNHEALTHY.
"HEALTH_STATUS_UNSPECIFIED"
HEALTH_STATUS_UNSPECIFIEDHealth status is unknown: not initialized or failed to retrieve.
"HEALTHY"
HEALTHYThe resource is healthy.
"UNHEALTHY"
UNHEALTHYThe resource is unhealthy.
"UNRESPONSIVE"
UNRESPONSIVEThe resource is unresponsive.
"DEGRADED"
DEGRADEDSome sub-resources are UNHEALTHY.

ServiceAccount
, ServiceAccountArgs

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

Email This property is required. string
Email address of the service account.
Email This property is required. string
Email address of the service account.
email This property is required. String
Email address of the service account.
email This property is required. string
Email address of the service account.
email This property is required. str
Email address of the service account.
email This property is required. String
Email address of the service account.

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
pulumi/pulumi-google-native