verified_access_endpoints

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

Overview

Name	verified_access_endpoints
Type	Resource
Id	aws.ec2.verified_access_endpoints

Fields

The following fields are returned by SELECT queries:

describe_verified_access_endpoints

Name	Datatype	Description
application_domain	string	The DNS name for users to reach your application.
attachment_type	string	The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the application.
cidr_options	string	The options for a CIDR endpoint.
creation_time	string	The creation time.
deletion_time	string	The deletion time.
description	string	A description for the Amazon Web Services Verified Access endpoint.
device_validation_domain	string	Returned if endpoint has a device trust provider attached.
domain_certificate_arn	string	The ARN of a public TLS/SSL certificate imported into or created with ACM.
endpoint_domain	string	A DNS name that is generated for the endpoint.
endpoint_type	string	The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
last_updated_time	string	The last updated time.
load_balancer_options	string	The load balancer details if creating the Amazon Web Services Verified Access endpoint as load-balancertype.
network_interface_options	string	The options for network-interface type endpoint.
rds_options	string	The options for an RDS endpoint.
security_group_ids	string	The IDs of the security groups for the endpoint.
sse_specification	string	The options in use for server side encryption.
status	string	The endpoint status.
tags	string	The tags.
verified_access_endpoint_id	string	The ID of the Amazon Web Services Verified Access endpoint.
verified_access_group_id	string	The ID of the Amazon Web Services Verified Access group.
verified_access_instance_id	string	The ID of the Amazon Web Services Verified Access instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_verified_access_endpoints	select	region	VerifiedAccessEndpointId, VerifiedAccessInstanceId, VerifiedAccessGroupId, MaxResults, NextToken, Filter, DryRun	Describes the specified Amazon Web Services Verified Access endpoints.
create_verified_access_endpoint	insert	VerifiedAccessGroupId, EndpointType, AttachmentType, region	DomainCertificateArn, ApplicationDomain, EndpointDomainPrefix, SecurityGroupId, LoadBalancerOptions, NetworkInterfaceOptions, Description, PolicyDocument, TagSpecification, ClientToken, DryRun, SseSpecification, RdsOptions, CidrOptions	An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.
modify_verified_access_endpoint	update	VerifiedAccessEndpointId, region	VerifiedAccessGroupId, LoadBalancerOptions, NetworkInterfaceOptions, Description, ClientToken, DryRun, RdsOptions, CidrOptions	Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.
delete_verified_access_endpoint	delete	VerifiedAccessEndpointId, region	ClientToken, DryRun	Delete an Amazon Web Services Verified Access endpoint.

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
AttachmentType	string	The type of attachment.
EndpointType	string	The type of Verified Access endpoint to create.
VerifiedAccessEndpointId	string	The ID of the Verified Access endpoint.
VerifiedAccessGroupId	string	The ID of the Verified Access group to associate the endpoint with.
region	string	AWS region (default: us-east-1)
ApplicationDomain	string	The DNS name for users to reach your application.
CidrOptions	object	The CIDR options.
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 endpoint.
DomainCertificateArn	string	The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.
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.
EndpointDomainPrefix	string	A custom identifier that is prepended to the DNS name that is generated for the endpoint.
Filter	array	One or more filters. Filter names and values are case-sensitive.
LoadBalancerOptions	object	The load balancer details if creating the Verified Access endpoint as load-balancertype.
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.
NetworkInterfaceOptions	object	The network interface options.
NextToken	string	The token for the next page of results.
PolicyDocument	string	The Verified Access policy document.
RdsOptions	object	The RDS options.
SecurityGroupId	array	The IDs of the security groups to associate with the Verified Access endpoint. Required if AttachmentType is set to vpc.
SseSpecification	object	The options for server side encryption.
TagSpecification	array	The tags to assign to the Verified Access endpoint.
VerifiedAccessEndpointId	array	The ID of the Verified Access endpoint.
VerifiedAccessGroupId	string	The ID of the Verified Access group.
VerifiedAccessInstanceId	string	The ID of the Verified Access instance.

SELECT examples

describe_verified_access_endpoints

Describes the specified Amazon Web Services Verified Access endpoints.

SELECT
application_domain,
attachment_type,
cidr_options,
creation_time,
deletion_time,
description,
device_validation_domain,
domain_certificate_arn,
endpoint_domain,
endpoint_type,
last_updated_time,
load_balancer_options,
network_interface_options,
rds_options,
security_group_ids,
sse_specification,
status,
tags,
verified_access_endpoint_id,
verified_access_group_id,
verified_access_instance_id
FROM aws.ec2.verified_access_endpoints
WHERE region = '{{ region }}' -- required
AND VerifiedAccessEndpointId = '{{ VerifiedAccessEndpointId }}'
AND VerifiedAccessInstanceId = '{{ VerifiedAccessInstanceId }}'
AND VerifiedAccessGroupId = '{{ VerifiedAccessGroupId }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND Filter = '{{ Filter }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_verified_access_endpoint

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

INSERT INTO aws.ec2.verified_access_endpoints (
VerifiedAccessGroupId,
EndpointType,
AttachmentType,
region,
DomainCertificateArn,
ApplicationDomain,
EndpointDomainPrefix,
SecurityGroupId,
LoadBalancerOptions,
NetworkInterfaceOptions,
Description,
PolicyDocument,
TagSpecification,
ClientToken,
DryRun,
SseSpecification,
RdsOptions,
CidrOptions
)
SELECT 
'{{ VerifiedAccessGroupId }}',
'{{ EndpointType }}',
'{{ AttachmentType }}',
'{{ region }}',
'{{ DomainCertificateArn }}',
'{{ ApplicationDomain }}',
'{{ EndpointDomainPrefix }}',
'{{ SecurityGroupId }}',
'{{ LoadBalancerOptions }}',
'{{ NetworkInterfaceOptions }}',
'{{ Description }}',
'{{ PolicyDocument }}',
'{{ TagSpecification }}',
'{{ ClientToken }}',
'{{ DryRun }}',
'{{ SseSpecification }}',
'{{ RdsOptions }}',
'{{ CidrOptions }}'
RETURNING
application_domain,
attachment_type,
cidr_options,
creation_time,
deletion_time,
description,
device_validation_domain,
domain_certificate_arn,
endpoint_domain,
endpoint_type,
last_updated_time,
load_balancer_options,
network_interface_options,
rds_options,
security_group_ids,
sse_specification,
status,
tags,
verified_access_endpoint_id,
verified_access_group_id,
verified_access_instance_id
;

Manifest

# Description fields are for documentation purposes
- name: verified_access_endpoints
props:
  - name: VerifiedAccessGroupId
    value: "{{ VerifiedAccessGroupId }}"
    description: Required parameter for the verified_access_endpoints resource.
  - name: EndpointType
    value: "{{ EndpointType }}"
    description: Required parameter for the verified_access_endpoints resource.
  - name: AttachmentType
    value: "{{ AttachmentType }}"
    description: Required parameter for the verified_access_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the verified_access_endpoints resource.
  - name: DomainCertificateArn
    value: "{{ DomainCertificateArn }}"
    description: The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.
    description: The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.
  - name: ApplicationDomain
    value: "{{ ApplicationDomain }}"
    description: The DNS name for users to reach your application.
    description: The DNS name for users to reach your application.
  - name: EndpointDomainPrefix
    value: "{{ EndpointDomainPrefix }}"
    description: A custom identifier that is prepended to the DNS name that is generated for the endpoint.
    description: A custom identifier that is prepended to the DNS name that is generated for the endpoint.
  - name: SecurityGroupId
    value: "{{ SecurityGroupId }}"
    description: The IDs of the security groups to associate with the Verified Access endpoint. Required if AttachmentType is set to vpc.
    description: The IDs of the security groups to associate with the Verified Access endpoint. Required if AttachmentType is set to vpc.
  - name: LoadBalancerOptions
    value: "{{ LoadBalancerOptions }}"
    description: The load balancer details. This parameter is required if the endpoint type is load-balancer.
    description: The load balancer details. This parameter is required if the endpoint type is load-balancer.
  - name: NetworkInterfaceOptions
    value: "{{ NetworkInterfaceOptions }}"
    description: The network interface details. This parameter is required if the endpoint type is network-interface.
    description: The network interface details. This parameter is required if the endpoint type is network-interface.
  - name: Description
    value: "{{ Description }}"
    description: A description for the Verified Access endpoint.
    description: A description for the Verified Access endpoint.
  - name: PolicyDocument
    value: "{{ PolicyDocument }}"
    description: The Verified Access policy document.
    description: The Verified Access policy document.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to assign to the Verified Access endpoint.
    description: The tags to assign to the Verified Access endpoint.
  - 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: SseSpecification
    value: "{{ SseSpecification }}"
    description: The options for server side encryption.
    description: The options for server side encryption.
  - name: RdsOptions
    value: "{{ RdsOptions }}"
    description: The RDS details. This parameter is required if the endpoint type is rds.
    description: The RDS details. This parameter is required if the endpoint type is rds.
  - name: CidrOptions
    value: "{{ CidrOptions }}"
    description: The CIDR options. This parameter is required if the endpoint type is cidr.
    description: The CIDR options. This parameter is required if the endpoint type is cidr.

UPDATE examples

modify_verified_access_endpoint

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

UPDATE aws.ec2.verified_access_endpoints
SET 
-- No updatable properties
WHERE 
VerifiedAccessEndpointId = '{{ VerifiedAccessEndpointId }}' --required
AND region = '{{ region }}' --required
AND VerifiedAccessGroupId = '{{ VerifiedAccessGroupId}}'
AND LoadBalancerOptions = '{{ LoadBalancerOptions}}'
AND NetworkInterfaceOptions = '{{ NetworkInterfaceOptions}}'
AND Description = '{{ Description}}'
AND ClientToken = '{{ ClientToken}}'
AND DryRun = {{ DryRun}}
AND RdsOptions = '{{ RdsOptions}}'
AND CidrOptions = '{{ CidrOptions}}'
RETURNING
application_domain,
attachment_type,
cidr_options,
creation_time,
deletion_time,
description,
device_validation_domain,
domain_certificate_arn,
endpoint_domain,
endpoint_type,
last_updated_time,
load_balancer_options,
network_interface_options,
rds_options,
security_group_ids,
sse_specification,
status,
tags,
verified_access_endpoint_id,
verified_access_group_id,
verified_access_instance_id;

DELETE examples

delete_verified_access_endpoint

Delete an Amazon Web Services Verified Access endpoint.

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