/AWS1/CL_EVSENVIRONMENT¶
An object that represents an Amazon EVS environment.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_environmentid TYPE /AWS1/EVSENVIRONMENTID /AWS1/EVSENVIRONMENTID¶
The unique ID for the environment.
iv_environmentstate TYPE /AWS1/EVSENVIRONMENTSTATE /AWS1/EVSENVIRONMENTSTATE¶
The state of an environment.
iv_statedetails TYPE /AWS1/EVSSTATEDETAILS /AWS1/EVSSTATEDETAILS¶
A detailed description of the
environmentStateof an environment.
iv_createdat TYPE /AWS1/EVSTIMESTAMP /AWS1/EVSTIMESTAMP¶
The date and time that the environment was created.
iv_modifiedat TYPE /AWS1/EVSTIMESTAMP /AWS1/EVSTIMESTAMP¶
The date and time that the environment was modified.
iv_environmentarn TYPE /AWS1/EVSARN /AWS1/EVSARN¶
The Amazon Resource Name (ARN) that is associated with the environment.
iv_environmentname TYPE /AWS1/EVSENVIRONMENTNAME /AWS1/EVSENVIRONMENTNAME¶
The name of the environment.
iv_vpcid TYPE /AWS1/EVSVPCID /AWS1/EVSVPCID¶
The VPC associated with the environment.
iv_serviceaccesssubnetid TYPE /AWS1/EVSSUBNETID /AWS1/EVSSUBNETID¶
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.
iv_vcfversion TYPE /AWS1/EVSVCFVERSION /AWS1/EVSVCFVERSION¶
The VCF version of the environment.
iv_termsaccepted TYPE /AWS1/EVSBOOLEAN /AWS1/EVSBOOLEAN¶
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. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.
it_licenseinfo TYPE /AWS1/CL_EVSLICENSEINFO=>TT_LICENSEINFOLIST TT_LICENSEINFOLIST¶
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.
iv_siteid TYPE /AWS1/EVSSTRING /AWS1/EVSSTRING¶
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.
iv_environmentstatus TYPE /AWS1/EVSCHECKRESULT /AWS1/EVSCHECKRESULT¶
Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
it_checks TYPE /AWS1/CL_EVSCHECK=>TT_CHECKSLIST TT_CHECKSLIST¶
A check on the environment to identify instance health and VMware VCF licensing issues.
io_connectivityinfo TYPE REF TO /AWS1/CL_EVSCONNECTIVITYINFO /AWS1/CL_EVSCONNECTIVITYINFO¶
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.
io_vcfhostnames TYPE REF TO /AWS1/CL_EVSVCFHOSTNAMES /AWS1/CL_EVSVCFHOSTNAMES¶
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.
iv_kmskeyid TYPE /AWS1/EVSSTRING /AWS1/EVSSTRING¶
The Amazon Web Services KMS key ID that Amazon Web Services 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 Web Services Secrets Manager managed key
aws/secretsmanager. You can also specify a customer managed key.
io_serviceaccesssecgroups TYPE REF TO /AWS1/CL_EVSSVCACCESSSECGROUPS /AWS1/CL_EVSSVCACCESSSECGROUPS¶
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.
it_credentials TYPE /AWS1/CL_EVSSECRET=>TT_SECRETLIST TT_SECRETLIST¶
The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.
Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
Queryable Attributes¶
environmentId¶
The unique ID for the environment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENVIRONMENTID() |
Getter for ENVIRONMENTID, with configurable default |
ASK_ENVIRONMENTID() |
Getter for ENVIRONMENTID w/ exceptions if field has no value |
HAS_ENVIRONMENTID() |
Determine if ENVIRONMENTID has a value |
environmentState¶
The state of an environment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENVIRONMENTSTATE() |
Getter for ENVIRONMENTSTATE, with configurable default |
ASK_ENVIRONMENTSTATE() |
Getter for ENVIRONMENTSTATE w/ exceptions if field has no va |
HAS_ENVIRONMENTSTATE() |
Determine if ENVIRONMENTSTATE has a value |
stateDetails¶
A detailed description of the
environmentStateof an environment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATEDETAILS() |
Getter for STATEDETAILS, with configurable default |
ASK_STATEDETAILS() |
Getter for STATEDETAILS w/ exceptions if field has no value |
HAS_STATEDETAILS() |
Determine if STATEDETAILS has a value |
createdAt¶
The date and time that the environment was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
modifiedAt¶
The date and time that the environment was modified.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MODIFIEDAT() |
Getter for MODIFIEDAT, with configurable default |
ASK_MODIFIEDAT() |
Getter for MODIFIEDAT w/ exceptions if field has no value |
HAS_MODIFIEDAT() |
Determine if MODIFIEDAT has a value |
environmentArn¶
The Amazon Resource Name (ARN) that is associated with the environment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENVIRONMENTARN() |
Getter for ENVIRONMENTARN, with configurable default |
ASK_ENVIRONMENTARN() |
Getter for ENVIRONMENTARN w/ exceptions if field has no valu |
HAS_ENVIRONMENTARN() |
Determine if ENVIRONMENTARN has a value |
environmentName¶
The name of the environment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENVIRONMENTNAME() |
Getter for ENVIRONMENTNAME, with configurable default |
ASK_ENVIRONMENTNAME() |
Getter for ENVIRONMENTNAME w/ exceptions if field has no val |
HAS_ENVIRONMENTNAME() |
Determine if ENVIRONMENTNAME has a value |
vpcId¶
The VPC associated with the environment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCID() |
Getter for VPCID, with configurable default |
ASK_VPCID() |
Getter for VPCID w/ exceptions if field has no value |
HAS_VPCID() |
Determine if VPCID has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEACCESSSUBNETID() |
Getter for SERVICEACCESSSUBNETID, with configurable default |
ASK_SERVICEACCESSSUBNETID() |
Getter for SERVICEACCESSSUBNETID w/ exceptions if field has |
HAS_SERVICEACCESSSUBNETID() |
Determine if SERVICEACCESSSUBNETID has a value |
vcfVersion¶
The VCF version of the environment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VCFVERSION() |
Getter for VCFVERSION, with configurable default |
ASK_VCFVERSION() |
Getter for VCFVERSION w/ exceptions if field has no value |
HAS_VCFVERSION() |
Determine if VCFVERSION has a value |
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. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TERMSACCEPTED() |
Getter for TERMSACCEPTED, with configurable default |
ASK_TERMSACCEPTED() |
Getter for TERMSACCEPTED w/ exceptions if field has no value |
HAS_TERMSACCEPTED() |
Determine if TERMSACCEPTED has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LICENSEINFO() |
Getter for LICENSEINFO, with configurable default |
ASK_LICENSEINFO() |
Getter for LICENSEINFO w/ exceptions if field has no value |
HAS_LICENSEINFO() |
Determine if LICENSEINFO has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SITEID() |
Getter for SITEID, with configurable default |
ASK_SITEID() |
Getter for SITEID w/ exceptions if field has no value |
HAS_SITEID() |
Determine if SITEID has a value |
environmentStatus¶
Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENVIRONMENTSTATUS() |
Getter for ENVIRONMENTSTATUS, with configurable default |
ASK_ENVIRONMENTSTATUS() |
Getter for ENVIRONMENTSTATUS w/ exceptions if field has no v |
HAS_ENVIRONMENTSTATUS() |
Determine if ENVIRONMENTSTATUS has a value |
checks¶
A check on the environment to identify instance health and VMware VCF licensing issues.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHECKS() |
Getter for CHECKS, with configurable default |
ASK_CHECKS() |
Getter for CHECKS w/ exceptions if field has no value |
HAS_CHECKS() |
Determine if CHECKS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONNECTIVITYINFO() |
Getter for CONNECTIVITYINFO |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VCFHOSTNAMES() |
Getter for VCFHOSTNAMES |
kmsKeyId¶
The Amazon Web Services KMS key ID that Amazon Web Services 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 Web Services Secrets Manager managed key
aws/secretsmanager. You can also specify a customer managed key.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSKEYID() |
Getter for KMSKEYID, with configurable default |
ASK_KMSKEYID() |
Getter for KMSKEYID w/ exceptions if field has no value |
HAS_KMSKEYID() |
Determine if KMSKEYID has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEACCESSSECGROUPS() |
Getter for SERVICEACCESSSECURITYGROUPS |
credentials¶
The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.
Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREDENTIALS() |
Getter for CREDENTIALS, with configurable default |
ASK_CREDENTIALS() |
Getter for CREDENTIALS w/ exceptions if field has no value |
HAS_CREDENTIALS() |
Determine if CREDENTIALS has a value |