verified_access_instances

Creates, updates, deletes or gets a verified_access_instance resource or lists verified_access_instances in a region

Overview

Name	verified_access_instances
Type	Resource
Description	The AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance.
Id	aws.ec2.verified_access_instances

Fields

Name	Datatype	Description
verified_access_instance_id	string	The ID of the AWS Verified Access instance.
verified_access_trust_providers	array	AWS Verified Access trust providers.
verified_access_trust_provider_ids	array	The IDs of the AWS Verified Access trust providers.
creation_time	string	Time this Verified Access Instance was created.
last_updated_time	string	Time this Verified Access Instance was last updated.
description	string	A description for the AWS Verified Access instance.
logging_configurations	object	The configuration options for AWS Verified Access instances.
tags	array	An array of key-value pairs to apply to this resource.
fips_enabled	boolean	Indicates whether FIPS is enabled
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all verified_access_instances in a region.

SELECT
region,
verified_access_instance_id,
verified_access_trust_providers,
verified_access_trust_provider_ids,
creation_time,
last_updated_time,
description,
logging_configurations,
tags,
fips_enabled
FROM aws.ec2.verified_access_instances
WHERE region = 'us-east-1';

Gets all properties from an individual verified_access_instance.

SELECT
region,
verified_access_instance_id,
verified_access_trust_providers,
verified_access_trust_provider_ids,
creation_time,
last_updated_time,
description,
logging_configurations,
tags,
fips_enabled
FROM aws.ec2.verified_access_instances
WHERE region = 'us-east-1' AND data__Identifier = '<VerifiedAccessInstanceId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ec2.verified_access_instances (
 VerifiedAccessTrustProviders,
 VerifiedAccessTrustProviderIds,
 Description,
 LoggingConfigurations,
 Tags,
 FipsEnabled,
 region
)
SELECT 
'{{ VerifiedAccessTrustProviders }}',
 '{{ VerifiedAccessTrustProviderIds }}',
 '{{ Description }}',
 '{{ LoggingConfigurations }}',
 '{{ Tags }}',
 '{{ FipsEnabled }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.verified_access_instances (
 VerifiedAccessTrustProviders,
 VerifiedAccessTrustProviderIds,
 Description,
 LoggingConfigurations,
 Tags,
 FipsEnabled,
 region
)
SELECT 
 '{{ VerifiedAccessTrustProviders }}',
 '{{ VerifiedAccessTrustProviderIds }}',
 '{{ Description }}',
 '{{ LoggingConfigurations }}',
 '{{ Tags }}',
 '{{ FipsEnabled }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: verified_access_instance
    props:
      - name: VerifiedAccessTrustProviders
        value:
          - TrustProviderType: '{{ TrustProviderType }}'
            DeviceTrustProviderType: '{{ DeviceTrustProviderType }}'
            UserTrustProviderType: '{{ UserTrustProviderType }}'
            OidcOptions:
              Issuer: '{{ Issuer }}'
              AuthorizationEndpoint: '{{ AuthorizationEndpoint }}'
              TokenEndpoint: '{{ TokenEndpoint }}'
              UserInfoEndpoint: '{{ UserInfoEndpoint }}'
              ClientId: '{{ ClientId }}'
              ClientSecret: '{{ ClientSecret }}'
              Scope: '{{ Scope }}'
            DeviceOptions:
              TenantId: '{{ TenantId }}'
              PublicSigningKeyUrl: '{{ PublicSigningKeyUrl }}'
            PolicyReferenceName: '{{ PolicyReferenceName }}'
            Description: '{{ Description }}'
            Tags:
              - Key: '{{ Key }}'
                Value: '{{ Value }}'
            SseSpecification:
              KmsKeyArn: '{{ KmsKeyArn }}'
              CustomerManagedKeyEnabled: '{{ CustomerManagedKeyEnabled }}'
      - name: VerifiedAccessTrustProviderIds
        value:
          - '{{ VerifiedAccessTrustProviderIds[0] }}'
      - name: Description
        value: '{{ Description }}'
      - name: LoggingConfigurations
        value:
          LogVersion: '{{ LogVersion }}'
          IncludeTrustContext: '{{ IncludeTrustContext }}'
          CloudWatchLogs:
            Enabled: '{{ Enabled }}'
            LogGroup: '{{ LogGroup }}'
          KinesisDataFirehose:
            Enabled: '{{ Enabled }}'
            DeliveryStream: '{{ DeliveryStream }}'
          S3:
            Enabled: '{{ Enabled }}'
            BucketName: '{{ BucketName }}'
            BucketOwner: '{{ BucketOwner }}'
            Prefix: '{{ Prefix }}'
      - name: Tags
        value:
          - null
      - name: FipsEnabled
        value: '{{ FipsEnabled }}'

DELETE example

/*+ delete */
DELETE FROM aws.ec2.verified_access_instances
WHERE data__Identifier = '<VerifiedAccessInstanceId>'
AND region = 'us-east-1';

Permissions

To operate on the verified_access_instances resource, the following permissions are required:

Create

ec2:CreateVerifiedAccessInstance,
ec2:AttachVerifiedAccessTrustProvider,
ec2:ModifyVerifiedAccessInstanceLoggingConfiguration,
ec2:DescribeVerifiedAccessInstances,
ec2:DescribeVerifiedAccessInstanceLoggingConfigurations,
ec2:CreateTags,
ec2:DescribeTags,
logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:PutDestination,
logs:DeleteLogDelivery,
logs:ListLogDeliveries,
logs:PutLogEvents,
logs:DescribeLogStreams,
s3:listBuckets,
s3:PutObject,
s3:GetBucketPolicy,
s3:PutBucketPolicy,
logs:DescribeLogGroups,
logs:PutResourcePolicy,
firehose:TagDeliveryStream,
logs:DescribeResourcePolicies,
iam:CreateServiceLinkedRole,
verified-access:AllowVerifiedAccess

Read

ec2:DescribeVerifiedAccessInstances,
ec2:DescribeVerifiedAccessInstanceLoggingConfigurations,
ec2:DescribeTags,
logs:GetLogDelivery,
logs:ListLogDeliveries

Update

ec2:ModifyVerifiedAccessInstance,
ec2:ModifyVerifiedAccessInstanceLoggingConfiguration,
ec2:DescribeVerifiedAccessInstances,
ec2:DescribeVerifiedAccessInstanceLoggingConfigurations,
ec2:DescribeTags,
ec2:AttachVerifiedAccessTrustProvider,
ec2:DetachVerifiedAccessTrustProvider,
ec2:DeleteTags,
ec2:CreateTags,
ec2:DescribeTags,
logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:ListLogDeliveries,
logs:UpdateLogDelivery,
logs:DeleteLogDelivery,
logs:PutDestination,
logs:PutLogEvents,
logs:DescribeLogStreams,
s3:listBuckets,
s3:PutObject,
s3:GetBucketPolicy,
s3:PutBucketPolicy,
logs:DescribeLogGroups,
logs:PutResourcePolicy,
firehose:TagDeliveryStream,
iam:CreateServiceLinkedRole,
logs:DescribeResourcePolicies

Delete

ec2:DeleteVerifiedAccessInstance,
ec2:DeleteTags,
ec2:DescribeVerifiedAccessInstances,
ec2:DescribeVerifiedAccessInstanceLoggingConfigurations,
ec2:DetachVerifiedAccessTrustProvider,
ec2:GetVerifiedAccessGroupPolicy,
ec2:DescribeTags,
logs:ListLogDeliveries,
logs:GetLogDelivery,
logs:DeleteLogDelivery

List

ec2:DescribeVerifiedAccessInstances,
ec2:DescribeTags,
logs:ListLogDeliveries,
logs:GetLogDelivery