certificate_providers

Creates, updates, deletes or gets a certificate_provider resource or lists certificate_providers in a region

Overview

Name	certificate_providers
Type	Resource
Description	Use the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider.
Id	awscc.iot.certificate_providers

Fields

get (all properties)

Name	Datatype	Description
certificate_provider_name	string
lambda_function_arn	string
account_default_for_operations	array
▶tags	array	An array of key-value pairs to apply to this resource.
arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
certificate_provider_name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	certificate_providers	INSERT	LambdaFunctionArn, AccountDefaultForOperations, region
delete_resource	certificate_providers	DELETE	Identifier, region
update_resource	certificate_providers	UPDATE	Identifier, PatchDocument, region
list_resources	certificate_providers_list_only	SELECT	region
get_resource	certificate_providers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual certificate_provider.

SELECT
  region,
  certificate_provider_name,
  lambda_function_arn,
  account_default_for_operations,
  tags,
  arn
FROM awscc.iot.certificate_providers
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ certificate_provider_name }}';

list (identifiers only)

Lists all certificate_providers in a region.

SELECT
  region,
  certificate_provider_name
FROM awscc.iot.certificate_providers_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.iot.certificate_providers (
  LambdaFunctionArn,
  AccountDefaultForOperations,
  region
)
SELECT
  '{{ lambda_function_arn }}',
  '{{ account_default_for_operations }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iot.certificate_providers (
  CertificateProviderName,
  LambdaFunctionArn,
  AccountDefaultForOperations,
  Tags,
  region
)
SELECT
  '{{ certificate_provider_name }}',
  '{{ lambda_function_arn }}',
  '{{ account_default_for_operations }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: certificate_provider
    props:
      - name: certificate_provider_name
        value: '{{ certificate_provider_name }}'
      - name: lambda_function_arn
        value: '{{ lambda_function_arn }}'
      - name: account_default_for_operations
        value:
          - '{{ account_default_for_operations[0] }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iot.certificate_providers
SET PatchDocument = string('{{ {
    "LambdaFunctionArn": lambda_function_arn,
    "AccountDefaultForOperations": account_default_for_operations,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ certificate_provider_name }}';

DELETE example

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

Permissions

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

Create

iot:CreateCertificateProvider,
iot:DescribeCertificateProvider,
iot:TagResource,
iot:ListTagsForResource,
kms:Decrypt

Read

iot:DescribeCertificateProvider,
iot:ListTagsForResource,
kms:Decrypt

Update

iot:UpdateCertificateProvider,
iot:DescribeCertificateProvider,
iot:TagResource,
iot:UntagResource,
iot:ListTagsForResource,
kms:Decrypt

Delete

iot:DeleteCertificateProvider,
iot:DescribeCertificateProvider,
kms:Decrypt

List

iot:ListCertificateProviders