verified_access_groups

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

Overview

Name	verified_access_groups
Type	Resource
Id	aws.ec2.verified_access_groups

Fields

The following fields are returned by SELECT queries:

describe_verified_access_groups

Name	Datatype	Description
creation_time	string	The creation time.
deletion_time	string	The deletion time.
description	string	A description for the Amazon Web Services Verified Access group.
last_updated_time	string	The last updated time.
owner	string	The Amazon Web Services account number that owns the group.
sse_specification	string	The options in use for server side encryption.
tags	string	The tags.
verified_access_group_arn	string	The ARN of the Verified Access group.
verified_access_group_id	string	The ID of the Verified Access group.
verified_access_instance_id	string	The ID of the Amazon Web Services Verified Access instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_verified_access_groups	select	region	VerifiedAccessGroupId, VerifiedAccessInstanceId, MaxResults, NextToken, Filter, DryRun	Describes the specified Verified Access groups.
create_verified_access_group	insert	VerifiedAccessInstanceId, region	Description, PolicyDocument, TagSpecification, ClientToken, DryRun, SseSpecification	An Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have similar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For example, you can group all Verified Access instances associated with "sales" applications together and use one common Verified Access policy.
modify_verified_access_group	update	VerifiedAccessGroupId, region	VerifiedAccessInstanceId, Description, ClientToken, DryRun	Modifies the specified Amazon Web Services Verified Access group configuration.
delete_verified_access_group	delete	VerifiedAccessGroupId, region	ClientToken, DryRun	Delete an Amazon Web Services Verified Access group.

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
VerifiedAccessGroupId	string	The ID of the Verified Access group.
VerifiedAccessInstanceId	string	The ID of the Verified Access instance.
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 group.
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.
NextToken	string	The token for the next page of results.
PolicyDocument	string	The Verified Access policy document.
SseSpecification	object	The options for server side encryption.
TagSpecification	array	The tags to assign to the Verified Access group.
VerifiedAccessGroupId	array	The ID of the Verified Access groups.
VerifiedAccessInstanceId	string	The ID of the Verified Access instance.

SELECT examples

describe_verified_access_groups

Describes the specified Verified Access groups.

SELECT
creation_time,
deletion_time,
description,
last_updated_time,
owner,
sse_specification,
tags,
verified_access_group_arn,
verified_access_group_id,
verified_access_instance_id
FROM aws.ec2.verified_access_groups
WHERE region = '{{ region }}' -- required
AND VerifiedAccessGroupId = '{{ VerifiedAccessGroupId }}'
AND VerifiedAccessInstanceId = '{{ VerifiedAccessInstanceId }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND Filter = '{{ Filter }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_verified_access_group

An Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have similar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For example, you can group all Verified Access instances associated with "sales" applications together and use one common Verified Access policy.

INSERT INTO aws.ec2.verified_access_groups (
VerifiedAccessInstanceId,
region,
Description,
PolicyDocument,
TagSpecification,
ClientToken,
DryRun,
SseSpecification
)
SELECT 
'{{ VerifiedAccessInstanceId }}',
'{{ region }}',
'{{ Description }}',
'{{ PolicyDocument }}',
'{{ TagSpecification }}',
'{{ ClientToken }}',
'{{ DryRun }}',
'{{ SseSpecification }}'
RETURNING
creation_time,
deletion_time,
description,
last_updated_time,
owner,
sse_specification,
tags,
verified_access_group_arn,
verified_access_group_id,
verified_access_instance_id
;

Manifest

# Description fields are for documentation purposes
- name: verified_access_groups
props:
  - name: VerifiedAccessInstanceId
    value: "{{ VerifiedAccessInstanceId }}"
    description: Required parameter for the verified_access_groups resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the verified_access_groups resource.
  - name: Description
    value: "{{ Description }}"
    description: A description for the Verified Access group.
    description: A description for the Verified Access group.
  - name: PolicyDocument
    value: "{{ PolicyDocument }}"
    description: The Verified Access policy document.
    description: The Verified Access policy document.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to assign to the Verified Access group.
    description: The tags to assign to the Verified Access group.
  - 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.

UPDATE examples

modify_verified_access_group

Modifies the specified Amazon Web Services Verified Access group configuration.

UPDATE aws.ec2.verified_access_groups
SET 
-- No updatable properties
WHERE 
VerifiedAccessGroupId = '{{ VerifiedAccessGroupId }}' --required
AND region = '{{ region }}' --required
AND VerifiedAccessInstanceId = '{{ VerifiedAccessInstanceId}}'
AND Description = '{{ Description}}'
AND ClientToken = '{{ ClientToken}}'
AND DryRun = {{ DryRun}}
RETURNING
creation_time,
deletion_time,
description,
last_updated_time,
owner,
sse_specification,
tags,
verified_access_group_arn,
verified_access_group_id,
verified_access_instance_id;

DELETE examples

delete_verified_access_group

Delete an Amazon Web Services Verified Access group.

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