group_certificate_authorities

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

Overview

Name	group_certificate_authorities
Type	Resource
Id	aws.greengrass.group_certificate_authorities

Fields

The following fields are returned by SELECT queries:

get_group_certificate_authority

Name	Datatype	Description
group_certificate_authority_arn	string	The ARN of the certificate authority for the group.
group_certificate_authority_id	string	The ID of the certificate authority for the group.
pem_encoded_certificate	string	The PEM encoded certificate for the group.

list_group_certificate_authorities

Name	Datatype	Description
group_certificate_authorities	array	A list of certificate authorities associated with the group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_group_certificate_authority	select	certificate_authority_id, group_id, region		Retreives the CA associated with a group. Returns the public key of the CA.
list_group_certificate_authorities	select	group_id, region		Retrieves the current CAs for a group.
create_group_certificate_authority	insert	group_id, region	X-Amzn-Client-Token	Creates a CA for the group. If a CA already exists, it will rotate the existing CA.

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_authority_id	string	The ID of the certificate authority.
group_id	string	The ID of the Greengrass group.
region	string	AWS region (default: us-east-1)
X-Amzn-Client-Token	string	A client token used to correlate requests and responses.

SELECT examples

get_group_certificate_authority

Retreives the CA associated with a group. Returns the public key of the CA.

SELECT
group_certificate_authority_arn,
group_certificate_authority_id,
pem_encoded_certificate
FROM aws.greengrass.group_certificate_authorities
WHERE certificate_authority_id = '{{ certificate_authority_id }}' -- required
AND group_id = '{{ group_id }}' -- required
AND region = '{{ region }}' -- required
;

list_group_certificate_authorities

Retrieves the current CAs for a group.

SELECT
group_certificate_authorities
FROM aws.greengrass.group_certificate_authorities
WHERE group_id = '{{ group_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_group_certificate_authority

Creates a CA for the group. If a CA already exists, it will rotate the existing CA.

INSERT INTO aws.greengrass.group_certificate_authorities (
group_id,
region,
`X-Amzn-Client-Token`
)
SELECT 
'{{ group_id }}',
'{{ region }}',
'{{ X-Amzn-Client-Token }}'
RETURNING
group_certificate_authority_arn
;

Manifest

# Description fields are for documentation purposes
- name: group_certificate_authorities
props:
  - name: group_id
    value: "{{ group_id }}"
    description: Required parameter for the group_certificate_authorities resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the group_certificate_authorities resource.
  - name: X-Amzn-Client-Token
    value: "{{ X-Amzn-Client-Token }}"
    description: A client token used to correlate requests and responses.
    description: A client token used to correlate requests and responses.