trust_stores

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

Overview

Name	trust_stores
Type	Resource
Id	aws.elbv2.trust_stores

Fields

The following fields are returned by SELECT queries:

describe_trust_stores

Name	Datatype	Description
name	string	The name of the trust store.
number_of_ca_certificates	integer	The number of ca certificates in the trust store.
status	string	The current status of the trust store.
total_revoked_entries	integer	The number of revoked certificates in the trust store.
trust_store_arn	string	The Amazon Resource Name (ARN) of the trust store.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_trust_stores	select	region	TrustStoreArns, Names, Marker, PageSize	Describes all trust stores for the specified account.
create_trust_store	insert	CaCertificatesBundleS3Bucket, CaCertificatesBundleS3Key, region	Name, CaCertificatesBundleS3ObjectVersion, Tags	Creates a trust store. For more information, see Mutual TLS for Application Load Balancers.
modify_trust_store	update	TrustStoreArn, CaCertificatesBundleS3Bucket, CaCertificatesBundleS3Key, region	CaCertificatesBundleS3ObjectVersion	Update the ca certificate bundle for the specified trust store.
delete_trust_store	delete	TrustStoreArn, region		Deletes a trust store.

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
CaCertificatesBundleS3Bucket	string	The Amazon S3 bucket for the ca certificates bundle.
CaCertificatesBundleS3Key	string	The Amazon S3 path for the ca certificates bundle.
TrustStoreArn	string	The Amazon Resource Name (ARN) of the trust store.
region	string	AWS region (default: us-east-1)
CaCertificatesBundleS3ObjectVersion	string	The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used.
Marker	string	The marker for the next set of results. (You received this marker from a previous call.)
Name	string	The name of the trust store. This name must be unique per region and can't be changed after creation.
Names	array	The names of the trust stores.
PageSize	integer	The maximum number of results to return with this call.
Tags	array	The tags to assign to the trust store.
TrustStoreArns	array	The Amazon Resource Name (ARN) of the trust store.

SELECT examples

describe_trust_stores

Describes all trust stores for the specified account.

SELECT
name,
number_of_ca_certificates,
status,
total_revoked_entries,
trust_store_arn
FROM aws.elbv2.trust_stores
WHERE region = '{{ region }}' -- required
AND TrustStoreArns = '{{ TrustStoreArns }}'
AND Names = '{{ Names }}'
AND Marker = '{{ Marker }}'
AND PageSize = '{{ PageSize }}'
;

INSERT examples

create_trust_store

Creates a trust store. For more information, see Mutual TLS for Application Load Balancers.

INSERT INTO aws.elbv2.trust_stores (
CaCertificatesBundleS3Bucket,
CaCertificatesBundleS3Key,
region,
Name,
CaCertificatesBundleS3ObjectVersion,
Tags
)
SELECT 
'{{ CaCertificatesBundleS3Bucket }}',
'{{ CaCertificatesBundleS3Key }}',
'{{ region }}',
'{{ Name }}',
'{{ CaCertificatesBundleS3ObjectVersion }}',
'{{ Tags }}'
RETURNING
line_items
;

Manifest

# Description fields are for documentation purposes
- name: trust_stores
props:
  - name: CaCertificatesBundleS3Bucket
    value: "{{ CaCertificatesBundleS3Bucket }}"
    description: Required parameter for the trust_stores resource.
  - name: CaCertificatesBundleS3Key
    value: "{{ CaCertificatesBundleS3Key }}"
    description: Required parameter for the trust_stores resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the trust_stores resource.
  - name: Name
    value: "{{ Name }}"
    description: The name of the trust store. This name must be unique per region and can't be changed after creation.
    description: The name of the trust store. This name must be unique per region and can't be changed after creation.
  - name: CaCertificatesBundleS3ObjectVersion
    value: "{{ CaCertificatesBundleS3ObjectVersion }}"
    description: The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used.
    description: The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used.
  - name: Tags
    value: "{{ Tags }}"
    description: The tags to assign to the trust store.
    description: The tags to assign to the trust store.

UPDATE examples

modify_trust_store

Update the ca certificate bundle for the specified trust store.

UPDATE aws.elbv2.trust_stores
SET 
-- No updatable properties
WHERE 
TrustStoreArn = '{{ TrustStoreArn }}' --required
AND CaCertificatesBundleS3Bucket = '{{ CaCertificatesBundleS3Bucket }}' --required
AND CaCertificatesBundleS3Key = '{{ CaCertificatesBundleS3Key }}' --required
AND region = '{{ region }}' --required
AND CaCertificatesBundleS3ObjectVersion = '{{ CaCertificatesBundleS3ObjectVersion}}'
RETURNING
line_items;

DELETE examples

delete_trust_store

Deletes a trust store.

DELETE FROM aws.elbv2.trust_stores
WHERE TrustStoreArn = '{{ TrustStoreArn }}' --required
AND region = '{{ region }}' --required
;