certificates

Creates, updates, deletes or gets a certificate resource or lists certificates in a region

Overview

Name	certificates
Type	Resource
Description	Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate.
Id	awscc.iot.certificates

Fields

get (all properties)

Name	Datatype	Description
ca_certificate_pem	string
certificate_pem	string
certificate_signing_request	string
certificate_mode	string
status	string
id	string
arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

For more information, see AWS::IoT::Certificate.

Methods

Name	Resource	Accessible by	Required Params
create_resource	certificates	INSERT	Status, region
delete_resource	certificates	DELETE	Identifier, region
update_resource	certificates	UPDATE	Identifier, PatchDocument, region
list_resources	certificates_list_only	SELECT	region
get_resource	certificates	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual certificate.

SELECT
  region,
  ca_certificate_pem,
  certificate_pem,
  certificate_signing_request,
  certificate_mode,
  status,
  id,
  arn
FROM awscc.iot.certificates
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all certificates in a region.

SELECT
  region,
  id
FROM awscc.iot.certificates_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new certificate resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.iot.certificates (
  Status,
  region
)
SELECT
  '{{ status }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iot.certificates (
  CACertificatePem,
  CertificatePem,
  CertificateSigningRequest,
  CertificateMode,
  Status,
  region
)
SELECT
  '{{ ca_certificate_pem }}',
  '{{ certificate_pem }}',
  '{{ certificate_signing_request }}',
  '{{ certificate_mode }}',
  '{{ status }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: certificate
    props:
      - name: ca_certificate_pem
        value: '{{ ca_certificate_pem }}'
      - name: certificate_pem
        value: '{{ certificate_pem }}'
      - name: certificate_signing_request
        value: '{{ certificate_signing_request }}'
      - name: certificate_mode
        value: '{{ certificate_mode }}'
      - name: status
        value: '{{ status }}'

UPDATE example

Use the following StackQL query and manifest file to update a certificate resource, using stack-deploy.

/*+ update */
UPDATE awscc.iot.certificates
SET PatchDocument = string('{{ {
    "Status": status
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.iot.certificates
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

Permissions

To operate on the certificates resource, the following permissions are required:

Create

iot:CreateCertificateFromCsr,
iot:RegisterCertificate,
iot:RegisterCertificateWithoutCA,
iot:DescribeCertificate,
kms:Decrypt

Read

iot:DescribeCertificate,
kms:Decrypt

Update

iot:UpdateCertificate,
iot:DescribeCertificate,
kms:Decrypt

Delete

iot:DeleteCertificate,
iot:UpdateCertificate,
iot:DescribeCertificate,
kms:Decrypt

List

iot:ListCertificates