vpn_concentrators

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

Overview

Name	vpn_concentrators
Type	Resource
Id	aws.ec2.vpn_concentrators

Fields

The following fields are returned by SELECT queries:

describe_vpn_concentrators

Name	Datatype	Description
state	string	The current state of the VPN concentrator.
tags	string	Any tags assigned to the VPN concentrator.
transit_gateway_attachment_id	string	The ID of the transit gateway attachment for the VPN concentrator.
transit_gateway_id	string	The ID of the transit gateway associated with the VPN concentrator.
type	string	The type of VPN concentrator.
vpn_concentrator_id	string	The ID of the VPN concentrator.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpn_concentrators	select	region	VpnConcentratorId, Filter, MaxResults, NextToken, DryRun	Describes one or more of your VPN concentrators.
create_vpn_concentrator	insert	region	Type, TransitGatewayId, TagSpecification, DryRun	Creates a VPN concentrator that aggregates multiple VPN connections to a transit gateway.
delete_vpn_concentrator	delete	VpnConcentratorId, region	DryRun	Deletes the specified VPN concentrator.

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
VpnConcentratorId	string	The ID of the VPN concentrator to delete.
region	string	AWS region (default: us-east-1)
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.
Filter	array	One or more filters to limit the results.
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 apply to the VPN concentrator during creation.
TransitGatewayId	string	The ID of the transit gateway to attach the VPN concentrator to.
Type	string	The type of VPN concentrator to create.
VpnConcentratorId	array	One or more VPN concentrator IDs.

SELECT examples

describe_vpn_concentrators

Describes one or more of your VPN concentrators.

SELECT
state,
tags,
transit_gateway_attachment_id,
transit_gateway_id,
type,
vpn_concentrator_id
FROM aws.ec2.vpn_concentrators
WHERE region = '{{ region }}' -- required
AND VpnConcentratorId = '{{ VpnConcentratorId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_vpn_concentrator

Creates a VPN concentrator that aggregates multiple VPN connections to a transit gateway.

INSERT INTO aws.ec2.vpn_concentrators (
region,
Type,
TransitGatewayId,
TagSpecification,
DryRun
)
SELECT 
'{{ region }}',
'{{ Type }}',
'{{ TransitGatewayId }}',
'{{ TagSpecification }}',
'{{ DryRun }}'
RETURNING
state,
tags,
transit_gateway_attachment_id,
transit_gateway_id,
type,
vpn_concentrator_id
;

Manifest

# Description fields are for documentation purposes
- name: vpn_concentrators
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpn_concentrators resource.
  - name: Type
    value: "{{ Type }}"
    description: The type of VPN concentrator to create.
    description: The type of VPN concentrator to create.
  - name: TransitGatewayId
    value: "{{ TransitGatewayId }}"
    description: The ID of the transit gateway to attach the VPN concentrator to.
    description: The ID of the transit gateway to attach the VPN concentrator to.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to the VPN concentrator during creation.
    description: The tags to apply to the VPN concentrator during creation.
  - 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.

DELETE examples

delete_vpn_concentrator

Deletes the specified VPN concentrator.

DELETE FROM aws.ec2.vpn_concentrators
WHERE VpnConcentratorId = '{{ VpnConcentratorId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;