Skip to main content

ssl_certificates_aggregated

Creates, updates, deletes, gets or lists a ssl_certificates_aggregated resource.

Overview

Namessl_certificates_aggregated
TypeResource
Idgoogle.compute.ssl_certificates_aggregated

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
idstring (uint64)[Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringName of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: a-z?)
certificatestringA value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
creationTimestampstring[Output Only] Creation timestamp in RFC3339 text format.
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
expireTimestring[Output Only] Expire time of the certificate. RFC3339
kindstring[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. (default: compute#sslCertificate)
managedobjectConfiguration and status of a managed SSL certificate. (id: SslCertificateManagedSslCertificate)
privateKeystringA value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.
regionstring[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
selfLinkstring[Output only] Server-defined URL for the resource.
selfManagedobjectConfiguration and status of a self-managed SSL certificate. (id: SslCertificateSelfManagedSslCertificate)
subjectAlternativeNamesarray[Output Only] Domains associated with the certificate via Subject Alternative Name.
typestring(Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
aggregated_listselectprojectfilter, includeAllScopes, maxResults, orderBy, pageToken, returnPartialSuccess, serviceProjectNumberRetrieves the list of all SslCertificate resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
projectstring
filterstring
includeAllScopesboolean
maxResultsinteger (uint32)
orderBystring
pageTokenstring
returnPartialSuccessboolean
serviceProjectNumberstring (int64)

SELECT examples

Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
certificate,
creationTimestamp,
description,
expireTime,
kind,
managed,
privateKey,
region,
selfLink,
selfManaged,
subjectAlternativeNames,
type
FROM google.compute.ssl_certificates_aggregated
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}';