environments

Creates, updates, deletes or gets an environment resource or lists environments in a region

Overview

Name	environments
Type	Resource
Description	An environment created within the EVS service
Id	awscc.evs.environments

Fields

Name	Datatype	Description
environment_name	string	The name of an EVS environment
kms_key_id	string
vpc_id	string
service_access_subnet_id	string
vcf_version	string
terms_accepted	boolean
▶license_info	object	The license information for an EVS environment
▶initial_vlans	object	The initial Vlan configuration only required upon creation. Modification after creation will have no effect
▶hosts	array	The initial hosts for environment only required upon creation. Modification after creation will have no effect
▶connectivity_info	object
▶vcf_hostnames	object
site_id	string
environment_id	string
environment_arn	string
environment_state	string
state_details	string
▶checks	array
▶credentials	array
▶service_access_security_groups	object
▶tags	array	An array of key-value pairs to apply to this resource.
created_at	string
region	string	AWS region.

For more information, see AWS::EVS::Environment.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	VpcId, ServiceAccessSubnetId, VcfVersion, TermsAccepted, LicenseInfo, ConnectivityInfo, VcfHostnames, SiteId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual environment.

SELECT
region,
environment_name,
kms_key_id,
vpc_id,
service_access_subnet_id,
vcf_version,
terms_accepted,
license_info,
initial_vlans,
hosts,
connectivity_info,
vcf_hostnames,
site_id,
environment_id,
environment_arn,
environment_state,
state_details,
checks,
credentials,
service_access_security_groups,
tags,
created_at,
modified_at
FROM awscc.evs.environments
WHERE region = 'us-east-1' AND data__Identifier = '<EnvironmentId>';

INSERT example

Use the following StackQL query and manifest file to create a new environment resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.evs.environments (
 VpcId,
 ServiceAccessSubnetId,
 VcfVersion,
 TermsAccepted,
 LicenseInfo,
 ConnectivityInfo,
 VcfHostnames,
 SiteId,
 region
)
SELECT 
'{{ VpcId }}',
 '{{ ServiceAccessSubnetId }}',
 '{{ VcfVersion }}',
 '{{ TermsAccepted }}',
 '{{ LicenseInfo }}',
 '{{ ConnectivityInfo }}',
 '{{ VcfHostnames }}',
 '{{ SiteId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.evs.environments (
 EnvironmentName,
 KmsKeyId,
 VpcId,
 ServiceAccessSubnetId,
 VcfVersion,
 TermsAccepted,
 LicenseInfo,
 InitialVlans,
 Hosts,
 ConnectivityInfo,
 VcfHostnames,
 SiteId,
 ServiceAccessSecurityGroups,
 Tags,
 region
)
SELECT 
 '{{ EnvironmentName }}',
 '{{ KmsKeyId }}',
 '{{ VpcId }}',
 '{{ ServiceAccessSubnetId }}',
 '{{ VcfVersion }}',
 '{{ TermsAccepted }}',
 '{{ LicenseInfo }}',
 '{{ InitialVlans }}',
 '{{ Hosts }}',
 '{{ ConnectivityInfo }}',
 '{{ VcfHostnames }}',
 '{{ SiteId }}',
 '{{ ServiceAccessSecurityGroups }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: environment
    props:
      - name: EnvironmentName
        value: '{{ EnvironmentName }}'
      - name: KmsKeyId
        value: '{{ KmsKeyId }}'
      - name: VpcId
        value: '{{ VpcId }}'
      - name: ServiceAccessSubnetId
        value: '{{ ServiceAccessSubnetId }}'
      - name: VcfVersion
        value: '{{ VcfVersion }}'
      - name: TermsAccepted
        value: '{{ TermsAccepted }}'
      - name: LicenseInfo
        value:
          SolutionKey: '{{ SolutionKey }}'
          VsanKey: '{{ VsanKey }}'
      - name: InitialVlans
        value:
          VmkManagement:
            Cidr: '{{ Cidr }}'
          VmManagement: null
          VMotion: null
          VSan: null
          VTep: null
          EdgeVTep: null
          NsxUpLink: null
          Hcx: null
          ExpansionVlan1: null
          ExpansionVlan2: null
      - name: Hosts
        value:
          - HostName: '{{ HostName }}'
            KeyName: '{{ KeyName }}'
            InstanceType: '{{ InstanceType }}'
            PlacementGroupId: '{{ PlacementGroupId }}'
            DedicatedHostId: '{{ DedicatedHostId }}'
      - name: ConnectivityInfo
        value:
          PrivateRouteServerPeerings:
            - '{{ PrivateRouteServerPeerings[0] }}'
      - name: VcfHostnames
        value:
          VCenter: null
          Nsx: null
          NsxManager1: null
          NsxManager2: null
          NsxManager3: null
          NsxEdge1: null
          NsxEdge2: null
          SddcManager: null
          CloudBuilder: null
      - name: SiteId
        value: '{{ SiteId }}'
      - name: ServiceAccessSecurityGroups
        value:
          SecurityGroups:
            - '{{ SecurityGroups[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.evs.environments
WHERE data__Identifier = '<EnvironmentId>'
AND region = 'us-east-1';

Permissions

To operate on the environments resource, the following permissions are required:

Create

evs:CreateEnvironment,
evs:GetEnvironment,
evs:TagResource,
evs:ListTagsForResource,
iam:CreateServiceLinkedRole,
support:DescribeServices,
support:DescribeSupportLevel,
servicequotas:GetServiceQuota,
servicequotas:ListServiceQuotas,
ec2:CreateNetworkInterface,
ec2:AllocateHosts,
ec2:ModifyNetworkInterfaceAttribute,
ec2:DeleteNetworkInterface,
ec2:RunInstances,
ec2:CreatePlacementGroup,
ec2:CreateSubnet,
ec2:CreateTags,
secretsmanager:GetRandomPassword,
secretsmanager:CreateSecret,
secretsmanager:GetSecretValue,
secretsmanager:BatchGetSecretValue,
secretsmanager:TagResource,
kms:ListKeysForService,
kms:DescribeKey,
secretsmanager:UpdateSecret,
ec2:DeleteVolume,
ec2:DetachVolume

Read

evs:GetEnvironment,
evs:ListTagsForResource

Update

evs:TagResource,
evs:UntagResource,
evs:ListTagsForResource,
evs:GetEnvironment

Delete

evs:DeleteEnvironment,
evs:GetEnvironment,
evs:UntagResource,
ec2:TerminateInstances,
ec2:ReleaseHosts,
ec2:DescribeHosts,
ec2:DeleteSubnet,
ec2:DetachNetworkInterface,
ec2:DeletePlacementGroup,
secretsmanager:DeleteSecret

List

evs:ListEnvironments