verified_access_group_policies
Creates, updates, deletes, gets or lists a verified_access_group_policies resource.
Overview
| Name | verified_access_group_policies |
| Type | Resource |
| Id | aws.ec2.verified_access_group_policies |
Fields
The following fields are returned by SELECT queries:
- get_verified_access_group_policy
| Name | Datatype | Description |
|---|---|---|
policy_document | string | The Verified Access policy document. |
policy_enabled | boolean | The status of the Verified Access policy. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_verified_access_group_policy | select | VerifiedAccessGroupId, region | DryRun | Shows the contents of the Verified Access policy associated with the group. |
modify_verified_access_group_policy | update | VerifiedAccessGroupId, region | PolicyEnabled, PolicyDocument, ClientToken, DryRun, SseSpecification | Modifies the specified Amazon Web Services Verified Access group policy. |
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. |
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. |
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. |
PolicyDocument | string | The Verified Access policy document. |
PolicyEnabled | boolean | The status of the Verified Access policy. |
SseSpecification | object | The options for server side encryption. |
SELECT examples
- get_verified_access_group_policy
Shows the contents of the Verified Access policy associated with the group.
SELECT
policy_document,
policy_enabled
FROM aws.ec2.verified_access_group_policies
WHERE VerifiedAccessGroupId = '{{ VerifiedAccessGroupId }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
;
UPDATE examples
- modify_verified_access_group_policy
Modifies the specified Amazon Web Services Verified Access group policy.
UPDATE aws.ec2.verified_access_group_policies
SET
-- No updatable properties
WHERE
VerifiedAccessGroupId = '{{ VerifiedAccessGroupId }}' --required
AND region = '{{ region }}' --required
AND PolicyEnabled = {{ PolicyEnabled}}
AND PolicyDocument = '{{ PolicyDocument}}'
AND ClientToken = '{{ ClientToken}}'
AND DryRun = {{ DryRun}}
AND SseSpecification = '{{ SseSpecification}}'
RETURNING
policy_document,
policy_enabled,
sse_specification;