Skip to content

Environment

Source code in docs_src/capo_evs/types/environment.py
class Environment(TypedDict, closed=True):
    environment_id: NotRequired["capo_evs.types.environment_id.EnvironmentId"]
    """<p>The unique ID for the environment.</p>"""
    environment_state: NotRequired["capo_evs.types.environment_state.EnvironmentState"]
    """<p>The state of an environment.</p>"""
    state_details: NotRequired["capo_evs.types.state_details.StateDetails"]
    """<p>A detailed description of the <code>environmentState</code> of an environment.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time that the environment was created.</p>"""
    modified_at: NotRequired["datetime.datetime"]
    """<p> The date and time that the environment was modified.</p>"""
    environment_arn: NotRequired["capo_evs.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) that is associated with the environment.</p>"""
    environment_name: NotRequired["capo_evs.types.environment_name.EnvironmentName"]
    """<p>The name of the environment.</p>"""
    vpc_id: NotRequired["capo_evs.types.vpc_id.VpcId"]
    """<p>The VPC associated with the environment.</p>"""
    service_access_subnet_id: NotRequired["capo_evs.types.subnet_id.SubnetId"]
    """<p> 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.</p>"""
    vcf_version: NotRequired["capo_evs.types.vcf_version.VcfVersion"]
    """<p>The VCF version of the environment.</p>"""
    terms_accepted: NotRequired["bool"]
    """<p>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. </p>"""
    license_info: NotRequired["capo_evs.types.license_info_list.LicenseInfoList"]
    """<p> 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 meet minimum core requirements, and the vSAN license key must meet minimum capacity requirements for your selected instance type.</p> <p>For information about minimum license requirements, see <a href="https://docs.aws.amazon.com/evs/latest/userguide/vcf-license-mgmt.html">the VCF subscriptions section</a> in the <i>Amazon EVS User Guide</i>.</p>"""
    site_id: NotRequired["str"]
    """<p>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.</p>"""
    environment_status: NotRequired["capo_evs.types.check_result.CheckResult"]
    """<p>Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.</p>"""
    checks: NotRequired["capo_evs.types.checks_list.ChecksList"]
    """<p>A check on the environment to identify connector health.</p>"""
    connectivity_info: NotRequired["capo_evs.types.connectivity_info.ConnectivityInfo"]
    """<p>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.</p>"""
    vcf_hostnames: NotRequired["capo_evs.types.vcf_hostnames.VcfHostnames"]
    """<p>The DNS hostnames to be used by the VCF management appliances in your environment.</p> <p>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.</p>"""
    kms_key_id: NotRequired["str"]
    """<p>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.</p> <p>By default, Amazon EVS use the Amazon Web Services Secrets Manager managed key <code>aws/secretsmanager</code>. You can also specify a customer managed key.</p>"""
    service_access_security_groups: NotRequired[
        "capo_evs.types.service_access_security_groups.ServiceAccessSecurityGroups"
    ]
    """<p>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.</p>"""
    credentials: NotRequired["capo_evs.types.secret_list.SecretList"]
    """<p>The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.</p> <p>Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.</p>"""

checks instance-attribute

checks: NotRequired[ChecksList]

A check on the environment to identify connector health.

connectivity_info instance-attribute

connectivity_info: NotRequired[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.

created_at instance-attribute

created_at: NotRequired[datetime]

The date and time that the environment was created.

credentials instance-attribute

credentials: NotRequired[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.

environment_arn instance-attribute

environment_arn: NotRequired[Arn]

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

environment_id instance-attribute

environment_id: NotRequired[EnvironmentId]

The unique ID for the environment.

environment_name instance-attribute

environment_name: NotRequired[EnvironmentName]

The name of the environment.

environment_state instance-attribute

environment_state: NotRequired[EnvironmentState]

The state of an environment.

environment_status instance-attribute

environment_status: NotRequired[CheckResult]

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

kms_key_id instance-attribute

kms_key_id: NotRequired[str]

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.

license_info instance-attribute

license_info: NotRequired[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 meet minimum core requirements, and the vSAN license key must meet minimum capacity requirements for your selected instance type.

For information about minimum license requirements, see the VCF subscriptions section in the Amazon EVS User Guide.

modified_at instance-attribute

modified_at: NotRequired[datetime]

The date and time that the environment was modified.

service_access_security_groups instance-attribute

service_access_security_groups: NotRequired[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.

service_access_subnet_id instance-attribute

service_access_subnet_id: NotRequired[SubnetId]

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.

site_id instance-attribute

site_id: NotRequired[str]

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.

state_details instance-attribute

state_details: NotRequired[StateDetails]

A detailed description of the environmentState of an environment.

terms_accepted instance-attribute

terms_accepted: NotRequired[bool]

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.

vcf_hostnames instance-attribute

vcf_hostnames: NotRequired[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.

vcf_version instance-attribute

vcf_version: NotRequired[VcfVersion]

The VCF version of the environment.

vpc_id instance-attribute

vpc_id: NotRequired[VpcId]

The VPC associated with the environment.