AWS::EVS::Environment - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::EVS::Environment

Note

Amazon EVS is in public preview release and is subject to change.

Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.

It can take several hours to create an environment. After the deployment completes, you can configure VCF in the vSphere user interface according to your needs.

Note

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EVS::Environment",
  "Properties" : {
      "ConnectivityInfo" : ConnectivityInfo,
      "EnvironmentName" : String,
      "Hosts" : [ HostInfoForCreate, ... ],
      "InitialVlans" : InitialVlans,
      "KmsKeyId" : String,
      "LicenseInfo" : LicenseInfo,
      "ServiceAccessSecurityGroups" : ServiceAccessSecurityGroups,
      "ServiceAccessSubnetId" : String,
      "SiteId" : String,
      "Tags" : [ Tag, ... ],
      "TermsAccepted" : Boolean,
      "VcfHostnames" : VcfHostnames,
      "VcfVersion" : String,
      "VpcId" : String
    }
}

Properties

ConnectivityInfo

The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.

Required: Yes

Type: ConnectivityInfo

Update requires: Updates are not supported.

EnvironmentName

The name of the environment.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,100}$

Update requires: Updates are not supported.

Hosts

Required for environment resource creation.

Required: Conditional

Type: Array of HostInfoForCreate

Minimum: 4

Maximum: 4

Update requires: Updates are not supported.

InitialVlans
Note

Amazon EVS is in public preview release and is subject to change.

The initial VLAN subnets for the environment. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.

Required for environment resource creation.

Required: Conditional

Type: InitialVlans

Update requires: Updates are not supported.

KmsKeyId

The Amazon KMS key ID that Amazon Secrets Manager uses to encrypt secrets that are associated with the environment. These secrets contain the VCF credentials that are needed to install vCenter Server, NSX, and SDDC Manager.

By default, Amazon EVS use the Amazon Secrets Manager managed key aws/secretsmanager. You can also specify a customer managed key.

Required: No

Type: String

Update requires: Updates are not supported.

LicenseInfo

The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.

Required: Yes

Type: LicenseInfo

Update requires: Updates are not supported.

ServiceAccessSecurityGroups

The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.

Required: No

Type: ServiceAccessSecurityGroups

Update requires: Updates are not supported.

ServiceAccessSubnetId

The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to perform validations and create the environment.

Required: Yes

Type: String

Pattern: ^subnet-[a-f0-9]{8}([a-f0-9]{9})?$

Minimum: 15

Maximum: 24

Update requires: Updates are not supported.

SiteId

The Broadcom Site ID that is associated with your Amazon EVS environment. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.

Required: Yes

Type: String

Update requires: Updates are not supported.

Tags

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon resources.

Required: No

Type: Array of Tag

Update requires: No interruption

TermsAccepted

Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance.

Required: Yes

Type: Boolean

Update requires: Updates are not supported.

VcfHostnames

The DNS hostnames to be used by the VCF management appliances in your environment.

For environment creation to be successful, each hostname entry must resolve to a domain name that you've registered in your DNS service of choice and configured in the DHCP option set of your VPC. DNS hostnames cannot be changed after environment creation has started.

Required: Yes

Type: VcfHostnames

Update requires: Updates are not supported.

VcfVersion

The VCF version of the environment.

Required: Yes

Type: String

Allowed values: VCF-5.2.1

Update requires: Updates are not supported.

VpcId

The VPC associated with the environment.

Required: Yes

Type: String

Pattern: ^vpc-[a-f0-9]{8}([a-f0-9]{9})?$

Minimum: 12

Maximum: 21

Update requires: Updates are not supported.

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon EVS EnvironmentId. For example: { "Ref": "env-1234567890" }.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Checks

A check on the environment to identify instance health and VMware VCF licensing issues. For example:


            {
                "checks": [
                    {
                        "type": "KEY_REUSE",
                        "result": "PASSED"
                    },
                    {
                        "type": "KEY_COVERAGE",
                        "result": "PASSED"
                    },
                    {
                        "type": "REACHABILITY",
                        "result": "PASSED"
                    },
                    {
                        "type": "HOST_COUNT",
                        "result": "PASSED"
                    }
                ]
            }
CreatedAt

The date and time that the environment was created. For example:1749081600.000.

Credentials

The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Secrets Manager. Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager. For example:


            {
                [
                    {
                        "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterAdmin-MnTMEi"
                    },
                    {
                        "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterRoot-87VyCF"
                    },
                    {
                        "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXRoot-SR3k43"
                    },
                    {
                        "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAdmin-L5LUiD"
                    },
                    {
                        "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAudit-Q2oW46"
                    },
                    {
                        "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerRoot-bFulOq"
                    },
                    {
                        "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerVCF-Ec3gES"
                    },
                    {
                        "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerAdmin-JMTAAb"
                    }
                ]
            }
EnvironmentArn

The Amazon Resource Name (ARN) that is associated with the environment. For example: arn:aws:evs:us-east-1:000000000000:environment/env-1234567890.

EnvironmentId

The unique ID for the environment. For example: env-1234567890.

EnvironmentState

The state of an environment. For example: CREATED.

ModifiedAt

The date and time that the environment was modified. For example:1749081600.000.

StateDetails

A detailed description of the environmentState of an environment. For example: Environment successfully created.