ssl_certificates

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

Overview

Name	ssl_certificates
Type	Resource
Id	google.compute.ssl_certificates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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](?:[-a-z0-9]{0,61}[a-z0-9])?)
certificate	string	A 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.
creationTimestamp	string	[Output Only] Creation timestamp inRFC3339 text format.
description	string	An optional description of this resource. Provide this property when you create the resource.
expireTime	string	Output only. [Output Only] Expire time of the certificate. RFC3339
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#sslCertificate for SSL certificates. (default: compute#sslCertificate)
managed	object	Configuration and status of a managed SSL certificate. (id: SslCertificateManagedSslCertificate)
privateKey	string	A 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.
region	string	Output only. [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
selfLink	string	[Output only] Server-defined URL for the resource.
selfManaged	object	Configuration and status of a self-managed SSL certificate. (id: SslCertificateSelfManagedSslCertificate)
subjectAlternativeNames	array	Output only. [Output Only] Domains associated with the certificate via Subject Alternative Name.
type	string	(Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fieldscertificate and private_key are used. (MANAGED, SELF_MANAGED, TYPE_UNSPECIFIED)

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of SslCertificate resources.
kind	string	Output only. Type of resource. (default: compute#sslCertificateList)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	Output only. [Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

aggregated_list

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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](?:[-a-z0-9]{0,61}[a-z0-9])?)
certificate	string	A 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.
creationTimestamp	string	[Output Only] Creation timestamp inRFC3339 text format.
description	string	An optional description of this resource. Provide this property when you create the resource.
expireTime	string	Output only. [Output Only] Expire time of the certificate. RFC3339
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#sslCertificate for SSL certificates. (default: compute#sslCertificate)
managed	object	Configuration and status of a managed SSL certificate. (id: SslCertificateManagedSslCertificate)
privateKey	string	A 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.
region	string	Output only. [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
selfLink	string	[Output only] Server-defined URL for the resource.
selfManaged	object	Configuration and status of a self-managed SSL certificate. (id: SslCertificateSelfManagedSslCertificate)
subjectAlternativeNames	array	Output only. [Output Only] Domains associated with the certificate via Subject Alternative Name.
type	string	(Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fieldscertificate and private_key are used. (MANAGED, SELF_MANAGED, TYPE_UNSPECIFIED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, sslCertificate		Returns the specified SslCertificate resource.
list	select	project	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves the list of SslCertificate resources available to the specified project.
aggregated_list	select	project	filter, includeAllScopes, maxResults, orderBy, pageToken, returnPartialSuccess, serviceProjectNumber	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.
insert	insert	project	requestId	Creates a SslCertificate resource in the specified project using the data included in the request.
delete	delete	project, sslCertificate	requestId	Deletes the specified SslCertificate resource.

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.

Name	Datatype	Description
project	string
sslCertificate	string
filter	string
includeAllScopes	boolean
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean
serviceProjectNumber	string (int64)

SELECT examples

get

Returns the specified SslCertificate resource.

SELECT
id,
name,
certificate,
creationTimestamp,
description,
expireTime,
kind,
managed,
privateKey,
region,
selfLink,
selfManaged,
subjectAlternativeNames,
type
FROM google.compute.ssl_certificates
WHERE project = '{{ project }}' -- required
AND sslCertificate = '{{ sslCertificate }}' -- required
;

list

Retrieves the list of SslCertificate resources available to the specified
project.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.ssl_certificates
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

aggregated_list

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
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 }}'
;

INSERT examples

insert

Creates a SslCertificate resource in the specified project using the data
included in the request.

INSERT INTO google.compute.ssl_certificates (
data__certificate,
data__creationTimestamp,
data__description,
data__id,
data__managed,
data__name,
data__privateKey,
data__selfLink,
data__selfManaged,
data__type,
project,
requestId
)
SELECT 
'{{ certificate }}',
'{{ creationTimestamp }}',
'{{ description }}',
'{{ id }}',
'{{ managed }}',
'{{ name }}',
'{{ privateKey }}',
'{{ selfLink }}',
'{{ selfManaged }}',
'{{ type }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: ssl_certificates
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the ssl_certificates resource.
  - name: certificate
    value: "{{ certificate }}"
    description: |
      A 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.
  - name: creationTimestamp
    value: "{{ creationTimestamp }}"
    description: |
      [Output Only] Creation timestamp inRFC3339
      text format.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: id
    value: "{{ id }}"
    description: |
      [Output Only] The unique identifier for the resource. This identifier is
      defined by the server.
  - name: managed
    description: |
      Configuration and status of a managed SSL certificate.
    value:
      domainStatus: "{{ domainStatus }}"
      domains:
        - "{{ domains }}"
      status: "{{ status }}"
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      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.
  - name: privateKey
    value: "{{ privateKey }}"
    description: |
      A 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.
  - name: selfLink
    value: "{{ selfLink }}"
    description: |
      [Output only] Server-defined URL for the resource.
  - name: selfManaged
    description: |
      Configuration and status of a self-managed SSL certificate.
    value:
      certificate: "{{ certificate }}"
      privateKey: "{{ privateKey }}"
  - name: type
    value: "{{ type }}"
    description: |
      (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or
      "MANAGED". If not specified, the certificate is self-managed and the fieldscertificate and private_key are used.
    valid_values: ['MANAGED', 'SELF_MANAGED', 'TYPE_UNSPECIFIED']
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete

Deletes the specified SslCertificate resource.

DELETE FROM google.compute.ssl_certificates
WHERE project = '{{ project }}' --required
AND sslCertificate = '{{ sslCertificate }}' --required
AND requestId = '{{ requestId }}'
;