Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1341173209.0 KB
projects

Creates a new connection profile in a given project and location.

post/v1/{+parent}/connectionProfiles

Path parameters

parentstring required

Required. The parent which owns this collection of connection profiles.

Query parameters

connectionProfileIdstring

Required. The connection profile identifier.

requestIdstring

Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

skipValidationboolean

Optional. Create the connection profile without validating it. The default is false. Only supported for Oracle connection profiles.

validateOnlyboolean

Optional. Only validate the connection profile, but don't create any resources. The default is false. Only supported for Oracle connection profiles.

Request body

labelsobject

The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

role'ROLE_UNSPECIFIED' | 'SOURCE' | 'DESTINATION'

Optional. The connection profile role.

updateTimestring google-datetime

Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

namestring

The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.

provider'DATABASE_PROVIDER_UNSPECIFIED' | 'CLOUDSQL' | 'RDS' | 'AURORA' | 'ALLOYDB' | 'AZURE_DATABASE'

The database provider.

displayNamestring

The connection profile display name.

createTimestring google-datetime

Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

satisfiesPziboolean

Output only. Reserved for future use.

satisfiesPzsboolean

Output only. Reserved for future use.

state'STATE_UNSPECIFIED' | 'DRAFT' | 'CREATING' | 'READY' | 'UPDATING' | 'DELETING' | 'DELETED' | 'FAILED'

The current connection profile state (e.g. DRAFT, READY, or FAILED).

Response

Successful response