certificate_providers

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

Overview

Name	certificate_providers
Type	Resource
Id	aws.iot.certificate_providers

Fields

The following fields are returned by SELECT queries:

describe_certificate_provider

Name	Datatype	Description
account_default_for_operations	array	A list of the operations that the certificate provider will use to generate certificates. Valid value: CreateCertificateFromCsr.
certificate_provider_arn	string	The ARN of the certificate provider.
certificate_provider_name	string	The name of the certificate provider. (pattern: <code>[\w=,@-]+</code>)
creation_date	string (date-time)	The date-time string that indicates when the certificate provider was created.
lambda_function_arn	string	The Lambda function ARN that's associated with the certificate provider. (pattern: <code>[\s\S]*</code>)
last_modified_date	string (date-time)	The date-time string that indicates when the certificate provider was last updated.

list_certificate_providers

Name	Datatype	Description
certificate_providers	array	The list of certificate providers in your Amazon Web Services account.
next_token	string	The token for the next set of results, or null if there are no more results. (pattern: <code>[A-Za-z0-9+/]+={0,2}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_certificate_provider	select	certificate_provider_name, region		Describes a certificate provider. Requires permission to access the DescribeCertificateProvider action.
list_certificate_providers	select	region	nextToken, isAscendingOrder	Lists all your certificate providers in your Amazon Web Services account. Requires permission to access the ListCertificateProviders action.
create_certificate_provider	insert	certificate_provider_name, region, lambdaFunctionArn, accountDefaultForOperations		Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide. Requires permission to access the CreateCertificateProvider action. After you create a certificate provider, the behavior of CreateCertificateFromCsr API for fleet provisioning will change and all API calls to CreateCertificateFromCsr will invoke the certificate provider to create the certificates. It can take up to a few minutes for this behavior to change after a certificate provider is created.
update_certificate_provider	update	certificate_provider_name, region		Updates a certificate provider. Requires permission to access the UpdateCertificateProvider action.
delete_certificate_provider	delete	certificate_provider_name, region		Deletes a certificate provider. Requires permission to access the DeleteCertificateProvider action. If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr will resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).

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
certificate_provider_name	string	The name of the certificate provider.
region	string	AWS region (default: us-east-1)
isAscendingOrder	boolean	Returns the list of certificate providers in ascending alphabetical order.
nextToken	string	The token for the next set of results, or null if there are no more results.

SELECT examples

describe_certificate_provider

Describes a certificate provider. Requires permission to access the DescribeCertificateProvider action.

SELECT
account_default_for_operations,
certificate_provider_arn,
certificate_provider_name,
creation_date,
lambda_function_arn,
last_modified_date
FROM aws.iot.certificate_providers
WHERE certificate_provider_name = '{{ certificate_provider_name }}' -- required
AND region = '{{ region }}' -- required
;

list_certificate_providers

Lists all your certificate providers in your Amazon Web Services account. Requires permission to access the ListCertificateProviders action.

SELECT
certificate_providers,
next_token
FROM aws.iot.certificate_providers
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND isAscendingOrder = '{{ isAscendingOrder }}'
;

INSERT examples

create_certificate_provider

Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide. Requires permission to access the CreateCertificateProvider action. After you create a certificate provider, the behavior of CreateCertificateFromCsr API for fleet provisioning will change and all API calls to CreateCertificateFromCsr will invoke the certificate provider to create the certificates. It can take up to a few minutes for this behavior to change after a certificate provider is created.

INSERT INTO aws.iot.certificate_providers (
lambdaFunctionArn,
accountDefaultForOperations,
clientToken,
tags,
certificate_provider_name,
region
)
SELECT 
'{{ lambdaFunctionArn }}' /* required */,
'{{ accountDefaultForOperations }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ certificate_provider_name }}',
'{{ region }}'
RETURNING
certificate_provider_arn,
certificate_provider_name
;

Manifest

# Description fields are for documentation purposes
- name: certificate_providers
props:
  - name: certificate_provider_name
    value: "{{ certificate_provider_name }}"
    description: Required parameter for the certificate_providers resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the certificate_providers resource.
  - name: lambdaFunctionArn
    value: "{{ lambdaFunctionArn }}"
  - name: accountDefaultForOperations
    value:
      - "{{ accountDefaultForOperations }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_certificate_provider

Updates a certificate provider. Requires permission to access the UpdateCertificateProvider action.

UPDATE aws.iot.certificate_providers
SET 
lambdaFunctionArn = '{{ lambdaFunctionArn }}',
accountDefaultForOperations = '{{ accountDefaultForOperations }}'
WHERE 
certificate_provider_name = '{{ certificate_provider_name }}' --required
AND region = '{{ region }}' --required
RETURNING
certificate_provider_arn,
certificate_provider_name;

DELETE examples

delete_certificate_provider

Deletes a certificate provider. Requires permission to access the DeleteCertificateProvider action. If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr will resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).

DELETE FROM aws.iot.certificate_providers
WHERE certificate_provider_name = '{{ certificate_provider_name }}' --required
AND region = '{{ region }}' --required
;