verified_access_trust_providers

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

Overview

Name	verified_access_trust_providers
Type	Resource
Id	aws.ec2.verified_access_trust_providers

Fields

The following fields are returned by SELECT queries:

describe_verified_access_trust_providers

Name	Datatype	Description
creation_time	string	The creation time.
description	string	A description for the Amazon Web Services Verified Access trust provider.
device_options	string	The options for device-identity trust provider.
device_trust_provider_type	string	The type of device-based trust provider.
last_updated_time	string	The last updated time.
native_application_oidc_options	string	The OpenID Connect (OIDC) options.
oidc_options	string	The options for an OpenID Connect-compatible user-identity trust provider.
policy_reference_name	string	The identifier to be used when working with policy rules.
sse_specification	string	The options in use for server side encryption.
tags	string	The tags.
trust_provider_type	string	The type of Verified Access trust provider.
user_trust_provider_type	string	The type of user-based trust provider.
verified_access_trust_provider_id	string	The ID of the Amazon Web Services Verified Access trust provider.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_verified_access_trust_providers	select	region	VerifiedAccessTrustProviderId, MaxResults, NextToken, Filter, DryRun	Describes the specified Amazon Web Services Verified Access trust providers.
create_verified_access_trust_provider	insert	TrustProviderType, PolicyReferenceName, region	UserTrustProviderType, DeviceTrustProviderType, OidcOptions, DeviceOptions, Description, TagSpecification, ClientToken, DryRun, SseSpecification, NativeApplicationOidcOptions	A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices. When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request.
attach_verified_access_trust_provider	update	VerifiedAccessInstanceId, VerifiedAccessTrustProviderId, region	ClientToken, DryRun	Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.
modify_verified_access_trust_provider	update	VerifiedAccessTrustProviderId, region	OidcOptions, DeviceOptions, Description, DryRun, ClientToken, SseSpecification, NativeApplicationOidcOptions	Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.
delete_verified_access_trust_provider	delete	VerifiedAccessTrustProviderId, region	DryRun, ClientToken	Delete an Amazon Web Services Verified Access trust provider.
detach_verified_access_trust_provider	exec	VerifiedAccessInstanceId, VerifiedAccessTrustProviderId, region	ClientToken, DryRun	Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.

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
PolicyReferenceName	string	The identifier to be used when working with policy rules.
TrustProviderType	string	The type of trust provider.
VerifiedAccessInstanceId	string	The ID of the Verified Access instance.
VerifiedAccessTrustProviderId	string	The ID of the Verified Access trust provider.
region	string	AWS region (default: us-east-1)
ClientToken	string	A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.
Description	string	A description for the Verified Access trust provider.
DeviceOptions	object	The options for a device-based trust provider. This parameter is required when the provider type is device.
DeviceTrustProviderType	string	The type of device-based trust provider. This parameter is required when the provider type is device.
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	One or more filters. Filter names and values are case-sensitive.
MaxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NativeApplicationOidcOptions	object	The OpenID Connect (OIDC) options.
NextToken	string	The token for the next page of results.
OidcOptions	object	The options for an OpenID Connect-compatible user-identity trust provider.
SseSpecification	object	The options for server side encryption.
TagSpecification	array	The tags to assign to the Verified Access trust provider.
UserTrustProviderType	string	The type of user-based trust provider. This parameter is required when the provider type is user.
VerifiedAccessTrustProviderId	array	The IDs of the Verified Access trust providers.

SELECT examples

describe_verified_access_trust_providers

Describes the specified Amazon Web Services Verified Access trust providers.

SELECT
creation_time,
description,
device_options,
device_trust_provider_type,
last_updated_time,
native_application_oidc_options,
oidc_options,
policy_reference_name,
sse_specification,
tags,
trust_provider_type,
user_trust_provider_type,
verified_access_trust_provider_id
FROM aws.ec2.verified_access_trust_providers
WHERE region = '{{ region }}' -- required
AND VerifiedAccessTrustProviderId = '{{ VerifiedAccessTrustProviderId }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND Filter = '{{ Filter }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_verified_access_trust_provider

A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices. When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request.

INSERT INTO aws.ec2.verified_access_trust_providers (
TrustProviderType,
PolicyReferenceName,
region,
UserTrustProviderType,
DeviceTrustProviderType,
OidcOptions,
DeviceOptions,
Description,
TagSpecification,
ClientToken,
DryRun,
SseSpecification,
NativeApplicationOidcOptions
)
SELECT 
'{{ TrustProviderType }}',
'{{ PolicyReferenceName }}',
'{{ region }}',
'{{ UserTrustProviderType }}',
'{{ DeviceTrustProviderType }}',
'{{ OidcOptions }}',
'{{ DeviceOptions }}',
'{{ Description }}',
'{{ TagSpecification }}',
'{{ ClientToken }}',
'{{ DryRun }}',
'{{ SseSpecification }}',
'{{ NativeApplicationOidcOptions }}'
RETURNING
creation_time,
description,
device_options,
device_trust_provider_type,
last_updated_time,
native_application_oidc_options,
oidc_options,
policy_reference_name,
sse_specification,
tags,
trust_provider_type,
user_trust_provider_type,
verified_access_trust_provider_id
;

Manifest

# Description fields are for documentation purposes
- name: verified_access_trust_providers
props:
  - name: TrustProviderType
    value: "{{ TrustProviderType }}"
    description: Required parameter for the verified_access_trust_providers resource.
  - name: PolicyReferenceName
    value: "{{ PolicyReferenceName }}"
    description: Required parameter for the verified_access_trust_providers resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the verified_access_trust_providers resource.
  - name: UserTrustProviderType
    value: "{{ UserTrustProviderType }}"
    description: The type of user-based trust provider. This parameter is required when the provider type is user.
    description: The type of user-based trust provider. This parameter is required when the provider type is user.
  - name: DeviceTrustProviderType
    value: "{{ DeviceTrustProviderType }}"
    description: The type of device-based trust provider. This parameter is required when the provider type is device.
    description: The type of device-based trust provider. This parameter is required when the provider type is device.
  - name: OidcOptions
    value: "{{ OidcOptions }}"
    description: The options for a OpenID Connect-compatible user-identity trust provider. This parameter is required when the provider type is user.
    description: The options for a OpenID Connect-compatible user-identity trust provider. This parameter is required when the provider type is user.
  - name: DeviceOptions
    value: "{{ DeviceOptions }}"
    description: The options for a device-based trust provider. This parameter is required when the provider type is device.
    description: The options for a device-based trust provider. This parameter is required when the provider type is device.
  - name: Description
    value: "{{ Description }}"
    description: A description for the Verified Access trust provider.
    description: A description for the Verified Access trust provider.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to assign to the Verified Access trust provider.
    description: The tags to assign to the Verified Access trust provider.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.
    description: A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.
  - name: DryRun
    value: {{ DryRun }}
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - name: SseSpecification
    value: "{{ SseSpecification }}"
    description: The options for server side encryption.
    description: The options for server side encryption.
  - name: NativeApplicationOidcOptions
    value: "{{ NativeApplicationOidcOptions }}"
    description: The OpenID Connect (OIDC) options.
    description: The OpenID Connect (OIDC) options.

UPDATE examples

attach_verified_access_trust_provider

Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.

UPDATE aws.ec2.verified_access_trust_providers
SET 
-- No updatable properties
WHERE 
VerifiedAccessInstanceId = '{{ VerifiedAccessInstanceId }}' --required
AND VerifiedAccessTrustProviderId = '{{ VerifiedAccessTrustProviderId }}' --required
AND region = '{{ region }}' --required
AND ClientToken = '{{ ClientToken}}'
AND DryRun = {{ DryRun}}
RETURNING
creation_time,
description,
device_options,
device_trust_provider_type,
last_updated_time,
native_application_oidc_options,
oidc_options,
policy_reference_name,
sse_specification,
tags,
trust_provider_type,
user_trust_provider_type,
verified_access_trust_provider_id;

modify_verified_access_trust_provider

Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.

UPDATE aws.ec2.verified_access_trust_providers
SET 
-- No updatable properties
WHERE 
VerifiedAccessTrustProviderId = '{{ VerifiedAccessTrustProviderId }}' --required
AND region = '{{ region }}' --required
AND OidcOptions = '{{ OidcOptions}}'
AND DeviceOptions = '{{ DeviceOptions}}'
AND Description = '{{ Description}}'
AND DryRun = {{ DryRun}}
AND ClientToken = '{{ ClientToken}}'
AND SseSpecification = '{{ SseSpecification}}'
AND NativeApplicationOidcOptions = '{{ NativeApplicationOidcOptions}}'
RETURNING
creation_time,
description,
device_options,
device_trust_provider_type,
last_updated_time,
native_application_oidc_options,
oidc_options,
policy_reference_name,
sse_specification,
tags,
trust_provider_type,
user_trust_provider_type,
verified_access_trust_provider_id;

DELETE examples

delete_verified_access_trust_provider

Delete an Amazon Web Services Verified Access trust provider.

DELETE FROM aws.ec2.verified_access_trust_providers
WHERE VerifiedAccessTrustProviderId = '{{ VerifiedAccessTrustProviderId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
AND ClientToken = '{{ ClientToken }}'
;

Lifecycle Methods

detach_verified_access_trust_provider

Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.

EXEC aws.ec2.verified_access_trust_providers.detach_verified_access_trust_provider 
@VerifiedAccessInstanceId='{{ VerifiedAccessInstanceId }}' --required, 
@VerifiedAccessTrustProviderId='{{ VerifiedAccessTrustProviderId }}' --required, 
@region='{{ region }}' --required, 
@ClientToken='{{ ClientToken }}', 
@DryRun={{ DryRun }}
;