credential_lockers

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

Overview

Name	credential_lockers
Type	Resource
Id	aws.iot_managed_integrations.credential_lockers

Fields

The following fields are returned by SELECT queries:

get_credential_locker

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the credential locker. (pattern: <code>arn:aws:iotmanagedintegrations:[0-9a-zA-Z-]+:[0-9]+:credential-locker/[0-9a-zA-Z]+</code>)
created_at	string (date-time)	The timestamp value of when the credential locker requset occurred.
id	string	The identifier of the credential locker. (pattern: <code>[a-zA-Z0-9]*</code>)
name	string	The name of the credential locker. (pattern: <code>[A-Za-z0-9-_ ]+</code>)
tags	object	A set of key/value pairs that are used to manage the credential locker.

list_credential_lockers

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the credential locker. (pattern: <code>arn:aws:iotmanagedintegrations:[0-9a-zA-Z-]+:[0-9]+:credential-locker/[0-9a-zA-Z]+</code>)
created_at	string (date-time)	The timestampe value of when the credential locker was created at.
id	string	The id of the credential locker. (pattern: <code>[a-zA-Z0-9]*</code>)
name	string	The name of the credential locker. (pattern: <code>[A-Za-z0-9-_ ]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_credential_locker	select	identifier, region		Get information on an existing credential locker
list_credential_lockers	select	region	NextToken, MaxResults	List information on an existing credential locker.
create_credential_locker	insert	region		Create a credential locker. This operation will not trigger the creation of all the manufacturing resources.
delete_credential_locker	delete	identifier, region		Delete a credential locker. This operation can't be undone and any existing device won't be able to use IoT managed integrations.

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
identifier	string	The identifier of the credential locker.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum number of results to return at one time.
NextToken	string	A token that can be used to retrieve the next set of results.

SELECT examples

get_credential_locker

Get information on an existing credential locker

SELECT
arn,
created_at,
id,
name,
tags
FROM aws.iot_managed_integrations.credential_lockers
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_credential_lockers

List information on an existing credential locker.

SELECT
arn,
created_at,
id,
name
FROM aws.iot_managed_integrations.credential_lockers
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

INSERT examples

create_credential_locker

Create a credential locker. This operation will not trigger the creation of all the manufacturing resources.

INSERT INTO aws.iot_managed_integrations.credential_lockers (
Name,
ClientToken,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ ClientToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
created_at,
id
;

Manifest

# Description fields are for documentation purposes
- name: credential_lockers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the credential_lockers resource.
  - name: Name
    value: "{{ Name }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_credential_locker

Delete a credential locker. This operation can't be undone and any existing device won't be able to use IoT managed integrations.

DELETE FROM aws.iot_managed_integrations.credential_lockers
WHERE identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;