verified_access_trust_providers

Creates, updates, deletes or gets a verified_access_trust_provider resource or lists verified_access_trust_providers in a region

Overview

Name	verified_access_trust_providers
Type	Resource
Description	The AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider
Id	awscc.ec2.verified_access_trust_providers

Fields

get (all properties)

Name	Datatype	Description
trust_provider_type	string	Type of trust provider. Possible values: user|device
device_trust_provider_type	string	The type of device-based trust provider. Possible values: jamf|crowdstrike
user_trust_provider_type	string	The type of device-based trust provider. Possible values: oidc|iam-identity-center
▶oidc_options	object	The OpenID Connect details for an oidc -type, user-identity based trust provider.
▶device_options	object	The options for device identity based trust providers.
policy_reference_name	string	The identifier to be used when working with policy rules.
creation_time	string	The creation time.
last_updated_time	string	The last updated time.
verified_access_trust_provider_id	string	The ID of the Amazon Web Services Verified Access trust provider.
description	string	A description for the Amazon Web Services Verified Access trust provider.
▶tags	array	An array of key-value pairs to apply to this resource.
▶sse_specification	object	The configuration options for customer provided KMS encryption.
▶native_application_oidc_options	object	The OpenID Connect details for an oidc -type, user-identity based trust provider for L4.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
verified_access_trust_provider_id	string	The ID of the Amazon Web Services Verified Access trust provider.
region	string	AWS region.

For more information, see AWS::EC2::VerifiedAccessTrustProvider.

Methods

Name	Resource	Accessible by	Required Params
create_resource	verified_access_trust_providers	INSERT	TrustProviderType, PolicyReferenceName, region
delete_resource	verified_access_trust_providers	DELETE	Identifier, region
update_resource	verified_access_trust_providers	UPDATE	Identifier, PatchDocument, region
list_resources	verified_access_trust_providers_list_only	SELECT	region
get_resource	verified_access_trust_providers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual verified_access_trust_provider.

SELECT
  region,
  trust_provider_type,
  device_trust_provider_type,
  user_trust_provider_type,
  oidc_options,
  device_options,
  policy_reference_name,
  creation_time,
  last_updated_time,
  verified_access_trust_provider_id,
  description,
  tags,
  sse_specification,
  native_application_oidc_options
FROM awscc.ec2.verified_access_trust_providers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ verified_access_trust_provider_id }}';

list (identifiers only)

Lists all verified_access_trust_providers in a region.

SELECT
  region,
  verified_access_trust_provider_id
FROM awscc.ec2.verified_access_trust_providers_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.verified_access_trust_providers (
  TrustProviderType,
  PolicyReferenceName,
  region
)
SELECT
  '{{ trust_provider_type }}',
  '{{ policy_reference_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.verified_access_trust_providers (
  TrustProviderType,
  DeviceTrustProviderType,
  UserTrustProviderType,
  OidcOptions,
  DeviceOptions,
  PolicyReferenceName,
  Description,
  Tags,
  SseSpecification,
  NativeApplicationOidcOptions,
  region
)
SELECT
  '{{ trust_provider_type }}',
  '{{ device_trust_provider_type }}',
  '{{ user_trust_provider_type }}',
  '{{ oidc_options }}',
  '{{ device_options }}',
  '{{ policy_reference_name }}',
  '{{ description }}',
  '{{ tags }}',
  '{{ sse_specification }}',
  '{{ native_application_oidc_options }}',
  '{{ 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: verified_access_trust_provider
  props:
    - name: trust_provider_type
      value: '{{ trust_provider_type }}'
    - name: device_trust_provider_type
      value: '{{ device_trust_provider_type }}'
    - name: user_trust_provider_type
      value: '{{ user_trust_provider_type }}'
    - name: oidc_options
      value:
        issuer: '{{ issuer }}'
        authorization_endpoint: '{{ authorization_endpoint }}'
        token_endpoint: '{{ token_endpoint }}'
        user_info_endpoint: '{{ user_info_endpoint }}'
        client_id: '{{ client_id }}'
        client_secret: '{{ client_secret }}'
        scope: '{{ scope }}'
    - name: device_options
      value:
        tenant_id: '{{ tenant_id }}'
        public_signing_key_url: '{{ public_signing_key_url }}'
    - name: policy_reference_name
      value: '{{ policy_reference_name }}'
    - name: description
      value: '{{ description }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: sse_specification
      value:
        kms_key_arn: '{{ kms_key_arn }}'
        customer_managed_key_enabled: '{{ customer_managed_key_enabled }}'
    - name: native_application_oidc_options
      value:
        issuer: '{{ issuer }}'
        authorization_endpoint: '{{ authorization_endpoint }}'
        token_endpoint: '{{ token_endpoint }}'
        user_info_endpoint: '{{ user_info_endpoint }}'
        client_id: '{{ client_id }}'
        client_secret: '{{ client_secret }}'
        scope: '{{ scope }}'
        public_signing_key_endpoint: '{{ public_signing_key_endpoint }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.verified_access_trust_providers
SET PatchDocument = string('{{ {
    "OidcOptions": oidc_options,
    "Description": description,
    "Tags": tags,
    "SseSpecification": sse_specification,
    "NativeApplicationOidcOptions": native_application_oidc_options
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ verified_access_trust_provider_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.verified_access_trust_providers
WHERE
  Identifier = '{{ verified_access_trust_provider_id }}' 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 verified_access_trust_providers resource, the following permissions are required:

Create

ec2:CreateVerifiedAccessTrustProvider,
ec2:DescribeVerifiedAccessTrustProviders,
ec2:CreateTags,
ec2:DescribeTags,
sso:GetSharedSsoConfiguration,
kms:DescribeKey,
kms:RetireGrant,
kms:CreateGrant,
kms:GenerateDataKey,
kms:Decrypt

Read

ec2:DescribeVerifiedAccessTrustProviders,
ec2:DescribeTags,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Update

ec2:ModifyVerifiedAccessTrustProvider,
ec2:DescribeVerifiedAccessTrustProviders,
ec2:DescribeTags,
ec2:DeleteTags,
ec2:CreateTags,
kms:DescribeKey,
kms:RetireGrant,
kms:CreateGrant,
kms:GenerateDataKey,
kms:Decrypt

Delete

ec2:DeleteVerifiedAccessTrustProvider,
ec2:DeleteTags,
ec2:DescribeVerifiedAccessTrustProviders,
ec2:DescribeTags,
kms:DescribeKey,
kms:RetireGrant,
kms:CreateGrant,
kms:GenerateDataKey,
kms:Decrypt

List

ec2:DescribeVerifiedAccessTrustProviders,
ec2:DescribeTags,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt