Smaws_Client_Evs.Typestype nonrec vm_id_list = vm_id listtype nonrec error_detail = {error_message : Smaws_Lib.Smithy_api.Types.string_;The error message.
*)error_code : Smaws_Lib.Smithy_api.Types.string_;The error code.
*)}An object that contains error details for an entitlement.
type nonrec vm_entitlement = {error_detail : error_detail option;The error details associated with the entitlement, if applicable.
*)stopped_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the entitlement stopped.
*)started_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the entitlement started.
*)last_synced_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the entitlement was last synced.
*)status : entitlement_status option;The status of the entitlement.
*)type_ : entitlement_type option;The type of entitlement.
*)vm_name : vm_name option;The name of the virtual machine.
*)connector_id : connector_id option;The unique ID of the connector associated with the entitlement.
*)environment_id : environment_id option;The unique ID of the environment.
*)vm_id : vm_id option;The unique ID of the virtual machine.
*)}An object that represents a Windows Server License entitlement for a virtual machine in an Amazon EVS environment.
type nonrec vm_entitlement_list = vm_entitlement listtype nonrec eip_association = {ip_address : ip_address option;The Elastic IP address.
*)allocation_id : allocation_id option;The Elastic IP address allocation ID.
*)association_id : association_id option;A unique ID for the elastic IP address association with the VLAN subnet.
*)}An Elastic IP address association with the elastic network interface in the VLAN subnet.
type nonrec eip_association_list = eip_association listtype nonrec vlan = {network_acl_id : network_acl_id option;A unique ID for a network access control list.
*)is_public : Smaws_Lib.Smithy_api.Types.boolean_ option;Determines if the VLAN that Amazon EVS provisions is public or private.
*)eip_associations : eip_association_list option;An array of Elastic IP address associations.
*)state_details : state_details option;The state details of the VLAN.
*)vlan_state : vlan_state option;The state of the VLAN.
*)modified_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the VLAN was modified.
*)created_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the VLAN was created.
*)subnet_id : subnet_id option;The unique ID of the VLAN subnet.
*)function_name : Smaws_Lib.Smithy_api.Types.string_ option;The VMware VCF traffic type that is carried over the VLAN. For example, a VLAN with a functionName of hcx is being used to carry VMware HCX traffic.
availability_zone : Smaws_Lib.Smithy_api.Types.string_ option;The availability zone of the VLAN.
*)cidr : cidr option;The CIDR block of the VLAN. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.
*)vlan_id : vlan_id option;The unique ID of the VLAN.
*)}The VLANs that Amazon EVS creates during environment creation.
type nonrec vlan_list = vlan listtype nonrec instance_type_list = instance_type listtype nonrec vcf_version_info = {instance_types : instance_type_list;EC2 instance types provided by Amazon EVS for this VCF version for creating environments.
*)default_esx_version : Smaws_Lib.Smithy_api.Types.string_;The default ESX version for this VCF version. It is based on Broadcom's Bill Of Materials (BOM).
*)status : Smaws_Lib.Smithy_api.Types.string_;The status for this VCF version. Valid values are:
AVAILABLE - This VCF version is available to you.RESTRICTED - This VCF version has limited availability.If the version you need shows RESTRICTED, and you require, check out VCF versions and EC2 instance types provided by Amazon EVS for more information.
*)vcf_version : vcf_version;The VCF version number.
*)}Information about a VCF versions provided by Amazon EVS, including its status, default ESX version, and EC2 instance types.
type nonrec vcf_version_list = vcf_version_info listtype nonrec vcf_hostnames = {cloud_builder : host_name;The hostname for VMware Cloud Builder.
*)sddc_manager : host_name;The hostname for SDDC Manager.
*)nsx_edge2 : host_name;The hostname for the second NSX Edge node.
*)nsx_edge1 : host_name;The hostname for the first NSX Edge node.
*)nsx_manager3 : host_name;The hostname for the third VMware NSX Manager virtual machine (VM).
*)nsx_manager2 : host_name;The hostname for the second VMware NSX Manager virtual machine (VM).
*)nsx_manager1 : host_name;The hostname for the first VMware NSX Manager virtual machine (VM).
*)nsx : host_name;The VMware NSX Virtual IP (VIP) hostname.
*)v_center : host_name;The VMware vCenter hostname.
*)}The DNS hostnames that Amazon EVS uses to install VMware vCenter Server, NSX, SDDC Manager, and Cloud Builder. Each hostname must be unique, and resolve to a domain name that you've registered in your DNS service of choice. Hostnames cannot be changed.
VMware VCF requires the deployment of two NSX Edge nodes, and three NSX Manager virtual machines.
Not supported when vcfVersion is SELF_DEPLOYED.
type nonrec validation_exception_field = {message : Smaws_Lib.Smithy_api.Types.string_;A message describing why the field failed validation.
*)name : Smaws_Lib.Smithy_api.Types.string_;The field name.
*)}Stores information about a field passed inside a request that resulted in an exception.
type nonrec validation_exception_field_list = validation_exception_field listtype nonrec validation_exception = {field_list : validation_exception_field_list option;A list of fields that didn't validate.
*)reason : validation_exception_reason;The reason for the exception.
*)message : Smaws_Lib.Smithy_api.Types.string_;Describes the error encountered.
*)}The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
type nonrec connector_check = {impaired_since : Smaws_Lib.Smithy_api.Types.timestamp option;The time when connector health began to be impaired.
*)last_check_attempt : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time of the last check attempt.
*)result_ : check_result option;The check result.
*)type_ : check_type option;The check type.
*)}A check on a connector to identify connectivity health.
type nonrec connectors_checks_list = connector_check listtype nonrec connector = {modified_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the connector was modified.
*)created_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the connector was created.
*)checks : connectors_checks_list option;A list of checks that are run on the connector.
*)status : check_result option;The status of the connector.
*)state_details : state_details option;A detailed description of the connector state.
*)state : connector_state option;The state of the connector.
*)secret_arn : secret_identifier option;The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.
*)appliance_fqdn : appliance_fqdn option;The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.
*)type_ : connector_type option;The type of the connector.
*)connector_id : connector_id option;The unique ID of the connector.
*)environment_id : environment_id option;The unique ID of the environment that the connector belongs to.
*)}An object that represents a connector for an Amazon EVS environment. A connector establishes a connection to the given appliance type using the credentials stored in Amazon Web Services Secrets Manager.
type nonrec update_environment_connector_response = {connector : connector option;A description of the updated connector.
*)}type nonrec update_environment_connector_request = {secret_identifier : secret_identifier option;The new ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.
*)appliance_fqdn : appliance_fqdn option;The new fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.
*)connector_id : connector_id;A unique ID for the connector to update.
*)environment_id : environment_id;A unique ID for the environment that the connector belongs to.
*)client_token : client_token option;This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector update request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}type nonrec throttling_exception = {retry_after_seconds : Smaws_Lib.Smithy_api.Types.integer option;The seconds to wait to retry.
*)message : Smaws_Lib.Smithy_api.Types.string_;Describes the error encountered.
*)}The operation could not be performed because the service is throttling requests. This exception is thrown when the service endpoint receives too many concurrent requests.
type nonrec resource_not_found_exception = {resource_type : Smaws_Lib.Smithy_api.Types.string_;The type of the resource that is associated with the error.
*)resource_id : Smaws_Lib.Smithy_api.Types.string_;The ID of the resource that could not be found.
*)message : Smaws_Lib.Smithy_api.Types.string_;Describes the error encountered.
*)}A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
type nonrec tag_keys = tag_key listtype nonrec tag_policy_exception = {message : Smaws_Lib.Smithy_api.Types.string_;Describes the error encountered
*)}TagPolicyException is deprecated. See ValidationException instead.
The request doesn't comply with IAM tag policy. Correct your request and then retry it.
TooManyTagsException is deprecated. See ServiceQuotaExceededException instead.
A service resource associated with the request has more than 200 tags.
type nonrec tag_resource_request = {resource_arn : arn;The Amazon Resource Name (ARN) of the resource to add tags to.
*)}type nonrec service_quota_exceeded_exception = {message : Smaws_Lib.Smithy_api.Types.string_;Describes the error encountered.
*)}The number of one or more Amazon EVS resources exceeds the maximum allowed. For a list of Amazon EVS quotas, see Amazon EVS endpoints and quotas in the Amazon EVS User Guide. Delete some resources or request an increase in your service quota. To request an increase, see Amazon Web Services Service Quotas in the Amazon Web Services General Reference Guide.
type nonrec security_groups = security_group_id listtype nonrec service_access_security_groups = {security_groups : security_groups option;The security groups that allow service access.
*)}The security groups that allow traffic between the Amazon EVS control plane and your VPC for Amazon EVS service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.
type nonrec secret = {secret_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the secret.
*)}A managed secret that contains the credentials for installing vCenter Server, NSX, and SDDC Manager. During environment creation, the Amazon EVS control plane uses Amazon Web Services Secrets Manager to create, encrypt, validate, and store secrets. If you choose to delete your environment, Amazon EVS also deletes the secrets that are associated with your environment. Amazon EVS does not provide managed rotation of secrets. We recommend that you rotate secrets regularly to ensure that secrets are not long-lived.
type nonrec secret_list = secret listtype nonrec route_server_peering_list = route_server_peering listtype nonrec network_interface = {network_interface_id : network_interface_id option;The unique ID of the elastic network interface.
*)}An elastic network interface (ENI) that connects hosts to the VLAN subnets. Amazon EVS provisions two identically configured ENIs in the VMkernel management subnet during host creation. One ENI is active, and the other is in standby mode for automatic switchover during a failure scenario.
type nonrec network_interface_list = network_interface listtype nonrec list_vm_entitlements_response = {entitlements : vm_entitlement_list option;A list of entitlements for virtual machines in the environment.
*)next_token : pagination_token option;A unique pagination token for next page results. Make the call again using this token to retrieve the next page.
*)}type nonrec list_vm_entitlements_request = {entitlement_type : entitlement_type;The type of entitlement to list.
*)connector_id : connector_id;A unique ID for the connector.
*)environment_id : environment_id;A unique ID for the environment.
*)max_results : max_results option;The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
next_token : pagination_token option;A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
}type nonrec environment_summary = {environment_arn : arn option;The Amazon Resource Name (ARN) that is associated with the environment.
*)modified_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the environment was modified.
*)created_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the environment was created.
*)environment_state : environment_state option;The state of an environment.
*)environment_status : check_result option;Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
*)vcf_version : vcf_version option;The VCF version of the environment.
*)environment_name : environment_name option;The name of the environment.
*)environment_id : environment_id option;A unique ID for the environment.
*)}A list of environments with summarized environment details.
type nonrec environment_summary_list = environment_summary listtype nonrec list_environments_response = {environment_summaries : environment_summary_list option;A list of environments with summarized environment details.
*)next_token : pagination_token option;A unique pagination token for next page results. Make the call again using this token to retrieve the next page.
*)}type nonrec environment_state_list = environment_state listtype nonrec list_environments_request = {state : environment_state_list option;The state of an environment. Used to filter response results to return only environments with the specified environmentState.
max_results : max_results option;The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
next_token : pagination_token option;A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
}type nonrec list_environment_vlans_response = {environment_vlans : vlan_list option;A list of VLANs that are associated with the specified environment.
*)next_token : pagination_token option;A unique pagination token for next page results. Make the call again using this token to retrieve the next page.
*)}type nonrec list_environment_vlans_request = {environment_id : environment_id;A unique ID for the environment.
*)max_results : max_results option;The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
next_token : pagination_token option;A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
}type nonrec host = {network_interfaces : network_interface_list option;The elastic network interfaces that are attached to the host.
*)ec2_instance_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique ID of the EC2 instance that represents the host.
*)state_details : state_details option;A detailed description of the hostState of a host.
host_state : host_state option;The state of the host.
*)modified_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the host was modified.
*)created_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the host was created.
*)dedicated_host_id : dedicated_host_id option;The unique ID of the Amazon EC2 Dedicated Host.
*)placement_group_id : placement_group_id option;The unique ID of the placement group where the host is placed.
*)instance_type : instance_type option;The EC2 instance type of the host.
EC2 instances created through Amazon EVS do not support associating an IAM instance profile.
*)key_name : key_name option;The name of the SSH key that is used to access the host.
*)ip_address : ip_address option;The IP address of the host.
*)host_name : host_name option;The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.
*)}An ESX host that runs on an Amazon EC2 bare metal instance.
type nonrec host_list = host listtype nonrec list_environment_hosts_response = {environment_hosts : host_list option;A list of hosts in the environment.
*)next_token : pagination_token option;A unique pagination token for next page results. Make the call again using this token to retrieve the next page.
*)}type nonrec list_environment_hosts_request = {environment_id : environment_id;A unique ID for the environment.
*)max_results : max_results option;The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
next_token : pagination_token option;A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
}type nonrec connector_list = connector listtype nonrec list_environment_connectors_response = {connectors : connector_list option;A list of connectors in the environment.
*)next_token : pagination_token option;A unique pagination token for next page results. Make the call again using this token to retrieve the next page.
*)}type nonrec list_environment_connectors_request = {environment_id : environment_id;A unique ID for the environment.
*)max_results : max_results option;The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
next_token : pagination_token option;A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
}type nonrec license_info = {vsan_key : v_san_license_key;The VSAN license key. This license unlocks vSAN features. The vSAN license key must meet the instance-type-specific minimum capacity requirements.
*)solution_key : solution_key;The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must meet the instance-type-specific minimum core requirements.
*)}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.
type nonrec license_info_list = license_info listtype nonrec internal_server_exception = {message : Smaws_Lib.Smithy_api.Types.string_;Describes the error encountered.
*)}An internal server error occurred. Retry your request.
type nonrec esx_version_list = Smaws_Lib.Smithy_api.Types.string_ listtype nonrec instance_type_esx_versions_info = {esx_versions : esx_version_list;The list of ESX versions offered for this instance type.
*)instance_type : instance_type;The EC2 instance type.
*)}Information about ESX versions offered for each EC2 instance type.
type nonrec instance_type_esx_versions_list =
instance_type_esx_versions_info listtype nonrec initial_vlan_info = {cidr : cidr;The CIDR block that you provide to create an Amazon EVS VLAN subnet. 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.
*)}An object that represents an initial VLAN subnet for the Amazon EVS environment. Amazon EVS creates initial VLAN subnets when you first create the environment. Amazon EVS creates the following 10 VLAN subnets: host management VLAN, vMotion VLAN, vSAN VLAN, VTEP VLAN, Edge VTEP VLAN, Management VM VLAN, HCX uplink VLAN, NSX uplink VLAN, expansion VLAN 1, expansion VLAN 2.
For each Amazon EVS VLAN subnet, you must specify a non-overlapping CIDR block. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.
type nonrec initial_vlans = {hcx_network_acl_id : network_acl_id option;A unique ID for a network access control list that the HCX VLAN uses. Required when isHcxPublic is set to true.
is_hcx_public : Smaws_Lib.Smithy_api.Types.boolean_ option;Determines if the HCX VLAN that Amazon EVS provisions is public or private.
*)expansion_vlan2 : initial_vlan_info;An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.
*)expansion_vlan1 : initial_vlan_info;An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.
*)hcx : initial_vlan_info;The HCX VLAN subnet. This VLAN subnet allows the HCX Interconnnect (IX) and HCX Network Extension (NE) to reach their peers and enable HCX Service Mesh creation.
If you plan to use a public HCX VLAN subnet, the following requirements must be met:
nsx_uplink : initial_vlan_info;The NSX uplink VLAN subnet. This VLAN subnet allows connectivity to the NSX overlay network.
*)edge_v_tep : initial_vlan_info;The edge VTEP VLAN subnet. This VLAN subnet manages traffic flowing between the internal network and external networks, including internet access and other site connections.
*)v_tep : initial_vlan_info;The VTEP VLAN subnet. This VLAN subnet handles internal network traffic between virtual machines within a VCF instance.
*)v_san : initial_vlan_info;The vSAN VLAN subnet. This VLAN subnet carries the communication between ESX hosts to implement a vSAN shared storage pool.
*)v_motion : initial_vlan_info;The vMotion VLAN subnet. This VLAN subnet carries traffic for vSphere vMotion.
*)vm_management : initial_vlan_info;The VM management VLAN subnet. This VLAN subnet carries traffic for vSphere virtual machines.
*)vmk_management : initial_vlan_info;The host VMkernel management VLAN subnet. This VLAN subnet carries traffic for managing ESX hosts and communicating with VMware vCenter Server.
*)}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.
type nonrec host_info_for_create = {dedicated_host_id : dedicated_host_id option;The unique ID of the Amazon EC2 Dedicated Host.
*)placement_group_id : placement_group_id option;The unique ID of the placement group where the host is placed.
*)instance_type : instance_type;The EC2 instance type that represents the host.
*)key_name : key_name;The name of the SSH key that is used to access the host.
*)host_name : host_name;The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.
*)}An object that represents a host.
You cannot use dedicatedHostId and placementGroupId together in the same HostInfoForCreateobject. This results in a ValidationException response.
type nonrec host_info_for_create_list = host_info_for_create listtype nonrec get_versions_response = {instance_type_esx_versions : instance_type_esx_versions_list;A list of EC2 instance types and their available ESX versions.
*)vcf_versions : vcf_version_list;A list of VCF versions with their availability status, default ESX version, and instance types.
*)}type nonrec check = {impaired_since : Smaws_Lib.Smithy_api.Types.timestamp option;The time when environment health began to be impaired.
*)result_ : check_result option;The check result.
*)id : Smaws_Lib.Smithy_api.Types.string_ option;A unique ID for the check.
*)type_ : check_type option;The check type. Amazon EVS performs the following checks:
KEY_REUSE: Verifies that the VCF license key is not used by another Amazon EVS environment.KEY_COVERAGE: Verifies that the VCF license key allocates sufficient vCPU cores for all deployed hosts.REACHABILITY: Verifies that the Amazon EVS control plane has a persistent connection to SDDC Manager.HOST_COUNT: Verifies that the environment meets the minimum host count.VCENTER_REACHABILITY: Verifies vCenter Server reachability through the vCenter connector.VCENTER_VM_SYNC: Verifies that the vCenter connector can synchronize VM inventory from vCenter Server.VCENTER_VM_EVENT: Verifies that the vCenter connector can receive VM lifecycle events from vCenter Server.OPERATIONS_MANAGER_REACHABILITY: Verifies Operations Manager reachability through the Operations Manager connector.SDDC_MANAGER_REACHABILITY: Verifies SDDC Manager reachability through the SDDC Manager connector.SDDC_MANAGER_HOST_COUNT: Verifies that the host count reported by SDDC Manager meets Amazon EVS minimum requirements.SDDC_MANAGER_KEY_COVERAGE: Verifies that the VCF license key configured in SDDC Manager covers all deployed hosts.SDDC_MANAGER_KEY_REUSE: Verifies that the VCF license key configured in SDDC Manager is not used by another Amazon EVS environment.CONNECTOR_HEALTH: Aggregate health across all connectors in the environment.}A check on the environment to identify environment health and validate VMware VCF licensing compliance.
type nonrec checks_list = check listtype nonrec connectivity_info = {private_route_server_peerings : route_server_peering_list;The unique IDs for private route server peers.
*)}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.
Not supported when vcfVersion is SELF_DEPLOYED.
type nonrec environment = {credentials : secret_list option;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.
*)service_access_security_groups : service_access_security_groups option;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.
*)kms_key_id : Smaws_Lib.Smithy_api.Types.string_ option;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.
vcf_hostnames : vcf_hostnames option;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.
*)connectivity_info : connectivity_info option;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.
*)checks : checks_list option;A check on the environment to identify connector health.
*)environment_status : check_result option;Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
*)site_id : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)license_info : license_info_list option;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.
*)terms_accepted : Smaws_Lib.Smithy_api.Types.boolean_ option;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_version : vcf_version option;The VCF version of the environment.
*)service_access_subnet_id : subnet_id option;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.
*)vpc_id : vpc_id option;The VPC associated with the environment.
*)environment_name : environment_name option;The name of the environment.
*)environment_arn : arn option;The Amazon Resource Name (ARN) that is associated with the environment.
*)modified_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the environment was modified.
*)created_at : Smaws_Lib.Smithy_api.Types.timestamp option;The date and time that the environment was created.
*)state_details : state_details option;A detailed description of the environmentState of an environment.
environment_state : environment_state option;The state of an environment.
*)environment_id : environment_id option;The unique ID for the environment.
*)}An object that represents an Amazon EVS environment.
type nonrec get_environment_response = {environment : environment option;A description of the requested environment.
*)}type nonrec get_environment_request = {environment_id : environment_id;A unique ID for the environment.
*)}type nonrec get_depot_url_response = {token : Smaws_Lib.Smithy_api.Types.string_;The authentication token for depot access. This token is included in the depot URL and is used to authenticate requests.
*)depot_url : Smaws_Lib.Smithy_api.Types.string_;The URL for accessing the Amazon EVS Custom Addon depot. This URL includes the authentication token as a path component.
*)}type nonrec get_depot_url_request = {rotate : Smaws_Lib.Smithy_api.Types.boolean_ option;Revokes the current authentication token and returns a new depot URL with a new token. Previously issued depot URLs will stop working within 5 minutes of rotation.
*)environment_id : environment_id;The unique ID of the Amazon EVS environment to get the depot URL for.
*)}type nonrec environment_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec disassociate_eip_from_vlan_request = {association_id : association_id;A unique ID for the Elastic IP address association.
*)vlan_name : Smaws_Lib.Smithy_api.Types.string_;The name of the VLAN. hcx is the only accepted VLAN name at this time.
environment_id : environment_id;A unique ID for the environment containing the VLAN that the Elastic IP address disassociates from.
*)client_token : client_token option;This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}type nonrec delete_environment_response = {environment : environment option;A description of the deleted environment.
*)}type nonrec delete_environment_request = {environment_id : environment_id;A unique ID associated with the environment to be deleted.
*)client_token : client_token option;This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}type nonrec delete_environment_host_response = {host : host option;A description of the deleted host.
*)environment_summary : environment_summary option;A summary of the environment that the host was deleted from.
*)}type nonrec delete_environment_host_request = {host_name : host_name;The DNS hostname associated with the host to be deleted.
*)environment_id : environment_id;A unique ID for the host's environment.
*)client_token : client_token option;This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the host deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}type nonrec delete_environment_connector_response = {environment_summary : environment_summary option;A summary of the environment that the connector was deleted from.
*)connector : connector option;A description of the deleted connector.
*)}type nonrec delete_environment_connector_request = {connector_id : connector_id;A unique ID for the connector to be deleted.
*)environment_id : environment_id;A unique ID for the environment that the connector belongs to.
*)client_token : client_token option;This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}type nonrec delete_entitlement_response = {entitlements : vm_entitlement_list option;A list of the deleted entitlements.
*)}type nonrec delete_entitlement_request = {vm_ids : vm_id_list;The list of VMware vSphere virtual machine managed object IDs to delete entitlements for.
*)entitlement_type : entitlement_type;The type of entitlement to delete.
*)connector_id : connector_id;A unique ID for the connector associated with the entitlement.
*)environment_id : environment_id;A unique ID for the environment that the entitlement belongs to.
*)client_token : client_token option;This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the entitlement deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}type nonrec create_environment_response = {environment : environment option;A description of the created environment.
*)}type nonrec create_environment_request = {site_id : Smaws_Lib.Smithy_api.Types.string_ option;The Broadcom Site ID that is allocated to you as part of your electronic software delivery. This ID allows customer access to the Broadcom portal, and is provided to you by Broadcom at the close of your software contract or contract renewal. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.
Not supported when vcfVersion is SELF_DEPLOYED.
vcf_hostnames : vcf_hostnames option;The DNS hostnames for the virtual machines that host the VCF management appliances. Provide hostnames for vCenter, NSX Manager, SDDC Manager, and Cloud Builder.
Not supported when vcfVersion is SELF_DEPLOYED.
hosts : host_info_for_create_list option;The ESX hosts to add to the environment. For each host, provide the desired hostname, EC2 SSH keypair name, and EC2 instance type. Optionally, provide a partition or cluster placement group, or use Amazon EC2 Dedicated Hosts.
Not supported when vcfVersion is SELF_DEPLOYED. In that case, you can add hosts using CreateEnvironmentHost after the environment is created.
license_info : license_info_list option;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.
VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.
VCF license information can be retrieved from the Broadcom portal.
Not supported when vcfVersion is SELF_DEPLOYED.
connectivity_info : connectivity_info option;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 edges over the NSX uplink subnet, providing BGP-based dynamic routing for overlay networks.
Not supported when vcfVersion is SELF_DEPLOYED.
initial_vlans : initial_vlans;The initial VLAN subnets for the Amazon EVS environment.
For each Amazon EVS VLAN subnet, you must specify a non-overlapping CIDR block. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.
*)terms_accepted : Smaws_Lib.Smithy_api.Types.boolean_;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_version : vcf_version;The VCF version to use for the environment.
SELF_DEPLOYED: You install VCF yourself. The licenseInfo, hosts, vcfHostnames, siteId, and connectivityInfo parameters are not supported.service_access_subnet_id : subnet_id;The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. The Amazon EVS control plane uses this subnet to interface with your environment. This includes validating DNS records and enabling Amazon EVS Connectors.
*)vpc_id : vpc_id;A unique ID for the VPC that the environment is deployed inside.
Amazon EVS requires that all VPC subnets exist in a single Availability Zone in a Region where the service is available.
The VPC that you specify must have a valid DHCP option set with domain name, at least two DNS servers, and an NTP server. These settings are used to configure your VCF appliances and hosts. The VPC cannot be used with any other deployed Amazon EVS environment. Amazon EVS does not provide multi-VPC support for environments at this time.
Amazon EVS does not support the following Amazon Web Services networking options for NSX overlay connectivity: cross-Region VPC peering, Amazon S3 gateway endpoints, or Amazon Web Services Direct Connect virtual private gateway associations.
Ensure that you specify a VPC that is adequately sized to accommodate the Amazon EVS subnets.
*)service_access_security_groups : service_access_security_groups option;The security group that controls communication between the Amazon EVS control plane and VPC. The default security group is used if a custom security group isn't specified.
The security group should allow access to the following.
You should avoid modifying the security group rules after deployment, as this can break the persistent connection between the Amazon EVS control plane and VPC. This can cause future environment actions like adding or removing hosts to fail.
*)kms_key_id : Smaws_Lib.Smithy_api.Types.string_ option;A unique ID for the customer-managed KMS key that is used to encrypt the VCF credential pairs for SDDC Manager, NSX Manager, and vCenter appliances. These credentials are stored in Amazon Web Services Secrets Manager.
*)environment_name : environment_name option;The name to give to your environment. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character, and can't be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're creating the environment in.
*)client_token : client_token option;This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}type nonrec create_environment_host_response = {host : host option;A description of the created host.
*)environment_summary : environment_summary option;A summary of the environment that the host is created in.
*)}type nonrec create_environment_host_request = {esx_version : esx_version option;The ESX version to use for the host.
*)host : host_info_for_create;The host that is created and added to the environment.
*)environment_id : environment_id;A unique ID for the environment that the host is added to.
*)client_token : client_token option;This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the host creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}type nonrec create_environment_connector_response = {connector : connector option;A description of the created connector.
*)}type nonrec create_environment_connector_request = {secret_identifier : secret_identifier;The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance. SDDC_MANAGER requires an apiKey field; OPERATIONS_MANAGER and VCENTER require username and password fields.
Do not use credentials with Administrator privileges. We recommend using a service account with read-only permissions.
*)appliance_fqdn : appliance_fqdn;The fully qualified domain name (FQDN) of the VCF appliance that the connector targets.
*)type_ : connector_type;The type of connector to create.
OPERATIONS_MANAGER: Connector to an Operations Manager appliance. Required for VCF 9x environments.SDDC_MANAGER: Connector to an SDDC Manager appliance. Required for VCF 5.x environments.VCENTER: Connector to a vCenter Server appliance. Required for features that depend on vCenter, such as Windows Server license-included.environment_id : environment_id;A unique ID for the environment to create the connector in.
*)client_token : client_token option;This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}type nonrec create_entitlement_response = {entitlements : vm_entitlement_list option;A list of the created entitlements.
*)}type nonrec create_entitlement_request = {vm_ids : vm_id_list;The list of VMware vSphere virtual machine managed object IDs to create entitlements for.
*)entitlement_type : entitlement_type;The type of entitlement to create.
*)connector_id : connector_id;A unique ID for the connector associated with the entitlement.
*)environment_id : environment_id;A unique ID for the environment to create the entitlement in.
*)client_token : client_token option;This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the entitlement creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}type nonrec associate_eip_to_vlan_request = {allocation_id : allocation_id;The Elastic IP address allocation ID.
*)vlan_name : Smaws_Lib.Smithy_api.Types.string_;The name of the VLAN. hcx is the only accepted VLAN name at this time.
environment_id : environment_id;A unique ID for the environment containing the VLAN that the Elastic IP address associates with.
*)client_token : client_token option;This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}