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

Successful response

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 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?)
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 in RFC3339 text format.
description	string	An optional description of this resource. Provide this property when you create the resource.
expireTime	string	[Output Only] Expire time of the certificate. RFC3339
kind	string	[Output Only] Type of the resource. Always compute#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] 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] 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 fields certificate and private_key are used.

list

Successful response

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	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 than maxResults, 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] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, region, sslCertificate		Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.
list	select	project, region	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves the list of SslCertificate resources available to the specified project in the specified region.
insert	insert	project, region	requestId	Creates a SslCertificate resource in the specified project and region using the data included in the request
delete	delete	project, region, sslCertificate	requestId	Deletes the specified SslCertificate resource in the region.

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
region	string
sslCertificate	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get

Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.

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 region = '{{ region }}' -- required
AND sslCertificate = '{{ sslCertificate }}' -- required;

list

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

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

INSERT examples

insert

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

INSERT INTO google.compute.ssl_certificates (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__selfLink,
data__certificate,
data__privateKey,
data__managed,
data__selfManaged,
data__type,
data__subjectAlternativeNames,
data__expireTime,
data__region,
project,
region,
requestId
)
SELECT 
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ selfLink }}',
'{{ certificate }}',
'{{ privateKey }}',
'{{ managed }}',
'{{ selfManaged }}',
'{{ type }}',
'{{ subjectAlternativeNames }}',
'{{ expireTime }}',
'{{ region }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
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: string
      description: Required parameter for the ssl_certificates resource.
    - name: region
      value: string
      description: Required parameter for the ssl_certificates resource.
    - name: kind
      value: string
      description: >
        [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
        
      default: compute#sslCertificate
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        Name 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.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: selfLink
      value: string
      description: >
        [Output only] Server-defined URL for the resource.
        
    - name: certificate
      value: string
      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: privateKey
      value: string
      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: managed
      value: object
      description: >
        Configuration and status of a managed SSL certificate.
        
    - name: selfManaged
      value: object
      description: >
        Configuration and status of a self-managed SSL certificate.
        
    - name: type
      value: string
      description: >
        (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.
        
      valid_values: ['MANAGED', 'SELF_MANAGED', 'TYPE_UNSPECIFIED']
    - name: subjectAlternativeNames
      value: array
      description: >
        [Output Only] Domains associated with the certificate via Subject Alternative Name.
        
    - name: expireTime
      value: string
      description: >
        [Output Only] Expire time of the certificate. RFC3339
        
    - name: region
      value: string
      description: >
        [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
        
    - name: requestId
      value: string

DELETE examples

delete

Deletes the specified SslCertificate resource in the region.

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