ca_certificates

Creates, updates, deletes or gets a ca_certificate resource or lists ca_certificates in a region

Overview

Name	ca_certificates
Type	Resource
Description	Registers a CA Certificate in IoT.
Id	awscc.iot.ca_certificates

Fields

get (all properties)

Name	Datatype	Description
ca_certificate_pem	string
verification_certificate_pem	string	The private key verification certificate.
status	string
certificate_mode	string
auto_registration_status	string
remove_auto_registration	boolean
▶registration_config	object
id	string
arn	string
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual ca_certificate.

SELECT
  region,
  ca_certificate_pem,
  verification_certificate_pem,
  status,
  certificate_mode,
  auto_registration_status,
  remove_auto_registration,
  registration_config,
  id,
  arn,
  tags
FROM awscc.iot.ca_certificates
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all ca_certificates in a region.

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

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.iot.ca_certificates (
  CACertificatePem,
  VerificationCertificatePem,
  Status,
  CertificateMode,
  AutoRegistrationStatus,
  RemoveAutoRegistration,
  RegistrationConfig,
  Tags,
  region
)
SELECT
  '{{ ca_certificate_pem }}',
  '{{ verification_certificate_pem }}',
  '{{ status }}',
  '{{ certificate_mode }}',
  '{{ auto_registration_status }}',
  '{{ remove_auto_registration }}',
  '{{ registration_config }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: ca_certificate
    props:
      - name: ca_certificate_pem
        value: '{{ ca_certificate_pem }}'
      - name: verification_certificate_pem
        value: '{{ verification_certificate_pem }}'
      - name: status
        value: '{{ status }}'
      - name: certificate_mode
        value: '{{ certificate_mode }}'
      - name: auto_registration_status
        value: '{{ auto_registration_status }}'
      - name: remove_auto_registration
        value: '{{ remove_auto_registration }}'
      - name: registration_config
        value:
          template_body: '{{ template_body }}'
          role_arn: '{{ role_arn }}'
          template_name: '{{ template_name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iot.ca_certificates
SET PatchDocument = string('{{ {
    "Status": status,
    "AutoRegistrationStatus": auto_registration_status,
    "RemoveAutoRegistration": remove_auto_registration,
    "RegistrationConfig": registration_config,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

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

Permissions

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

Create

iam:GetRole,
iam:PassRole,
iot:RegisterCACertificate,
iot:DescribeCACertificate,
iot:TagResource,
iot:ListTagsForResource,
kms:Decrypt

Read

iot:DescribeCACertificate,
iot:ListTagsForResource,
kms:Decrypt

Update

iam:GetRole,
iam:PassRole,
iot:UpdateCACertificate,
iot:DescribeCACertificate,
iot:TagResource,
iot:UntagResource,
iot:ListTagsForResource,
kms:Decrypt

Delete

iot:UpdateCACertificate,
iot:DeleteCACertificate,
iot:DescribeCACertificate,
kms:Decrypt

List

iot:ListCACertificates