trust_stores

Creates, updates, deletes or gets a trust_store resource or lists trust_stores in a region

Overview

Name	trust_stores
Type	Resource
Description	Resource Type definition for AWS::ElasticLoadBalancingV2::TrustStore
Id	awscc.elasticloadbalancingv2.trust_stores

Fields

get (all properties)

Name	Datatype	Description
name	string	The name of the trust store.
ca_certificates_bundle_s3_bucket	string	The name of the S3 bucket to fetch the CA certificate bundle from.
ca_certificates_bundle_s3_key	string	The name of the S3 object to fetch the CA certificate bundle from.
ca_certificates_bundle_s3_object_version	string	The version of the S3 bucket that contains the CA certificate bundle.
status	string	The status of the trust store, could be either of ACTIVE or CREATING.
number_of_ca_certificates	integer	The number of certificates associated with the trust store.
▶tags	array	The tags to assign to the trust store.
trust_store_arn	string	The Amazon Resource Name (ARN) of the trust store.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
trust_store_arn	string	The Amazon Resource Name (ARN) of the trust store.
region	string	AWS region.

For more information, see AWS::ElasticLoadBalancingV2::TrustStore.

Methods

Name	Resource	Accessible by	Required Params
create_resource	trust_stores	INSERT	region
delete_resource	trust_stores	DELETE	Identifier, region
update_resource	trust_stores	UPDATE	Identifier, PatchDocument, region
list_resources	trust_stores_list_only	SELECT	region
get_resource	trust_stores	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual trust_store.

SELECT
  region,
  name,
  ca_certificates_bundle_s3_bucket,
  ca_certificates_bundle_s3_key,
  ca_certificates_bundle_s3_object_version,
  status,
  number_of_ca_certificates,
  tags,
  trust_store_arn
FROM awscc.elasticloadbalancingv2.trust_stores
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ trust_store_arn }}';

list (identifiers only)

Lists all trust_stores in a region.

SELECT
  region,
  trust_store_arn
FROM awscc.elasticloadbalancingv2.trust_stores_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new trust_store resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.elasticloadbalancingv2.trust_stores (
  Name,
  CaCertificatesBundleS3Bucket,
  CaCertificatesBundleS3Key,
  CaCertificatesBundleS3ObjectVersion,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ ca_certificates_bundle_s3_bucket }}',
  '{{ ca_certificates_bundle_s3_key }}',
  '{{ ca_certificates_bundle_s3_object_version }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.elasticloadbalancingv2.trust_stores (
  Name,
  CaCertificatesBundleS3Bucket,
  CaCertificatesBundleS3Key,
  CaCertificatesBundleS3ObjectVersion,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ ca_certificates_bundle_s3_bucket }}',
  '{{ ca_certificates_bundle_s3_key }}',
  '{{ ca_certificates_bundle_s3_object_version }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: trust_store
  props:
    - name: name
      value: '{{ name }}'
    - name: ca_certificates_bundle_s3_bucket
      value: '{{ ca_certificates_bundle_s3_bucket }}'
    - name: ca_certificates_bundle_s3_key
      value: '{{ ca_certificates_bundle_s3_key }}'
    - name: ca_certificates_bundle_s3_object_version
      value: '{{ ca_certificates_bundle_s3_object_version }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

UPDATE example

Use the following StackQL query and manifest file to update a trust_store resource, using stack-deploy.

/*+ update */
UPDATE awscc.elasticloadbalancingv2.trust_stores
SET PatchDocument = string('{{ {
    "CaCertificatesBundleS3Bucket": ca_certificates_bundle_s3_bucket,
    "CaCertificatesBundleS3Key": ca_certificates_bundle_s3_key,
    "CaCertificatesBundleS3ObjectVersion": ca_certificates_bundle_s3_object_version,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ trust_store_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.elasticloadbalancingv2.trust_stores
WHERE
  Identifier = '{{ trust_store_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the trust_stores resource, the following permissions are required:

Create

elasticloadbalancing:CreateTrustStore,
elasticloadbalancing:DescribeTrustStores,
elasticloadbalancing:AddTags,
s3:GetObject,
s3:GetObjectVersion

Delete

elasticloadbalancing:DescribeTrustStores,
elasticloadbalancing:DeleteTrustStore

List

elasticloadbalancing:DescribeTrustStores,
s3:GetObject,
s3:GetObjectVersion

Read

elasticloadbalancing:DescribeTrustStores,
elasticloadbalancing:DescribeTags

Update

elasticloadbalancing:ModifyTrustStore,
elasticloadbalancing:AddTags,
elasticloadbalancing:RemoveTags,
s3:GetObject,
s3:GetObjectVersion