certificate_issuance_configs

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

Overview

Name	`certificate_issuance_configs`
Type	Resource
Id	`google.certificatemanager.certificate_issuance_configs`

Fields

The following fields are returned by SELECT queries:

get
list

Successful response

Name	Datatype	Description
`name`	`string`	Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects//locations//certificateIssuanceConfigs/*`.
`certificateAuthorityConfig`	`object`	Required. The CA that issues the workload certificate. It includes the CA address, type, authentication to CA service, etc. (id: CertificateAuthorityConfig)
`createTime`	`string (google-datetime)`	Output only. The creation timestamp of a CertificateIssuanceConfig.
`description`	`string`	Optional. One or more paragraphs of text description of a CertificateIssuanceConfig.
`keyAlgorithm`	`string`	Required. The key algorithm to use when generating the private key.
`labels`	`object`	Optional. Set of labels associated with a CertificateIssuanceConfig.
`lifetime`	`string (google-duration)`	Required. Workload certificate lifetime requested.
`rotationWindowPercentage`	`integer (int32)`	Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive.
`updateTime`	`string (google-datetime)`	Output only. The last update timestamp of a CertificateIssuanceConfig.

Successful response

Name	Datatype	Description
`name`	`string`	Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects//locations//certificateIssuanceConfigs/*`.
`certificateAuthorityConfig`	`object`	Required. The CA that issues the workload certificate. It includes the CA address, type, authentication to CA service, etc. (id: CertificateAuthorityConfig)
`createTime`	`string (google-datetime)`	Output only. The creation timestamp of a CertificateIssuanceConfig.
`description`	`string`	Optional. One or more paragraphs of text description of a CertificateIssuanceConfig.
`keyAlgorithm`	`string`	Required. The key algorithm to use when generating the private key.
`labels`	`object`	Optional. Set of labels associated with a CertificateIssuanceConfig.
`lifetime`	`string (google-duration)`	Required. Workload certificate lifetime requested.
`rotationWindowPercentage`	`integer (int32)`	Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive.
`updateTime`	`string (google-datetime)`	Output only. The last update timestamp of a CertificateIssuanceConfig.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `certificateIssuanceConfigsId`		Gets details of a single CertificateIssuanceConfig.
`list`	`select`	`projectsId`, `locationsId`	`pageSize`, `pageToken`, `filter`, `orderBy`	Lists CertificateIssuanceConfigs in a given project and location.
`create`	`insert`	`projectsId`, `locationsId`	`certificateIssuanceConfigId`	Creates a new CertificateIssuanceConfig in a given project and location.
`patch`	`update`	`projectsId`, `locationsId`, `certificateIssuanceConfigsId`	`updateMask`	Updates a CertificateIssuanceConfig.
`delete`	`delete`	`projectsId`, `locationsId`, `certificateIssuanceConfigsId`		Deletes a single CertificateIssuanceConfig.

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
`certificateIssuanceConfigsId`	`string`
`locationsId`	`string`
`projectsId`	`string`
`certificateIssuanceConfigId`	`string`
`filter`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Gets details of a single CertificateIssuanceConfig.

SELECT
name,
certificateAuthorityConfig,
createTime,
description,
keyAlgorithm,
labels,
lifetime,
rotationWindowPercentage,
updateTime
FROM google.certificatemanager.certificate_issuance_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND certificateIssuanceConfigsId = '{{ certificateIssuanceConfigsId }}' -- required;

Lists CertificateIssuanceConfigs in a given project and location.

SELECT
name,
certificateAuthorityConfig,
createTime,
description,
keyAlgorithm,
labels,
lifetime,
rotationWindowPercentage,
updateTime
FROM google.certificatemanager.certificate_issuance_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

`INSERT` examples

create
Manifest

Creates a new CertificateIssuanceConfig in a given project and location.

INSERT INTO google.certificatemanager.certificate_issuance_configs (
data__name,
data__labels,
data__description,
data__certificateAuthorityConfig,
data__lifetime,
data__rotationWindowPercentage,
data__keyAlgorithm,
projectsId,
locationsId,
certificateIssuanceConfigId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ description }}',
'{{ certificateAuthorityConfig }}',
'{{ lifetime }}',
{{ rotationWindowPercentage }},
'{{ keyAlgorithm }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ certificateIssuanceConfigId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: certificate_issuance_configs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the certificate_issuance_configs resource.
    - name: locationsId
      value: string
      description: Required parameter for the certificate_issuance_configs resource.
    - name: name
      value: string
      description: >
        Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.
        
    - name: labels
      value: object
      description: >
        Optional. Set of labels associated with a CertificateIssuanceConfig.
        
    - name: description
      value: string
      description: >
        Optional. One or more paragraphs of text description of a CertificateIssuanceConfig.
        
    - name: certificateAuthorityConfig
      value: object
      description: >
        Required. The CA that issues the workload certificate. It includes the CA address, type, authentication to CA service, etc.
        
    - name: lifetime
      value: string
      description: >
        Required. Workload certificate lifetime requested.
        
    - name: rotationWindowPercentage
      value: integer
      description: >
        Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive.
        
    - name: keyAlgorithm
      value: string
      description: >
        Required. The key algorithm to use when generating the private key.
        
      valid_values: ['KEY_ALGORITHM_UNSPECIFIED', 'RSA_2048', 'ECDSA_P256']
    - name: certificateIssuanceConfigId
      value: string

`UPDATE` examples

patch

Updates a CertificateIssuanceConfig.

UPDATE google.certificatemanager.certificate_issuance_configs
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__certificateAuthorityConfig = '{{ certificateAuthorityConfig }}',
data__lifetime = '{{ lifetime }}',
data__rotationWindowPercentage = {{ rotationWindowPercentage }},
data__keyAlgorithm = '{{ keyAlgorithm }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND certificateIssuanceConfigsId = '{{ certificateIssuanceConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

delete

Deletes a single CertificateIssuanceConfig.

DELETE FROM google.certificatemanager.certificate_issuance_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND certificateIssuanceConfigsId = '{{ certificateIssuanceConfigsId }}' --required;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​