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	awscc.ec2.verified_access_instances

Fields

get (all properties)

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
cidr_endpoints_custom_sub_domain	string	Introduce CidrEndpointsCustomSubDomain property to represent the domain (say, ava.my-company.com)
cidr_endpoints_custom_sub_domain_name_servers	array	Property to represent the name servers assoicated with the domain that AVA manages (say, ['ns1.amazonaws.com', 'ns2.amazonaws.com', 'ns3.amazonaws.com', 'ns4.amazonaws.com']).
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
verified_access_instance_id	string	The ID of the AWS Verified Access instance.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	verified_access_instances	INSERT	region
delete_resource	verified_access_instances	DELETE	Identifier, region
update_resource	verified_access_instances	UPDATE	Identifier, PatchDocument, region
list_resources	verified_access_instances_list_only	SELECT	region
get_resource	verified_access_instances	SELECT	Identifier, region

SELECT examples

get (all properties)

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,
  cidr_endpoints_custom_sub_domain,
  cidr_endpoints_custom_sub_domain_name_servers
FROM awscc.ec2.verified_access_instances
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ verified_access_instance_id }}';

list (identifiers only)

Lists all verified_access_instances in a region.

SELECT
  region,
  verified_access_instance_id
FROM awscc.ec2.verified_access_instances_list_only
WHERE
  region = '{{ region }}';

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 awscc.ec2.verified_access_instances (
  VerifiedAccessTrustProviders,
  VerifiedAccessTrustProviderIds,
  Description,
  LoggingConfigurations,
  Tags,
  FipsEnabled,
  CidrEndpointsCustomSubDomain,
  region
)
SELECT
  '{{ verified_access_trust_providers }}',
  '{{ verified_access_trust_provider_ids }}',
  '{{ description }}',
  '{{ logging_configurations }}',
  '{{ tags }}',
  '{{ fips_enabled }}',
  '{{ cidr_endpoints_custom_sub_domain }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.verified_access_instances (
  VerifiedAccessTrustProviders,
  VerifiedAccessTrustProviderIds,
  Description,
  LoggingConfigurations,
  Tags,
  FipsEnabled,
  CidrEndpointsCustomSubDomain,
  region
)
SELECT
  '{{ verified_access_trust_providers }}',
  '{{ verified_access_trust_provider_ids }}',
  '{{ description }}',
  '{{ logging_configurations }}',
  '{{ tags }}',
  '{{ fips_enabled }}',
  '{{ cidr_endpoints_custom_sub_domain }}',
  '{{ 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_instance
  props:
    - name: verified_access_trust_providers
      value:
        - trust_provider_type: '{{ trust_provider_type }}'
          device_trust_provider_type: '{{ device_trust_provider_type }}'
          user_trust_provider_type: '{{ user_trust_provider_type }}'
          oidc_options:
            issuer: '{{ issuer }}'
            authorization_endpoint: '{{ authorization_endpoint }}'
            token_endpoint: '{{ token_endpoint }}'
            user_info_endpoint: '{{ user_info_endpoint }}'
            client_id: '{{ client_id }}'
            client_secret: '{{ client_secret }}'
            scope: '{{ scope }}'
          device_options:
            tenant_id: '{{ tenant_id }}'
            public_signing_key_url: '{{ public_signing_key_url }}'
          policy_reference_name: '{{ policy_reference_name }}'
          description: '{{ description }}'
          tags:
            - key: '{{ key }}'
              value: '{{ value }}'
          sse_specification:
            kms_key_arn: '{{ kms_key_arn }}'
            customer_managed_key_enabled: '{{ customer_managed_key_enabled }}'
          native_application_oidc_options:
            issuer: '{{ issuer }}'
            authorization_endpoint: '{{ authorization_endpoint }}'
            token_endpoint: '{{ token_endpoint }}'
            user_info_endpoint: '{{ user_info_endpoint }}'
            client_id: '{{ client_id }}'
            client_secret: '{{ client_secret }}'
            scope: '{{ scope }}'
            public_signing_key_endpoint: '{{ public_signing_key_endpoint }}'
    - name: verified_access_trust_provider_ids
      value:
        - '{{ verified_access_trust_provider_ids[0] }}'
    - name: description
      value: '{{ description }}'
    - name: logging_configurations
      value:
        log_version: '{{ log_version }}'
        include_trust_context: '{{ include_trust_context }}'
        cloud_watch_logs:
          enabled: '{{ enabled }}'
          log_group: '{{ log_group }}'
        kinesis_data_firehose:
          enabled: '{{ enabled }}'
          delivery_stream: '{{ delivery_stream }}'
        s3:
          enabled: '{{ enabled }}'
          bucket_name: '{{ bucket_name }}'
          bucket_owner: '{{ bucket_owner }}'
          prefix: '{{ prefix }}'
    - name: tags
      value:
        - null
    - name: fips_enabled
      value: '{{ fips_enabled }}'
    - name: cidr_endpoints_custom_sub_domain
      value: '{{ cidr_endpoints_custom_sub_domain }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.verified_access_instances
SET PatchDocument = string('{{ {
    "VerifiedAccessTrustProviders": verified_access_trust_providers,
    "VerifiedAccessTrustProviderIds": verified_access_trust_provider_ids,
    "Description": description,
    "LoggingConfigurations": logging_configurations,
    "Tags": tags,
    "FipsEnabled": fips_enabled,
    "CidrEndpointsCustomSubDomain": cidr_endpoints_custom_sub_domain
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ verified_access_instance_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

ec2:CreateVerifiedAccessInstance,
ec2:AttachVerifiedAccessTrustProvider,
ec2:ModifyVerifiedAccessInstanceLoggingConfiguration,
ec2:DescribeVerifiedAccessInstances,
ec2:DescribeVerifiedAccessInstanceLoggingConfigurations,
ec2:DetachVerifiedAccessTrustProvider,
ec2:DeleteVerifiedAccessInstance,
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