Skip to main content

environment_vlans

Creates, updates, deletes, gets or lists an environment_vlans resource.

Overview

Nameenvironment_vlans
TypeResource
Idaws.evs.environment_vlans

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
availability_zonestringThe availability zone of the VLAN.
cidrstringThe CIDR block of the VLAN. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. (pattern: <code>((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[1-2][0-9]|[0-9])</code>)
created_atstring (date-time)The date and time that the VLAN was created.
eip_associationsarrayAn array of Elastic IP address associations.
function_namestringThe VMware VCF traffic type that is carried over the VLAN. For example, a VLAN with a functionName of hcx is being used to carry VMware HCX traffic.
is_publicbooleanDetermines if the VLAN that Amazon EVS provisions is public or private.
modified_atstring (date-time)The date and time that the VLAN was modified.
network_acl_idstringA unique ID for a network access control list. (pattern: <code>acl-[a-zA-Z0-9_-]+</code>)
state_detailsstringThe state details of the VLAN.
subnet_idstringThe unique ID of the VLAN subnet. (pattern: <code>subnet-[a-f0-9]{8}([a-f0-9]{9})?</code>)
vlan_idintegerThe unique ID of the VLAN.
vlan_statestringThe state of the VLAN. (CREATING, CREATED, DELETING, DELETED, CREATE_FAILED)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_environment_vlansselectregionLists environment VLANs that are associated with the specified environment.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Lists environment VLANs that are associated with the specified environment.

SELECT
availability_zone,
cidr,
created_at,
eip_associations,
function_name,
is_public,
modified_at,
network_acl_id,
state_details,
subnet_id,
vlan_id,
vlan_state
FROM aws.evs.environment_vlans
WHERE region = '{{ region }}' -- required
;