verified_access_instances

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

Overview

Name	verified_access_instances
Type	Resource
Id	aws.ec2.verified_access_instances

Fields

The following fields are returned by SELECT queries:

describe_verified_access_instances

Name	Datatype	Description
cidr_endpoints_custom_sub_domain	string	The custom subdomain.
creation_time	string	The creation time.
description	string	A description for the Amazon Web Services Verified Access instance.
fips_enabled	boolean	Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance.
last_updated_time	string	The last updated time.
tags	string	The tags.
verified_access_instance_id	string	The ID of the Amazon Web Services Verified Access instance.
verified_access_trust_providers	string	The IDs of the Amazon Web Services Verified Access trust providers.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_verified_access_instances	select	region	VerifiedAccessInstanceId, MaxResults, NextToken, Filter, DryRun	Describes the specified Amazon Web Services Verified Access instances.
create_verified_access_instance	insert	region	Description, TagSpecification, ClientToken, DryRun, FIPSEnabled, CidrEndpointsCustomSubDomain	An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.
modify_verified_access_instance	update	VerifiedAccessInstanceId, region	Description, DryRun, ClientToken, CidrEndpointsCustomSubDomain	Modifies the configuration of the specified Amazon Web Services Verified Access instance.
delete_verified_access_instance	delete	VerifiedAccessInstanceId, region	DryRun, ClientToken	Delete an Amazon Web Services Verified Access instance.
export_verified_access_instance_client_configuration	exec	VerifiedAccessInstanceId, region	DryRun	Exports the client configuration for a Verified Access instance.

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
VerifiedAccessInstanceId	string	The ID of the Verified Access instance.
region	string	AWS region (default: us-east-1)
CidrEndpointsCustomSubDomain	string	The custom subdomain.
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 instance.
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.
FIPSEnabled	boolean	Enable or disable support for Federal Information Processing Standards (FIPS) on the instance.
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.
TagSpecification	array	The tags to assign to the Verified Access instance.
VerifiedAccessInstanceId	array	The IDs of the Verified Access instances.

SELECT examples

describe_verified_access_instances

Describes the specified Amazon Web Services Verified Access instances.

SELECT
cidr_endpoints_custom_sub_domain,
creation_time,
description,
fips_enabled,
last_updated_time,
tags,
verified_access_instance_id,
verified_access_trust_providers
FROM aws.ec2.verified_access_instances
WHERE region = '{{ region }}' -- required
AND VerifiedAccessInstanceId = '{{ VerifiedAccessInstanceId }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND Filter = '{{ Filter }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_verified_access_instance

An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.

INSERT INTO aws.ec2.verified_access_instances (
region,
Description,
TagSpecification,
ClientToken,
DryRun,
FIPSEnabled,
CidrEndpointsCustomSubDomain
)
SELECT 
'{{ region }}',
'{{ Description }}',
'{{ TagSpecification }}',
'{{ ClientToken }}',
'{{ DryRun }}',
'{{ FIPSEnabled }}',
'{{ CidrEndpointsCustomSubDomain }}'
RETURNING
cidr_endpoints_custom_sub_domain,
creation_time,
description,
fips_enabled,
last_updated_time,
tags,
verified_access_instance_id,
verified_access_trust_providers
;

Manifest

# Description fields are for documentation purposes
- name: verified_access_instances
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the verified_access_instances resource.
  - name: Description
    value: "{{ Description }}"
    description: A description for the Verified Access instance.
    description: A description for the Verified Access instance.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to assign to the Verified Access instance.
    description: The tags to assign to the Verified Access instance.
  - 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: FIPSEnabled
    value: {{ FIPSEnabled }}
    description: Enable or disable support for Federal Information Processing Standards (FIPS) on the instance.
    description: Enable or disable support for Federal Information Processing Standards (FIPS) on the instance.
  - name: CidrEndpointsCustomSubDomain
    value: "{{ CidrEndpointsCustomSubDomain }}"
    description: The custom subdomain.
    description: The custom subdomain.

UPDATE examples

modify_verified_access_instance

Modifies the configuration of the specified Amazon Web Services Verified Access instance.

UPDATE aws.ec2.verified_access_instances
SET 
-- No updatable properties
WHERE 
VerifiedAccessInstanceId = '{{ VerifiedAccessInstanceId }}' --required
AND region = '{{ region }}' --required
AND Description = '{{ Description}}'
AND DryRun = {{ DryRun}}
AND ClientToken = '{{ ClientToken}}'
AND CidrEndpointsCustomSubDomain = '{{ CidrEndpointsCustomSubDomain}}'
RETURNING
cidr_endpoints_custom_sub_domain,
creation_time,
description,
fips_enabled,
last_updated_time,
tags,
verified_access_instance_id,
verified_access_trust_providers;

DELETE examples

delete_verified_access_instance

Delete an Amazon Web Services Verified Access instance.

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

Lifecycle Methods

export_verified_access_instance_client_configuration

Exports the client configuration for a Verified Access instance.

EXEC aws.ec2.verified_access_instances.export_verified_access_instance_client_configuration 
@VerifiedAccessInstanceId='{{ VerifiedAccessInstanceId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;