verified_access_groups

Creates, updates, deletes or gets a verified_access_group resource or lists verified_access_groups in a region

Overview

Name	verified_access_groups
Type	Resource
Description	The AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group.
Id	awscc.ec2.verified_access_groups

Fields

get (all properties)

Name	Datatype	Description
verified_access_group_id	string	The ID of the AWS Verified Access group.
verified_access_instance_id	string	The ID of the AWS Verified Access instance.
verified_access_group_arn	string	The ARN of the Verified Access group.
owner	string	The AWS account number that owns the group.
creation_time	string	Time this Verified Access Group was created.
last_updated_time	string	Time this Verified Access Group was last updated.
description	string	A description for the AWS Verified Access group.
policy_document	string	The AWS Verified Access policy document.
policy_enabled	boolean	The status of the Verified Access policy.
▶tags	array	An array of key-value pairs to apply to this resource.
▶sse_specification	object	The configuration options for customer provided KMS encryption.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
verified_access_group_id	string	The ID of the AWS Verified Access group.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	verified_access_groups	INSERT	VerifiedAccessInstanceId, region
delete_resource	verified_access_groups	DELETE	Identifier, region
update_resource	verified_access_groups	UPDATE	Identifier, PatchDocument, region
list_resources	verified_access_groups_list_only	SELECT	region
get_resource	verified_access_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual verified_access_group.

SELECT
  region,
  verified_access_group_id,
  verified_access_instance_id,
  verified_access_group_arn,
  owner,
  creation_time,
  last_updated_time,
  description,
  policy_document,
  policy_enabled,
  tags,
  sse_specification
FROM awscc.ec2.verified_access_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ verified_access_group_id }}';

list (identifiers only)

Lists all verified_access_groups in a region.

SELECT
  region,
  verified_access_group_id
FROM awscc.ec2.verified_access_groups_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.verified_access_groups (
  VerifiedAccessInstanceId,
  region
)
SELECT
  '{{ verified_access_instance_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.verified_access_groups (
  VerifiedAccessInstanceId,
  Description,
  PolicyDocument,
  PolicyEnabled,
  Tags,
  SseSpecification,
  region
)
SELECT
  '{{ verified_access_instance_id }}',
  '{{ description }}',
  '{{ policy_document }}',
  '{{ policy_enabled }}',
  '{{ tags }}',
  '{{ sse_specification }}',
  '{{ 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_group
  props:
    - name: verified_access_instance_id
      value: '{{ verified_access_instance_id }}'
    - name: description
      value: '{{ description }}'
    - name: policy_document
      value: '{{ policy_document }}'
    - name: policy_enabled
      value: '{{ policy_enabled }}'
    - 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 }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.verified_access_groups
SET PatchDocument = string('{{ {
    "VerifiedAccessInstanceId": verified_access_instance_id,
    "Description": description,
    "PolicyDocument": policy_document,
    "PolicyEnabled": policy_enabled,
    "Tags": tags,
    "SseSpecification": sse_specification
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ verified_access_group_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

ec2:CreateVerifiedAccessGroup,
ec2:DescribeVerifiedAccessGroups,
ec2:GetVerifiedAccessGroupPolicy,
ec2:CreateTags,
ec2:DescribeTags,
kms:DescribeKey,
kms:RetireGrant,
kms:CreateGrant,
kms:GenerateDataKey,
kms:Decrypt

Read

ec2:DescribeVerifiedAccessGroups,
ec2:GetVerifiedAccessGroupPolicy,
ec2:DescribeTags,
kms:DescribeKey,
kms:RetireGrant,
kms:CreateGrant,
kms:GenerateDataKey,
kms:Decrypt

Update

ec2:ModifyVerifiedAccessGroup,
ec2:ModifyVerifiedAccessGroupPolicy,
ec2:DescribeVerifiedAccessGroups,
ec2:GetVerifiedAccessGroupPolicy,
ec2:DescribeTags,
ec2:DeleteTags,
ec2:CreateTags,
kms:DescribeKey,
kms:RetireGrant,
kms:CreateGrant,
kms:GenerateDataKey,
kms:Decrypt

Delete

ec2:DeleteVerifiedAccessGroup,
ec2:DeleteTags,
ec2:DescribeVerifiedAccessGroups,
ec2:DescribeTags,
kms:DescribeKey,
kms:RetireGrant,
kms:CreateGrant,
kms:GenerateDataKey,
kms:Decrypt

List

ec2:DescribeVerifiedAccessGroups,
ec2:DescribeTags,
kms:DescribeKey,
kms:RetireGrant,
kms:CreateGrant,
kms:GenerateDataKey,
kms:Decrypt