gcp_connectors_connection
ancestors
Type: UNORDERED_LIST_STRING
async_operations_enabled
Type: BOOLEAN
Provider name: asyncOperationsEnabled
Description: Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API.
auth_config
Type: STRUCT
Provider name: authConfig
Description: Optional. Configuration for establishing the connection’s authentication with an external system.
additional_variables
Type: UNORDERED_LIST_STRUCT
Provider name: additionalVariables
Description: List containing additional auth configs.
bool_value
Type: BOOLEAN
Provider name: boolValue
Description: Value is a bool.
encryption_key_value
Type: STRUCT
Provider name: encryptionKeyValue
Description: Value is a Encryption Key.
kms_key_name
Type: STRING
Provider name: kmsKeyName
Description: The [KMS key name] with which the content of the Operation is encrypted. The expected format: projects/*/locations/*/keyRings/*/cryptoKeys/*
. Will be empty string if google managed.
type
Type: STRING
Provider name: type
Description: Type.
Possible values:
TYPE_UNSPECIFIED
- Value type is not specified.
GOOGLE_MANAGED
- Google Managed.
CUSTOMER_MANAGED
- Customer Managed.
int_value
Type: INT64
Provider name: intValue
Description: Value is an integer
key
Type: STRING
Provider name: key
Description: Key of the config variable.
secret_value
Type: STRUCT
Provider name: secretValue
Description: Value is a secret.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
string_value
Type: STRING
Provider name: stringValue
Description: Value is a string.
auth_key
Type: STRING
Provider name: authKey
Description: Identifier key for auth config
auth_type
Type: STRING
Provider name: authType
Description: The type of authentication configured.
Possible values:
AUTH_TYPE_UNSPECIFIED
- Authentication type not specified.
USER_PASSWORD
- Username and Password Authentication.
OAUTH2_JWT_BEARER
- JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication
OAUTH2_CLIENT_CREDENTIALS
- Oauth 2.0 Client Credentials Grant Authentication
SSH_PUBLIC_KEY
- SSH Public Key Authentication
OAUTH2_AUTH_CODE_FLOW
- Oauth 2.0 Authorization Code Flow
GOOGLE_AUTHENTICATION
- Google authentication
OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED
- Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client
oauth2_auth_code_flow
Type: STRUCT
Provider name: oauth2AuthCodeFlow
Description: Oauth2AuthCodeFlow.
auth_code
Type: STRING
Provider name: authCode
Description: Authorization code to be exchanged for access and refresh tokens.
auth_uri
Type: STRING
Provider name: authUri
Description: Auth URL for Authorization Code Flow
client_id
Type: STRING
Provider name: clientId
Description: Client ID for user-provided OAuth app.
client_secret
Type: STRUCT
Provider name: clientSecret
Description: Client secret for user-provided OAuth app.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
enable_pkce
Type: BOOLEAN
Provider name: enablePkce
Description: Whether to enable PKCE when the user performs the auth code flow.
pkce_verifier
Type: STRING
Provider name: pkceVerifier
Description: PKCE verifier to be used during the auth code exchange.
redirect_uri
Type: STRING
Provider name: redirectUri
Description: Redirect URI to be provided during the auth code exchange.
scopes
Type: UNORDERED_LIST_STRING
Provider name: scopes
Description: Scopes the connection will request when the user performs the auth code flow.
oauth2_auth_code_flow_google_managed
Type: STRUCT
Provider name: oauth2AuthCodeFlowGoogleManaged
Description: Oauth2AuthCodeFlowGoogleManaged.
auth_code
Type: STRING
Provider name: authCode
Description: Optional. Authorization code to be exchanged for access and refresh tokens.
redirect_uri
Type: STRING
Provider name: redirectUri
Description: Optional. Redirect URI to be provided during the auth code exchange.
scopes
Type: UNORDERED_LIST_STRING
Provider name: scopes
Description: Required. Scopes the connection will request when the user performs the auth code flow.
oauth2_client_credentials
Type: STRUCT
Provider name: oauth2ClientCredentials
Description: Oauth2ClientCredentials.
client_id
Type: STRING
Provider name: clientId
Description: The client identifier.
client_secret
Type: STRUCT
Provider name: clientSecret
Description: Secret version reference containing the client secret.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
oauth2_jwt_bearer
Type: STRUCT
Provider name: oauth2JwtBearer
Description: Oauth2JwtBearer.
client_key
Type: STRUCT
Provider name: clientKey
Description: Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: projects/*/secrets/*/versions/*
.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
jwt_claims
Type: STRUCT
Provider name: jwtClaims
Description: JwtClaims providers fields to generate the token.
audience
Type: STRING
Provider name: audience
Description: Value for the “aud” claim.
issuer
Type: STRING
Provider name: issuer
Description: Value for the “iss” claim.
subject
Type: STRING
Provider name: subject
Description: Value for the “sub” claim.
ssh_public_key
Type: STRUCT
Provider name: sshPublicKey
Description: SSH Public Key.
cert_type
Type: STRING
Provider name: certType
Description: Format of SSH Client cert.
ssh_client_cert
Type: STRUCT
Provider name: sshClientCert
Description: SSH Client Cert. It should contain both public and private key.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
ssh_client_cert_pass
Type: STRUCT
Provider name: sshClientCertPass
Description: Password (passphrase) for ssh client certificate if it has one.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
username
Type: STRING
Provider name: username
Description: The user account used to authenticate.
user_password
Type: STRUCT
Provider name: userPassword
Description: UserPassword.
password
Type: STRUCT
Provider name: password
Description: Secret version reference containing the password.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
username
Type: STRING
Provider name: username
Description: Username.
auth_override_enabled
Type: BOOLEAN
Provider name: authOverrideEnabled
Description: Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API.
billing_config
Type: STRUCT
Provider name: billingConfig
Description: Output only. Billing config for the connection.
billing_category
Type: STRING
Provider name: billingCategory
Description: Output only. Billing category for the connector.
Possible values:
BILLING_CATEGORY_UNSPECIFIED
- Billing category is not specified.
GCP_AND_TECHNICAL_CONNECTOR
- GCP/Technical connector.
NON_GCP_CONNECTOR
- Non-GCP connector.
config_variables
Type: UNORDERED_LIST_STRUCT
Provider name: configVariables
Description: Optional. Configuration for configuring the connection with an external system.
bool_value
Type: BOOLEAN
Provider name: boolValue
Description: Value is a bool.
encryption_key_value
Type: STRUCT
Provider name: encryptionKeyValue
Description: Value is a Encryption Key.
kms_key_name
Type: STRING
Provider name: kmsKeyName
Description: The [KMS key name] with which the content of the Operation is encrypted. The expected format: projects/*/locations/*/keyRings/*/cryptoKeys/*
. Will be empty string if google managed.
type
Type: STRING
Provider name: type
Description: Type.
Possible values:
TYPE_UNSPECIFIED
- Value type is not specified.
GOOGLE_MANAGED
- Google Managed.
CUSTOMER_MANAGED
- Customer Managed.
int_value
Type: INT64
Provider name: intValue
Description: Value is an integer
key
Type: STRING
Provider name: key
Description: Key of the config variable.
secret_value
Type: STRUCT
Provider name: secretValue
Description: Value is a secret.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
string_value
Type: STRING
Provider name: stringValue
Description: Value is a string.
connection_revision
Type: INT64
Provider name: connectionRevision
Description: Output only. Connection revision. This field is only updated when the connection is created or updated by User.
connector_version
Type: STRING
Provider name: connectorVersion
Description: Required. Connector version on which the connection is created. The format is: projects//locations//providers//connectors//versions/* Only global location is supported for ConnectorVersion resource.
connector_version_infra_config
Type: STRUCT
Provider name: connectorVersionInfraConfig
Description: Output only. Infra configs supported by Connector Version.
connection_ratelimit_window_seconds
Type: INT64
Provider name: connectionRatelimitWindowSeconds
Description: Output only. The window used for ratelimiting runtime requests to connections.
deployment_model
Type: STRING
Provider name: deploymentModel
Description: Output only. Indicates whether connector is deployed on GKE/CloudRun
Possible values:
DEPLOYMENT_MODEL_UNSPECIFIED
- Deployment model is not specified.
GKE_MST
- Default model gke mst.
CLOUD_RUN_MST
- Cloud run mst.
deployment_model_migration_state
Type: STRING
Provider name: deploymentModelMigrationState
Description: Output only. Status of the deployment model migration.
Possible values:
DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED
- Deployment model migration state is not specified.
IN_PROGRESS
- Deployment model migration is in progress.
COMPLETED
- Deployment model migration is completed.
ROLLEDBACK
- Deployment model migration rolledback.
ROLLBACK_IN_PROGRESS
- Deployment model migration rollback in progress.
hpa_config
Type: STRUCT
Provider name: hpaConfig
Description: Output only. HPA autoscaling config.
cpu_utilization_threshold
Type: INT64
Provider name: cpuUtilizationThreshold
Description: Output only. Percent CPU utilization where HPA triggers autoscaling.
memory_utilization_threshold
Type: INT64
Provider name: memoryUtilizationThreshold
Description: Output only. Percent Memory utilization where HPA triggers autoscaling.
internalclient_ratelimit_threshold
Type: INT64
Provider name: internalclientRatelimitThreshold
Description: Output only. Max QPS supported for internal requests originating from Connd.
max_instance_request_concurrency
Type: INT32
Provider name: maxInstanceRequestConcurrency
Description: Output only. Max instance request concurrency.
ratelimit_threshold
Type: INT64
Provider name: ratelimitThreshold
Description: Output only. Max QPS supported by the connector version before throttling of requests.
resource_limits
Type: STRUCT
Provider name: resourceLimits
Description: Output only. System resource limits.
cpu
Type: STRING
Provider name: cpu
Description: Output only. CPU limit.
memory
Type: STRING
Provider name: memory
Description: Output only. Memory limit.
resource_requests
Type: STRUCT
Provider name: resourceRequests
Description: Output only. System resource requests.
cpu
Type: STRING
Provider name: cpu
Description: Output only. CPU request.
memory
Type: STRING
Provider name: memory
Description: Output only. Memory request.
shared_deployment
Type: STRING
Provider name: sharedDeployment
Description: Output only. The name of shared connector deployment.
tls_migration_state
Type: STRING
Provider name: tlsMigrationState
Description: Output only. Status of the TLS migration.
Possible values:
TLS_MIGRATION_STATE_UNSPECIFIED
- TLS migration state is not specified.
TLS_MIGRATION_NOT_STARTED
- TLS migration is in progress.
TLS_MIGRATION_COMPLETED
- TLS migration is completed.
connector_version_launch_stage
Type: STRING
Provider name: connectorVersionLaunchStage
Description: Output only. Flag to mark the version indicating the launch stage.
Possible values:
LAUNCH_STAGE_UNSPECIFIED
- LAUNCH_STAGE_UNSPECIFIED.
PREVIEW
- PREVIEW.
GA
- GA.
DEPRECATED
- DEPRECATED.
TEST
- TEST.
PRIVATE_PREVIEW
- PRIVATE_PREVIEW.
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. Created time.
description
Type: STRING
Provider name: description
Description: Optional. Description of the resource.
destination_configs
Type: UNORDERED_LIST_STRUCT
Provider name: destinationConfigs
Description: Optional. Configuration of the Connector’s destination. Only accepted for Connectors that accepts user defined destination(s).
destinations
Type: UNORDERED_LIST_STRUCT
Provider name: destinations
Description: The destinations for the key.
host
Type: STRING
Provider name: host
Description: For publicly routable host.
port
Type: INT32
Provider name: port
Description: The port is the target port number that is accepted by the destination.
service_attachment
Type: STRING
Provider name: serviceAttachment
Description: PSC service attachments. Format: projects//regions//serviceAttachments/*
key
Type: STRING
Provider name: key
Description: The key is the destination identifier that is supported by the Connector.
envoy_image_location
Type: STRING
Provider name: envoyImageLocation
Description: Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
eventing_config
Type: STRUCT
Provider name: eventingConfig
Description: Optional. Eventing config of a connection
additional_variables
Type: UNORDERED_LIST_STRUCT
Provider name: additionalVariables
Description: Optional. Additional eventing related field values
bool_value
Type: BOOLEAN
Provider name: boolValue
Description: Value is a bool.
encryption_key_value
Type: STRUCT
Provider name: encryptionKeyValue
Description: Value is a Encryption Key.
kms_key_name
Type: STRING
Provider name: kmsKeyName
Description: The [KMS key name] with which the content of the Operation is encrypted. The expected format: projects/*/locations/*/keyRings/*/cryptoKeys/*
. Will be empty string if google managed.
type
Type: STRING
Provider name: type
Description: Type.
Possible values:
TYPE_UNSPECIFIED
- Value type is not specified.
GOOGLE_MANAGED
- Google Managed.
CUSTOMER_MANAGED
- Customer Managed.
int_value
Type: INT64
Provider name: intValue
Description: Value is an integer
key
Type: STRING
Provider name: key
Description: Key of the config variable.
secret_value
Type: STRUCT
Provider name: secretValue
Description: Value is a secret.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
string_value
Type: STRING
Provider name: stringValue
Description: Value is a string.
auth_config
Type: STRUCT
Provider name: authConfig
Description: Optional. Auth details for the webhook adapter.
additional_variables
Type: UNORDERED_LIST_STRUCT
Provider name: additionalVariables
Description: List containing additional auth configs.
bool_value
Type: BOOLEAN
Provider name: boolValue
Description: Value is a bool.
encryption_key_value
Type: STRUCT
Provider name: encryptionKeyValue
Description: Value is a Encryption Key.
kms_key_name
Type: STRING
Provider name: kmsKeyName
Description: The [KMS key name] with which the content of the Operation is encrypted. The expected format: projects/*/locations/*/keyRings/*/cryptoKeys/*
. Will be empty string if google managed.
type
Type: STRING
Provider name: type
Description: Type.
Possible values:
TYPE_UNSPECIFIED
- Value type is not specified.
GOOGLE_MANAGED
- Google Managed.
CUSTOMER_MANAGED
- Customer Managed.
int_value
Type: INT64
Provider name: intValue
Description: Value is an integer
key
Type: STRING
Provider name: key
Description: Key of the config variable.
secret_value
Type: STRUCT
Provider name: secretValue
Description: Value is a secret.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
string_value
Type: STRING
Provider name: stringValue
Description: Value is a string.
auth_key
Type: STRING
Provider name: authKey
Description: Identifier key for auth config
auth_type
Type: STRING
Provider name: authType
Description: The type of authentication configured.
Possible values:
AUTH_TYPE_UNSPECIFIED
- Authentication type not specified.
USER_PASSWORD
- Username and Password Authentication.
OAUTH2_JWT_BEARER
- JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication
OAUTH2_CLIENT_CREDENTIALS
- Oauth 2.0 Client Credentials Grant Authentication
SSH_PUBLIC_KEY
- SSH Public Key Authentication
OAUTH2_AUTH_CODE_FLOW
- Oauth 2.0 Authorization Code Flow
GOOGLE_AUTHENTICATION
- Google authentication
OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED
- Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client
oauth2_auth_code_flow
Type: STRUCT
Provider name: oauth2AuthCodeFlow
Description: Oauth2AuthCodeFlow.
auth_code
Type: STRING
Provider name: authCode
Description: Authorization code to be exchanged for access and refresh tokens.
auth_uri
Type: STRING
Provider name: authUri
Description: Auth URL for Authorization Code Flow
client_id
Type: STRING
Provider name: clientId
Description: Client ID for user-provided OAuth app.
client_secret
Type: STRUCT
Provider name: clientSecret
Description: Client secret for user-provided OAuth app.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
enable_pkce
Type: BOOLEAN
Provider name: enablePkce
Description: Whether to enable PKCE when the user performs the auth code flow.
pkce_verifier
Type: STRING
Provider name: pkceVerifier
Description: PKCE verifier to be used during the auth code exchange.
redirect_uri
Type: STRING
Provider name: redirectUri
Description: Redirect URI to be provided during the auth code exchange.
scopes
Type: UNORDERED_LIST_STRING
Provider name: scopes
Description: Scopes the connection will request when the user performs the auth code flow.
oauth2_auth_code_flow_google_managed
Type: STRUCT
Provider name: oauth2AuthCodeFlowGoogleManaged
Description: Oauth2AuthCodeFlowGoogleManaged.
auth_code
Type: STRING
Provider name: authCode
Description: Optional. Authorization code to be exchanged for access and refresh tokens.
redirect_uri
Type: STRING
Provider name: redirectUri
Description: Optional. Redirect URI to be provided during the auth code exchange.
scopes
Type: UNORDERED_LIST_STRING
Provider name: scopes
Description: Required. Scopes the connection will request when the user performs the auth code flow.
oauth2_client_credentials
Type: STRUCT
Provider name: oauth2ClientCredentials
Description: Oauth2ClientCredentials.
client_id
Type: STRING
Provider name: clientId
Description: The client identifier.
client_secret
Type: STRUCT
Provider name: clientSecret
Description: Secret version reference containing the client secret.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
oauth2_jwt_bearer
Type: STRUCT
Provider name: oauth2JwtBearer
Description: Oauth2JwtBearer.
client_key
Type: STRUCT
Provider name: clientKey
Description: Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: projects/*/secrets/*/versions/*
.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
jwt_claims
Type: STRUCT
Provider name: jwtClaims
Description: JwtClaims providers fields to generate the token.
audience
Type: STRING
Provider name: audience
Description: Value for the “aud” claim.
issuer
Type: STRING
Provider name: issuer
Description: Value for the “iss” claim.
subject
Type: STRING
Provider name: subject
Description: Value for the “sub” claim.
ssh_public_key
Type: STRUCT
Provider name: sshPublicKey
Description: SSH Public Key.
cert_type
Type: STRING
Provider name: certType
Description: Format of SSH Client cert.
ssh_client_cert
Type: STRUCT
Provider name: sshClientCert
Description: SSH Client Cert. It should contain both public and private key.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
ssh_client_cert_pass
Type: STRUCT
Provider name: sshClientCertPass
Description: Password (passphrase) for ssh client certificate if it has one.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
username
Type: STRING
Provider name: username
Description: The user account used to authenticate.
user_password
Type: STRUCT
Provider name: userPassword
Description: UserPassword.
password
Type: STRUCT
Provider name: password
Description: Secret version reference containing the password.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
username
Type: STRING
Provider name: username
Description: Username.
dead_letter_config
Type: STRUCT
Provider name: deadLetterConfig
Description: Optional. Dead letter configuration for eventing of a connection.
project_id
Type: STRING
Provider name: projectId
Description: Optional. Project which has the topic given.
topic
Type: STRING
Provider name: topic
Description: Optional. Topic to push events which couldn’t be processed.
enrichment_config
Type: STRUCT
Provider name: enrichmentConfig
Description: Optional. Data enrichment configuration.
append_acl
Type: BOOLEAN
Provider name: appendAcl
Description: Optional. Append ACL to the event.
enrichment_enabled
Type: BOOLEAN
Provider name: enrichmentEnabled
Description: Optional. Enrichment Enabled.
events_listener_ingress_endpoint
Type: STRING
Provider name: eventsListenerIngressEndpoint
Description: Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled.
listener_auth_config
Type: STRUCT
Provider name: listenerAuthConfig
Description: Optional. Auth details for the event listener.
additional_variables
Type: UNORDERED_LIST_STRUCT
Provider name: additionalVariables
Description: List containing additional auth configs.
bool_value
Type: BOOLEAN
Provider name: boolValue
Description: Value is a bool.
encryption_key_value
Type: STRUCT
Provider name: encryptionKeyValue
Description: Value is a Encryption Key.
kms_key_name
Type: STRING
Provider name: kmsKeyName
Description: The [KMS key name] with which the content of the Operation is encrypted. The expected format: projects/*/locations/*/keyRings/*/cryptoKeys/*
. Will be empty string if google managed.
type
Type: STRING
Provider name: type
Description: Type.
Possible values:
TYPE_UNSPECIFIED
- Value type is not specified.
GOOGLE_MANAGED
- Google Managed.
CUSTOMER_MANAGED
- Customer Managed.
int_value
Type: INT64
Provider name: intValue
Description: Value is an integer
key
Type: STRING
Provider name: key
Description: Key of the config variable.
secret_value
Type: STRUCT
Provider name: secretValue
Description: Value is a secret.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
string_value
Type: STRING
Provider name: stringValue
Description: Value is a string.
auth_key
Type: STRING
Provider name: authKey
Description: Identifier key for auth config
auth_type
Type: STRING
Provider name: authType
Description: The type of authentication configured.
Possible values:
AUTH_TYPE_UNSPECIFIED
- Authentication type not specified.
USER_PASSWORD
- Username and Password Authentication.
OAUTH2_JWT_BEARER
- JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication
OAUTH2_CLIENT_CREDENTIALS
- Oauth 2.0 Client Credentials Grant Authentication
SSH_PUBLIC_KEY
- SSH Public Key Authentication
OAUTH2_AUTH_CODE_FLOW
- Oauth 2.0 Authorization Code Flow
GOOGLE_AUTHENTICATION
- Google authentication
OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED
- Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client
oauth2_auth_code_flow
Type: STRUCT
Provider name: oauth2AuthCodeFlow
Description: Oauth2AuthCodeFlow.
auth_code
Type: STRING
Provider name: authCode
Description: Authorization code to be exchanged for access and refresh tokens.
auth_uri
Type: STRING
Provider name: authUri
Description: Auth URL for Authorization Code Flow
client_id
Type: STRING
Provider name: clientId
Description: Client ID for user-provided OAuth app.
client_secret
Type: STRUCT
Provider name: clientSecret
Description: Client secret for user-provided OAuth app.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
enable_pkce
Type: BOOLEAN
Provider name: enablePkce
Description: Whether to enable PKCE when the user performs the auth code flow.
pkce_verifier
Type: STRING
Provider name: pkceVerifier
Description: PKCE verifier to be used during the auth code exchange.
redirect_uri
Type: STRING
Provider name: redirectUri
Description: Redirect URI to be provided during the auth code exchange.
scopes
Type: UNORDERED_LIST_STRING
Provider name: scopes
Description: Scopes the connection will request when the user performs the auth code flow.
oauth2_auth_code_flow_google_managed
Type: STRUCT
Provider name: oauth2AuthCodeFlowGoogleManaged
Description: Oauth2AuthCodeFlowGoogleManaged.
auth_code
Type: STRING
Provider name: authCode
Description: Optional. Authorization code to be exchanged for access and refresh tokens.
redirect_uri
Type: STRING
Provider name: redirectUri
Description: Optional. Redirect URI to be provided during the auth code exchange.
scopes
Type: UNORDERED_LIST_STRING
Provider name: scopes
Description: Required. Scopes the connection will request when the user performs the auth code flow.
oauth2_client_credentials
Type: STRUCT
Provider name: oauth2ClientCredentials
Description: Oauth2ClientCredentials.
client_id
Type: STRING
Provider name: clientId
Description: The client identifier.
client_secret
Type: STRUCT
Provider name: clientSecret
Description: Secret version reference containing the client secret.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
oauth2_jwt_bearer
Type: STRUCT
Provider name: oauth2JwtBearer
Description: Oauth2JwtBearer.
client_key
Type: STRUCT
Provider name: clientKey
Description: Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: projects/*/secrets/*/versions/*
.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
jwt_claims
Type: STRUCT
Provider name: jwtClaims
Description: JwtClaims providers fields to generate the token.
audience
Type: STRING
Provider name: audience
Description: Value for the “aud” claim.
issuer
Type: STRING
Provider name: issuer
Description: Value for the “iss” claim.
subject
Type: STRING
Provider name: subject
Description: Value for the “sub” claim.
ssh_public_key
Type: STRUCT
Provider name: sshPublicKey
Description: SSH Public Key.
cert_type
Type: STRING
Provider name: certType
Description: Format of SSH Client cert.
ssh_client_cert
Type: STRUCT
Provider name: sshClientCert
Description: SSH Client Cert. It should contain both public and private key.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
ssh_client_cert_pass
Type: STRUCT
Provider name: sshClientCertPass
Description: Password (passphrase) for ssh client certificate if it has one.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
username
Type: STRING
Provider name: username
Description: The user account used to authenticate.
user_password
Type: STRUCT
Provider name: userPassword
Description: UserPassword.
password
Type: STRUCT
Provider name: password
Description: Secret version reference containing the password.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
username
Type: STRING
Provider name: username
Description: Username.
private_connectivity_enabled
Type: BOOLEAN
Provider name: privateConnectivityEnabled
Description: Optional. Private Connectivity Enabled.
proxy_destination_config
Type: STRUCT
Provider name: proxyDestinationConfig
Description: Optional. Proxy for Eventing auto-registration.
destinations
Type: UNORDERED_LIST_STRUCT
Provider name: destinations
Description: The destinations for the key.
host
Type: STRING
Provider name: host
Description: For publicly routable host.
port
Type: INT32
Provider name: port
Description: The port is the target port number that is accepted by the destination.
service_attachment
Type: STRING
Provider name: serviceAttachment
Description: PSC service attachments. Format: projects//regions//serviceAttachments/*
key
Type: STRING
Provider name: key
Description: The key is the destination identifier that is supported by the Connector.
registration_destination_config
Type: STRUCT
Provider name: registrationDestinationConfig
Description: Optional. Registration endpoint for auto registration.
destinations
Type: UNORDERED_LIST_STRUCT
Provider name: destinations
Description: The destinations for the key.
host
Type: STRING
Provider name: host
Description: For publicly routable host.
port
Type: INT32
Provider name: port
Description: The port is the target port number that is accepted by the destination.
service_attachment
Type: STRING
Provider name: serviceAttachment
Description: PSC service attachments. Format: projects//regions//serviceAttachments/*
key
Type: STRING
Provider name: key
Description: The key is the destination identifier that is supported by the Connector.
ssl_config
Type: STRUCT
Provider name: sslConfig
Description: Optional. Ssl config of a connection
additional_variables
Type: UNORDERED_LIST_STRUCT
Provider name: additionalVariables
Description: Optional. Additional SSL related field values
bool_value
Type: BOOLEAN
Provider name: boolValue
Description: Value is a bool.
encryption_key_value
Type: STRUCT
Provider name: encryptionKeyValue
Description: Value is a Encryption Key.
kms_key_name
Type: STRING
Provider name: kmsKeyName
Description: The [KMS key name] with which the content of the Operation is encrypted. The expected format: projects/*/locations/*/keyRings/*/cryptoKeys/*
. Will be empty string if google managed.
type
Type: STRING
Provider name: type
Description: Type.
Possible values:
TYPE_UNSPECIFIED
- Value type is not specified.
GOOGLE_MANAGED
- Google Managed.
CUSTOMER_MANAGED
- Customer Managed.
int_value
Type: INT64
Provider name: intValue
Description: Value is an integer
key
Type: STRING
Provider name: key
Description: Key of the config variable.
secret_value
Type: STRUCT
Provider name: secretValue
Description: Value is a secret.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
string_value
Type: STRING
Provider name: stringValue
Description: Value is a string.
client_cert_type
Type: STRING
Provider name: clientCertType
Description: Optional. Type of Client Cert (PEM/JKS/.. etc.)
Possible values:
CERT_TYPE_UNSPECIFIED
- Cert type unspecified.
PEM
- Privacy Enhanced Mail (PEM) Type
client_certificate
Type: STRUCT
Provider name: clientCertificate
Description: Optional. Client Certificate
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
client_private_key
Type: STRUCT
Provider name: clientPrivateKey
Description: Optional. Client Private Key
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
client_private_key_pass
Type: STRUCT
Provider name: clientPrivateKeyPass
Description: Optional. Secret containing the passphrase protecting the Client Private Key
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
private_server_certificate
Type: STRUCT
Provider name: privateServerCertificate
Description: Optional. Private Server Certificate. Needs to be specified if trust model is PRIVATE
.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
server_cert_type
Type: STRING
Provider name: serverCertType
Description: Optional. Type of Server Cert (PEM/JKS/.. etc.)
Possible values:
CERT_TYPE_UNSPECIFIED
- Cert type unspecified.
PEM
- Privacy Enhanced Mail (PEM) Type
trust_model
Type: STRING
Provider name: trustModel
Description: Optional. Trust Model of the SSL connection
Possible values:
PUBLIC
- Public Trust Model. Takes the Default Java trust store.
PRIVATE
- Private Trust Model. Takes custom/private trust store.
INSECURE
- Insecure Trust Model. Accept all certificates.
type
Type: STRING
Provider name: type
Description: Optional. Controls the ssl type for the given connector version.
Possible values:
SSL_TYPE_UNSPECIFIED
- No SSL configuration required.
TLS
- TLS Handshake
MTLS
- mutual TLS (MTLS) Handshake
use_ssl
Type: BOOLEAN
Provider name: useSsl
Description: Optional. Bool for enabling SSL
eventing_enablement_type
Type: STRING
Provider name: eventingEnablementType
Description: Optional. Eventing enablement type. Will be nil if eventing is not enabled.
Possible values:
EVENTING_ENABLEMENT_TYPE_UNSPECIFIED
- Eventing Enablement Type Unspecifeied.
EVENTING_AND_CONNECTION
- Both connection and eventing.
ONLY_EVENTING
- Only Eventing.
eventing_runtime_data
Type: STRUCT
Provider name: eventingRuntimeData
Description: Output only. Eventing Runtime Data.
events_listener_endpoint
Type: STRING
Provider name: eventsListenerEndpoint
Description: Output only. Events listener endpoint. The value will populated after provisioning the events listener.
events_listener_psc_sa
Type: STRING
Provider name: eventsListenerPscSa
Description: Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled.
gcp_status
Type: STRUCT
Provider name: status
Description: Output only. Current status of eventing.
description
Type: STRING
Provider name: description
Description: Output only. Description of error if State is set to “ERROR”.
state
Type: STRING
Provider name: state
Description: Output only. State.
Possible values:
STATE_UNSPECIFIED
- Default state.
ACTIVE
- Eventing is enabled and ready to receive events.
ERROR
- Eventing is not active due to an error.
INGRESS_ENDPOINT_REQUIRED
- Ingress endpoint required.
webhook_data
Type: STRUCT
Provider name: webhookData
Description: Output only. Webhook data.
additional_variables
Type: UNORDERED_LIST_STRUCT
Provider name: additionalVariables
Description: Output only. Additional webhook related field values.
bool_value
Type: BOOLEAN
Provider name: boolValue
Description: Value is a bool.
encryption_key_value
Type: STRUCT
Provider name: encryptionKeyValue
Description: Value is a Encryption Key.
kms_key_name
Type: STRING
Provider name: kmsKeyName
Description: The [KMS key name] with which the content of the Operation is encrypted. The expected format: projects/*/locations/*/keyRings/*/cryptoKeys/*
. Will be empty string if google managed.
type
Type: STRING
Provider name: type
Description: Type.
Possible values:
TYPE_UNSPECIFIED
- Value type is not specified.
GOOGLE_MANAGED
- Google Managed.
CUSTOMER_MANAGED
- Customer Managed.
int_value
Type: INT64
Provider name: intValue
Description: Value is an integer
key
Type: STRING
Provider name: key
Description: Key of the config variable.
secret_value
Type: STRUCT
Provider name: secretValue
Description: Value is a secret.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
string_value
Type: STRING
Provider name: stringValue
Description: Value is a string.
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. Timestamp when the webhook was created.
id
Type: STRING
Provider name: id
Description: Output only. ID to uniquely identify webhook.
name
Type: STRING
Provider name: name
Description: Output only. Name of the Webhook
next_refresh_time
Type: TIMESTAMP
Provider name: nextRefreshTime
Description: Output only. Next webhook refresh time. Will be null if refresh is not supported.
update_time
Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Timestamp when the webhook was last updated.
webhook_subscriptions
Type: STRUCT
Provider name: webhookSubscriptions
Description: Output only. Webhook subscriptions.
webhook_data
Type: UNORDERED_LIST_STRUCT
Provider name: webhookData
Description: Output only. Webhook data.
additional_variables
Type: UNORDERED_LIST_STRUCT
Provider name: additionalVariables
Description: Output only. Additional webhook related field values.
bool_value
Type: BOOLEAN
Provider name: boolValue
Description: Value is a bool.
encryption_key_value
Type: STRUCT
Provider name: encryptionKeyValue
Description: Value is a Encryption Key.
kms_key_name
Type: STRING
Provider name: kmsKeyName
Description: The [KMS key name] with which the content of the Operation is encrypted. The expected format: projects/*/locations/*/keyRings/*/cryptoKeys/*
. Will be empty string if google managed.
type
Type: STRING
Provider name: type
Description: Type.
Possible values:
TYPE_UNSPECIFIED
- Value type is not specified.
GOOGLE_MANAGED
- Google Managed.
CUSTOMER_MANAGED
- Customer Managed.
int_value
Type: INT64
Provider name: intValue
Description: Value is an integer
key
Type: STRING
Provider name: key
Description: Key of the config variable.
secret_value
Type: STRUCT
Provider name: secretValue
Description: Value is a secret.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
string_value
Type: STRING
Provider name: stringValue
Description: Value is a string.
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. Timestamp when the webhook was created.
id
Type: STRING
Provider name: id
Description: Output only. ID to uniquely identify webhook.
name
Type: STRING
Provider name: name
Description: Output only. Name of the Webhook
next_refresh_time
Type: TIMESTAMP
Provider name: nextRefreshTime
Description: Output only. Next webhook refresh time. Will be null if refresh is not supported.
update_time
Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Timestamp when the webhook was last updated.
gcp_status
Type: STRUCT
Provider name: status
Description: Output only. Current status of the connection.
description
Type: STRING
Provider name: description
Description: Description.
gcp_status
Type: STRING
Provider name: status
Description: Status provides detailed information for the state.
state
Type: STRING
Provider name: state
Description: State.
Possible values:
STATE_UNSPECIFIED
- Connection does not have a state yet.
CREATING
- Connection is being created.
ACTIVE
- Connection is running and ready for requests.
INACTIVE
- Connection is stopped.
DELETING
- Connection is being deleted.
UPDATING
- Connection is being updated.
ERROR
- Connection is not running due to an error.
AUTHORIZATION_REQUIRED
- Connection is not running because the authorization configuration is not complete.
host
Type: STRING
Provider name: host
Description: Output only. The name of the Hostname of the Service Directory service with TLS.
image_location
Type: STRING
Provider name: imageLocation
Description: Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
is_trusted_tester
Type: BOOLEAN
Provider name: isTrustedTester
Description: Output only. Is trusted tester program enabled for the project.
labels
Type: UNORDERED_LIST_STRING
lock_config
Type: STRUCT
Provider name: lockConfig
Description: Optional. Configuration that indicates whether or not the Connection can be edited.
locked
Type: BOOLEAN
Provider name: locked
Description: Indicates whether or not the connection is locked.
reason
Type: STRING
Provider name: reason
Description: Describes why a connection is locked.
log_config
Type: STRUCT
Provider name: logConfig
Description: Optional. Log configuration for the connection.
enabled
Type: BOOLEAN
Provider name: enabled
Description: Enabled represents whether logging is enabled or not for a connection.
level
Type: STRING
Provider name: level
Description: Optional. Log configuration level.
Possible values:
LOG_LEVEL_UNSPECIFIED
- Log level unspecified.
ERROR
- Only error logs are enabled.
INFO
- Info and error logs are enabled.
DEBUG
- Debug and high verbosity logs are enabled.
name
Type: STRING
Provider name: name
Description: Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
node_config
Type: STRUCT
Provider name: nodeConfig
Description: Optional. Node configuration for the connection.
max_node_count
Type: INT32
Provider name: maxNodeCount
Description: Maximum number of nodes in the runtime nodes.
min_node_count
Type: INT32
Provider name: minNodeCount
Description: Minimum number of nodes in the runtime nodes.
organization_id
Type: STRING
parent
Type: STRING
project_id
Type: STRING
project_number
Type: STRING
resource_name
Type: STRING
service_account
Type: STRING
Provider name: serviceAccount
Description: Optional. Service account needed for runtime plane to access Google Cloud resources.
service_directory
Type: STRING
Provider name: serviceDirectory
Description: Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. “projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors”
ssl_config
Type: STRUCT
Provider name: sslConfig
Description: Optional. Ssl config of a connection
additional_variables
Type: UNORDERED_LIST_STRUCT
Provider name: additionalVariables
Description: Optional. Additional SSL related field values
bool_value
Type: BOOLEAN
Provider name: boolValue
Description: Value is a bool.
encryption_key_value
Type: STRUCT
Provider name: encryptionKeyValue
Description: Value is a Encryption Key.
kms_key_name
Type: STRING
Provider name: kmsKeyName
Description: The [KMS key name] with which the content of the Operation is encrypted. The expected format: projects/*/locations/*/keyRings/*/cryptoKeys/*
. Will be empty string if google managed.
type
Type: STRING
Provider name: type
Description: Type.
Possible values:
TYPE_UNSPECIFIED
- Value type is not specified.
GOOGLE_MANAGED
- Google Managed.
CUSTOMER_MANAGED
- Customer Managed.
int_value
Type: INT64
Provider name: intValue
Description: Value is an integer
key
Type: STRING
Provider name: key
Description: Key of the config variable.
secret_value
Type: STRUCT
Provider name: secretValue
Description: Value is a secret.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
string_value
Type: STRING
Provider name: stringValue
Description: Value is a string.
client_cert_type
Type: STRING
Provider name: clientCertType
Description: Optional. Type of Client Cert (PEM/JKS/.. etc.)
Possible values:
CERT_TYPE_UNSPECIFIED
- Cert type unspecified.
PEM
- Privacy Enhanced Mail (PEM) Type
client_certificate
Type: STRUCT
Provider name: clientCertificate
Description: Optional. Client Certificate
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
client_private_key
Type: STRUCT
Provider name: clientPrivateKey
Description: Optional. Client Private Key
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
client_private_key_pass
Type: STRUCT
Provider name: clientPrivateKeyPass
Description: Optional. Secret containing the passphrase protecting the Client Private Key
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
private_server_certificate
Type: STRUCT
Provider name: privateServerCertificate
Description: Optional. Private Server Certificate. Needs to be specified if trust model is PRIVATE
.
secret_version
Type: STRING
Provider name: secretVersion
Description: The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*
.
server_cert_type
Type: STRING
Provider name: serverCertType
Description: Optional. Type of Server Cert (PEM/JKS/.. etc.)
Possible values:
CERT_TYPE_UNSPECIFIED
- Cert type unspecified.
PEM
- Privacy Enhanced Mail (PEM) Type
trust_model
Type: STRING
Provider name: trustModel
Description: Optional. Trust Model of the SSL connection
Possible values:
PUBLIC
- Public Trust Model. Takes the Default Java trust store.
PRIVATE
- Private Trust Model. Takes custom/private trust store.
INSECURE
- Insecure Trust Model. Accept all certificates.
type
Type: STRING
Provider name: type
Description: Optional. Controls the ssl type for the given connector version.
Possible values:
SSL_TYPE_UNSPECIFIED
- No SSL configuration required.
TLS
- TLS Handshake
MTLS
- mutual TLS (MTLS) Handshake
use_ssl
Type: BOOLEAN
Provider name: useSsl
Description: Optional. Bool for enabling SSL
subscription_type
Type: STRING
Provider name: subscriptionType
Description: Output only. This subscription type enum states the subscription type of the project.
Possible values:
SUBSCRIPTION_TYPE_UNSPECIFIED
- Unspecified subscription type.
PAY_G
- PayG subscription.
PAID
- Paid Subscription.
suspended
Type: BOOLEAN
Provider name: suspended
Description: Optional. Suspended indicates if a user has suspended a connection or not.
Type: UNORDERED_LIST_STRING
tls_service_directory
Type: STRING
Provider name: tlsServiceDirectory
Description: Output only. The name of the Service Directory service with TLS.
traffic_shaping_configs
Type: UNORDERED_LIST_STRUCT
Provider name: trafficShapingConfigs
Description: Optional. Traffic shaping configuration for the connection.
duration
Type: STRING
Provider name: duration
Description: Required. * The duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set seconds
to 16 - To define a quota sampled over 5 minutes, set seconds
to 300 (5 * 60) - To define a quota sampled over 1 day, set seconds
to 86400 (24 * 60 * 60) and so on. It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds.
quota_limit
Type: INT64
Provider name: quotaLimit
Description: Required. Maximum number of api calls allowed.
update_time
Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Updated time.