Environment

Note

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

An object that represents an Amazon EVS environment.

checks

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

Type: Array of Check objects

Required: No

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.

Type: ConnectivityInfo object

Required: No

createdAt

The date and time that the environment was created.

Type: Timestamp

Required: No

credentials

The VCF credentials that are stored as Amazon EVS managed secrets in AWS Secrets Manager.

Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.

Type: Array of Secret objects

Required: No

environmentArn

The Amazon Resource Name (ARN) that is associated with the environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: arn:aws:evs:[a-z]{2}-[a-z]+-[0-9]:[0-9]{12}:environment/[a-zA-Z0-9_-]+

Required: No

environmentId

The unique ID for the environment.

Type: String

Pattern: (env-[a-zA-Z0-9]{10})

Required: No

environmentName

The name of the environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9_-]+

Required: No

environmentState

The state of an environment.

Type: String

Valid Values: CREATING | CREATED | DELETING | DELETED | CREATE_FAILED

Required: No

environmentStatus

Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.

Type: String

Valid Values: PASSED | FAILED | UNKNOWN

Required: No

kmsKeyId

The AWS KMS key ID that AWS 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 AWS Secrets Manager managed key aws/secretsmanager. You can also specify a customer managed key.

Type: String

Required: No

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. The VCF solution key must cover a minimum of 256 cores. The vSAN license key must provide at least 110 TiB of vSAN capacity.

Type: Array of LicenseInfo objects

Array Members: Fixed number of 1 item.

Required: No

modifiedAt

The date and time that the environment was modified.

Type: Timestamp

Required: No

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.

Type: ServiceAccessSecurityGroups object

Required: No

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.

Type: String

Length Constraints: Minimum length of 15. Maximum length of 24.

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

Required: No

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.

Type: String

Required: No

stateDetails

A detailed description of the environmentState of an environment.

Type: String

Required: No

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.

Type: Boolean

Required: No

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.

Type: VcfHostnames object

Required: No

vcfVersion

The VCF version of the environment.

Type: String

Valid Values: VCF-5.2.1

Required: No

vpcId

The VPC associated with the environment.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 21.

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

Required: No

Environment

Note

Contents

See Also