trust_stores

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

Overview

Name	trust_stores
Type	Resource
Id	aws.workspaces_web.trust_stores

Fields

The following fields are returned by SELECT queries:

get_trust_store

Name	Datatype	Description
associated_portal_arns	array	A list of web portal ARNs that this trust store is associated with.
trust_store_arn	string	The ARN of the trust store. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)

list_trust_stores

Name	Datatype	Description
next_token	string	The pagination token used to retrieve the next page of results for this operation. (pattern: <code>\S+</code>)
trust_stores	array	The trust stores.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_trust_store	select	trust_store_arn, region		Gets the trust store.
list_trust_stores	select	region	nextToken, maxResults	Retrieves a list of trust stores.
create_trust_store	insert	region, certificateList		Creates a trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store.
associate_trust_store	update	portal_arn, trustStoreArn, region		Associates a trust store with a web portal.
disassociate_trust_store	update	portal_arn, region		Disassociates a trust store from a web portal.
update_trust_store	update	trust_store_arn, region		Updates the trust store.
delete_trust_store	delete	trust_store_arn, region		Deletes the 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
portal_arn	string	The ARN of the web portal.
region	string	AWS region (default: us-east-1)
trustStoreArn	string	The ARN of the trust store.
trust_store_arn	string	The ARN of the trust store.
maxResults	integer	The maximum number of results to be included in the next page.
nextToken	string	The pagination token used to retrieve the next page of results for this operation.

SELECT examples

get_trust_store

Gets the trust store.

SELECT
associated_portal_arns,
trust_store_arn
FROM aws.workspaces_web.trust_stores
WHERE trust_store_arn = '{{ trust_store_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_trust_stores

Retrieves a list of trust stores.

SELECT
next_token,
trust_stores
FROM aws.workspaces_web.trust_stores
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_trust_store

Creates a trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store.

INSERT INTO aws.workspaces_web.trust_stores (
certificateList,
tags,
clientToken,
region
)
SELECT 
'{{ certificateList }}' /* required */,
'{{ tags }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
trust_store_arn
;

Manifest

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

UPDATE examples

associate_trust_store

Associates a trust store with a web portal.

UPDATE aws.workspaces_web.trust_stores
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND trustStoreArn = '{{ trustStoreArn }}' --required
AND region = '{{ region }}' --required
RETURNING
portal_arn,
trust_store_arn;

disassociate_trust_store

Disassociates a trust store from a web portal.

UPDATE aws.workspaces_web.trust_stores
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND region = '{{ region }}' --required;

update_trust_store

Updates the trust store.

UPDATE aws.workspaces_web.trust_stores
SET 
certificatesToAdd = '{{ certificatesToAdd }}',
certificatesToDelete = '{{ certificatesToDelete }}',
clientToken = '{{ clientToken }}'
WHERE 
trust_store_arn = '{{ trust_store_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
trust_store_arn;

DELETE examples

delete_trust_store

Deletes the trust store.

DELETE FROM aws.workspaces_web.trust_stores
WHERE trust_store_arn = '{{ trust_store_arn }}' --required
AND region = '{{ region }}' --required
;