class SslCerts extends Resource (View source)

The "sslCerts" collection of methods.

Typical usage is:

 $sqladminService = new Google\Service\SQLAdmin(...);
 $sslCerts = $sqladminService->sslCerts;

Methods

createEphemeral(string $project, string $instance, SslCertsCreateEphemeralRequest $postBody, array $optParams = [])

Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database. (sslCerts.createEphemeral)

delete(string $project, string $instance, string $sha1Fingerprint, array $optParams = [])

Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted. (sslCerts.delete)

get(string $project, string $instance, string $sha1Fingerprint, array $optParams = [])

Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation. (sslCerts.get)

insert(string $project, string $instance, SslCertsInsertRequest $postBody, array $optParams = [])

Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted. (sslCerts.insert)

listSslCerts(string $project, string $instance, array $optParams = [])

Lists all of the current SSL certificates for the instance.

Details

SslCert createEphemeral(string $project, string $instance, SslCertsCreateEphemeralRequest $postBody, array $optParams = [])

Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database. (sslCerts.createEphemeral)

Parameters

string $project

Project ID of the Cloud SQL project.

string $instance

Cloud SQL instance ID. This does not include the project ID.

SslCertsCreateEphemeralRequest $postBody
array $optParams

Optional parameters.

Return Value

SslCert

Exceptions

Exception

Operation delete(string $project, string $instance, string $sha1Fingerprint, array $optParams = [])

Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted. (sslCerts.delete)

Parameters

string $project

Project ID of the project that contains the instance.

string $instance

Cloud SQL instance ID. This does not include the project ID.

string $sha1Fingerprint

Sha1 FingerPrint.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

SslCert get(string $project, string $instance, string $sha1Fingerprint, array $optParams = [])

Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation. (sslCerts.get)

Parameters

string $project

Project ID of the project that contains the instance.

string $instance

Cloud SQL instance ID. This does not include the project ID.

string $sha1Fingerprint

Sha1 FingerPrint.

array $optParams

Optional parameters.

Return Value

SslCert

Exceptions

Exception

SslCertsInsertResponse insert(string $project, string $instance, SslCertsInsertRequest $postBody, array $optParams = [])

Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted. (sslCerts.insert)

Parameters

string $project

Project ID of the project that contains the instance.

string $instance

Cloud SQL instance ID. This does not include the project ID.

SslCertsInsertRequest $postBody
array $optParams

Optional parameters.

Return Value

SslCertsInsertResponse

Exceptions

Exception

SslCertsListResponse listSslCerts(string $project, string $instance, array $optParams = [])

Lists all of the current SSL certificates for the instance.

(sslCerts.listSslCerts)

Parameters

string $project

Project ID of the project that contains the instance.

string $instance

Cloud SQL instance ID. This does not include the project ID.

array $optParams

Optional parameters.

Return Value

SslCertsListResponse

Exceptions

Exception