<?php
// This file was auto-generated from sdk-root/src/data/evs/2023-07-27/docs-2.json
return [ 'version' => '2.0', 'service' => '<p>Amazon Elastic VMware Service (Amazon EVS) is a service that you can use to deploy a VMware Cloud Foundation (VCF) software environment directly on EC2 bare metal instances within an Amazon Virtual Private Cloud (VPC).</p> <p>Workloads running on Amazon EVS are fully compatible with workloads running on any standard VMware vSphere environment. This means that you can migrate any VMware-based workload to Amazon EVS without workload modification.</p>', 'operations' => [ 'AssociateEipToVlan' => '<p>Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.</p>', 'CreateEnvironment' => '<p>Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.</p> <p>During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.</p> <p>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.</p> <note> <p>You cannot use the <code>dedicatedHostId</code> and <code>placementGroupId</code> parameters together in the same <code>CreateEnvironment</code> action. This results in a <code>ValidationException</code> response.</p> </note>', 'CreateEnvironmentHost' => '<p>Creates an ESXi host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.</p> <p>This action can only be used after the Amazon EVS environment is deployed.</p> <p>You can use the <code>dedicatedHostId</code> parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation.</p> <p> You can use the <code>placementGroupId</code> parameter to specify a cluster or partition placement group to launch EC2 instances into.</p> <note> <p>You cannot use the <code>dedicatedHostId</code> and <code>placementGroupId</code> parameters together in the same <code>CreateEnvironmentHost</code> action. This results in a <code>ValidationException</code> response.</p> </note>', 'DeleteEnvironment' => '<p>Deletes an Amazon EVS environment.</p> <p>Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the <code>DeleteEnvironmentHost</code> action.</p> <p>Environment deletion also deletes the associated Amazon EVS VLAN subnets and Amazon Web Services Secrets Manager secrets that Amazon EVS created. Amazon Web Services resources that you create are not deleted. These resources may continue to incur costs.</p>', 'DeleteEnvironmentHost' => '<p>Deletes a host from an Amazon EVS environment.</p> <note> <p>Before deleting a host, you must unassign and decommission the host from within the SDDC Manager user interface. Not doing so could impact the availability of your virtual machines or result in data loss.</p> </note>', 'DisassociateEipFromVlan' => '<p>Disassociates an Elastic IP address from a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.</p>', 'GetEnvironment' => '<p>Returns a description of the specified environment.</p>', 'ListEnvironmentHosts' => '<p>List the hosts within an environment.</p>', 'ListEnvironmentVlans' => '<p>Lists environment VLANs that are associated with the specified environment.</p>', 'ListEnvironments' => '<p>Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.</p>', 'ListTagsForResource' => '<p>Lists the tags for an Amazon EVS resource.</p>', 'TagResource' => '<p>Associates the specified tags to an Amazon EVS resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request parameters, they aren\'t changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EVS resources don\'t propagate to any other resources associated with the environment. For example, if you tag an environment with this operation, that tag doesn\'t automatically propagate to the VLAN subnets and hosts associated with the environment.</p>', 'UntagResource' => '<p>Deletes specified tags from an Amazon EVS resource.</p>', ], 'shapes' => [ 'AllocationId' => [ 'base' => NULL, 'refs' => [ 'AssociateEipToVlanRequest$allocationId' => '<p>The Elastic IP address allocation ID.</p>', 'EipAssociation$allocationId' => '<p>The Elastic IP address allocation ID.</p>', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'Environment$environmentArn' => '<p>The Amazon Resource Name (ARN) that is associated with the environment.</p>', 'EnvironmentSummary$environmentArn' => '<p>The Amazon Resource Name (ARN) that is associated with the environment.</p>', 'ListTagsForResourceRequest$resourceArn' => '<p>The Amazon Resource Name (ARN) that identifies the resource to list tags for.</p>', 'TagResourceRequest$resourceArn' => '<p>The Amazon Resource Name (ARN) of the resource to add tags to.</p>', 'UntagResourceRequest$resourceArn' => '<p>The Amazon Resource Name (ARN) of the resource to delete tags from.</p>', ], ], 'AssociateEipToVlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateEipToVlanRequestVlanNameString' => [ 'base' => NULL, 'refs' => [ 'AssociateEipToVlanRequest$vlanName' => '<p>The name of the VLAN. <code>hcx</code> is the only accepted VLAN name at this time.</p>', ], ], 'AssociateEipToVlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociationId' => [ 'base' => NULL, 'refs' => [ 'DisassociateEipFromVlanRequest$associationId' => '<p> A unique ID for the Elastic IP address association.</p>', 'EipAssociation$associationId' => '<p>A unique ID for the elastic IP address association with the VLAN subnet.</p>', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CreateEnvironmentRequest$termsAccepted' => '<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>', 'Environment$termsAccepted' => '<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>', 'InitialVlans$isHcxPublic' => '<p>Determines if the HCX VLAN that Amazon EVS provisions is public or private.</p>', 'Vlan$isPublic' => '<p>Determines if the VLAN that Amazon EVS provisions is public or private.</p>', ], ], 'Check' => [ 'base' => '<p>A check on the environment to identify environment health and validate VMware VCF licensing compliance.</p>', 'refs' => [ 'ChecksList$member' => NULL, ], ], 'CheckResult' => [ 'base' => NULL, 'refs' => [ 'Check$result' => '<p> The check result.</p>', 'Environment$environmentStatus' => '<p>Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.</p>', 'EnvironmentSummary$environmentStatus' => '<p>Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.</p>', ], ], 'CheckType' => [ 'base' => NULL, 'refs' => [ 'Check$type' => '<p>The check type. Amazon EVS performs the following checks.</p> <ul> <li> <p> <code>KEY_REUSE</code>: checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment.</p> </li> <li> <p> <code>KEY_COVERAGE</code>: checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys.</p> </li> <li> <p> <code>REACHABILITY</code>: checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails.</p> </li> <li> <p> <code>HOST_COUNT</code>: Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1.</p> <p>If this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts.</p> </li> </ul>', ], ], 'ChecksList' => [ 'base' => NULL, 'refs' => [ 'Environment$checks' => '<p>A check on the environment to identify instance health and VMware VCF licensing issues.</p>', ], ], 'Cidr' => [ 'base' => NULL, 'refs' => [ 'InitialVlanInfo$cidr' => '<p> 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.</p>', 'Vlan$cidr' => '<p>The CIDR block of the VLAN. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.</p>', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'AssociateEipToVlanRequest$clientToken' => '<p><note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>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.</p></p>', 'CreateEnvironmentHostRequest$clientToken' => '<p><note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>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.</p></p>', 'CreateEnvironmentRequest$clientToken' => '<p><note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>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.</p></p>', 'DeleteEnvironmentHostRequest$clientToken' => '<p><note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>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.</p></p>', 'DeleteEnvironmentRequest$clientToken' => '<p><note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>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.</p></p>', 'DisassociateEipFromVlanRequest$clientToken' => '<p><note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>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.</p></p>', ], ], 'ConnectivityInfo' => [ 'base' => '<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>', 'refs' => [ 'CreateEnvironmentRequest$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 edges over the NSX uplink subnet, providing BGP-based dynamic routing for overlay networks.</p>', 'Environment$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>', ], ], 'CreateEnvironmentHostRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEnvironmentHostResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEnvironmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEnvironmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DedicatedHostId' => [ 'base' => NULL, 'refs' => [ 'Host$dedicatedHostId' => '<p>The unique ID of the Amazon EC2 Dedicated Host.</p>', 'HostInfoForCreate$dedicatedHostId' => '<p>The unique ID of the Amazon EC2 Dedicated Host.</p>', ], ], 'DeleteEnvironmentHostRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEnvironmentHostResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEnvironmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEnvironmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateEipFromVlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateEipFromVlanRequestVlanNameString' => [ 'base' => NULL, 'refs' => [ 'DisassociateEipFromVlanRequest$vlanName' => '<p>The name of the VLAN. <code>hcx</code> is the only accepted VLAN name at this time.</p>', ], ], 'DisassociateEipFromVlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'EipAssociation' => [ 'base' => '<p>An Elastic IP address association with the elastic network interface in the VLAN subnet.</p>', 'refs' => [ 'EipAssociationList$member' => NULL, ], ], 'EipAssociationList' => [ 'base' => NULL, 'refs' => [ 'Vlan$eipAssociations' => '<p>An array of Elastic IP address associations.</p>', ], ], 'Environment' => [ 'base' => '<p>An object that represents an Amazon EVS environment.</p>', 'refs' => [ 'CreateEnvironmentResponse$environment' => '<p>A description of the created environment.</p>', 'DeleteEnvironmentResponse$environment' => '<p>A description of the deleted environment.</p>', 'GetEnvironmentResponse$environment' => '<p>A description of the requested environment.</p>', ], ], 'EnvironmentId' => [ 'base' => NULL, 'refs' => [ 'AssociateEipToVlanRequest$environmentId' => '<p>A unique ID for the environment containing the VLAN that the Elastic IP address associates with.</p>', 'CreateEnvironmentHostRequest$environmentId' => '<p>A unique ID for the environment that the host is added to.</p>', 'DeleteEnvironmentHostRequest$environmentId' => '<p>A unique ID for the host\'s environment.</p>', 'DeleteEnvironmentRequest$environmentId' => '<p>A unique ID associated with the environment to be deleted.</p>', 'DisassociateEipFromVlanRequest$environmentId' => '<p>A unique ID for the environment containing the VLAN that the Elastic IP address disassociates from.</p>', 'Environment$environmentId' => '<p>The unique ID for the environment.</p>', 'EnvironmentSummary$environmentId' => '<p>A unique ID for the environment.</p>', 'GetEnvironmentRequest$environmentId' => '<p>A unique ID for the environment.</p>', 'ListEnvironmentHostsRequest$environmentId' => '<p>A unique ID for the environment.</p>', 'ListEnvironmentVlansRequest$environmentId' => '<p>A unique ID for the environment.</p>', ], ], 'EnvironmentName' => [ 'base' => NULL, 'refs' => [ 'CreateEnvironmentRequest$environmentName' => '<p>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.</p>', 'Environment$environmentName' => '<p>The name of the environment.</p>', 'EnvironmentSummary$environmentName' => '<p> The name of the environment.</p>', ], ], 'EnvironmentState' => [ 'base' => NULL, 'refs' => [ 'Environment$environmentState' => '<p>The state of an environment.</p>', 'EnvironmentStateList$member' => NULL, 'EnvironmentSummary$environmentState' => '<p>The state of an environment.</p>', ], ], 'EnvironmentStateList' => [ 'base' => NULL, 'refs' => [ 'ListEnvironmentsRequest$state' => '<p>The state of an environment. Used to filter response results to return only environments with the specified <code>environmentState</code>.</p>', ], ], 'EnvironmentSummary' => [ 'base' => '<p>A list of environments with summarized environment details.</p>', 'refs' => [ 'CreateEnvironmentHostResponse$environmentSummary' => '<p>A summary of the environment that the host is created in.</p>', 'DeleteEnvironmentHostResponse$environmentSummary' => '<p>A summary of the environment that the host was deleted from.</p>', 'EnvironmentSummaryList$member' => NULL, ], ], 'EnvironmentSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEnvironmentsResponse$environmentSummaries' => '<p>A list of environments with summarized environment details.</p>', ], ], 'GetEnvironmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetEnvironmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'Host' => [ 'base' => '<p>An ESXi host that runs on an Amazon EC2 bare metal instance. Four hosts are created in an Amazon EVS environment during environment creation. You can add hosts to an environment using the <code>CreateEnvironmentHost</code> operation. Amazon EVS supports 4-16 hosts per environment.</p>', 'refs' => [ 'CreateEnvironmentHostResponse$host' => '<p>A description of the created host.</p>', 'DeleteEnvironmentHostResponse$host' => '<p>A description of the deleted host.</p>', 'HostList$member' => NULL, ], ], 'HostInfoForCreate' => [ 'base' => '<p>An object that represents a host.</p> <note> <p>You cannot use <code>dedicatedHostId</code> and <code>placementGroupId</code> together in the same <code>HostInfoForCreate</code>object. This results in a <code>ValidationException</code> response.</p> </note>', 'refs' => [ 'CreateEnvironmentHostRequest$host' => '<p>The host that is created and added to the environment.</p>', 'HostInfoForCreateList$member' => NULL, ], ], 'HostInfoForCreateList' => [ 'base' => NULL, 'refs' => [ 'CreateEnvironmentRequest$hosts' => '<p>The ESXi hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation.</p> <p>For each host, you must provide the desired hostname, EC2 SSH keypair name, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.</p>', ], ], 'HostList' => [ 'base' => NULL, 'refs' => [ 'ListEnvironmentHostsResponse$environmentHosts' => '<p>A list of hosts in the environment.</p>', ], ], 'HostName' => [ 'base' => NULL, 'refs' => [ 'DeleteEnvironmentHostRequest$hostName' => '<p>The DNS hostname associated with the host to be deleted.</p>', 'Host$hostName' => '<p>The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.</p>', 'HostInfoForCreate$hostName' => '<p>The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.</p>', 'VcfHostnames$vCenter' => '<p>The VMware vCenter hostname.</p>', 'VcfHostnames$nsx' => '<p>The VMware NSX hostname.</p>', 'VcfHostnames$nsxManager1' => '<p>The hostname for the first VMware NSX Manager virtual machine (VM).</p>', 'VcfHostnames$nsxManager2' => '<p>The hostname for the second VMware NSX Manager virtual machine (VM).</p>', 'VcfHostnames$nsxManager3' => '<p>The hostname for the third VMware NSX Manager virtual machine (VM).</p>', 'VcfHostnames$nsxEdge1' => '<p>The hostname for the first NSX Edge node.</p>', 'VcfHostnames$nsxEdge2' => '<p>The hostname for the second NSX Edge node.</p>', 'VcfHostnames$sddcManager' => '<p>The hostname for SDDC Manager.</p>', 'VcfHostnames$cloudBuilder' => '<p>The hostname for VMware Cloud Builder.</p>', ], ], 'HostState' => [ 'base' => NULL, 'refs' => [ 'Host$hostState' => '<p> The state of the host.</p>', ], ], 'InitialVlanInfo' => [ 'base' => '<p>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.</p> <note> <p>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.</p> </note>', 'refs' => [ 'InitialVlans$vmkManagement' => '<p> The host VMkernel management VLAN subnet. This VLAN subnet carries traffic for managing ESXi hosts and communicating with VMware vCenter Server.</p>', 'InitialVlans$vmManagement' => '<p>The VM management VLAN subnet. This VLAN subnet carries traffic for vSphere virtual machines.</p>', 'InitialVlans$vMotion' => '<p> The vMotion VLAN subnet. This VLAN subnet carries traffic for vSphere vMotion.</p>', 'InitialVlans$vSan' => '<p> The vSAN VLAN subnet. This VLAN subnet carries the communication between ESXi hosts to implement a vSAN shared storage pool.</p>', 'InitialVlans$vTep' => '<p> The VTEP VLAN subnet. This VLAN subnet handles internal network traffic between virtual machines within a VCF instance.</p>', 'InitialVlans$edgeVTep' => '<p>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.</p>', 'InitialVlans$nsxUplink' => '<p> The NSX uplink VLAN subnet. This VLAN subnet allows connectivity to the NSX overlay network.</p>', 'InitialVlans$hcx' => '<p>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.</p> <p>If you plan to use a public HCX VLAN subnet, the following requirements must be met:</p> <ul> <li> <p>Must have a /28 netmask and be allocated from the IPAM public pool. Required for HCX internet access configuration.</p> </li> <li> <p>The HCX public VLAN CIDR block must be added to the VPC as a secondary CIDR block.</p> </li> <li> <p>Must have at least three Elastic IP addresses to be allocated from the public IPAM pool for HCX components.</p> </li> </ul>', 'InitialVlans$expansionVlan1' => '<p>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.</p>', 'InitialVlans$expansionVlan2' => '<p>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.</p>', ], ], 'InitialVlans' => [ 'base' => '<p>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.</p>', 'refs' => [ 'CreateEnvironmentRequest$initialVlans' => '<p>The initial VLAN subnets for the Amazon EVS environment.</p> <note> <p>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.</p> </note>', ], ], 'InstanceType' => [ 'base' => NULL, 'refs' => [ 'Host$instanceType' => '<p>The EC2 instance type of the host.</p> <note> <p>EC2 instances created through Amazon EVS do not support associating an IAM instance profile.</p> </note>', 'HostInfoForCreate$instanceType' => '<p>The EC2 instance type that represents the host.</p>', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ThrottlingException$retryAfterSeconds' => '<p>The seconds to wait to retry.</p>', ], ], 'IpAddress' => [ 'base' => NULL, 'refs' => [ 'EipAssociation$ipAddress' => '<p>The Elastic IP address.</p>', 'Host$ipAddress' => '<p>The IP address of the host.</p>', ], ], 'KeyName' => [ 'base' => NULL, 'refs' => [ 'Host$keyName' => '<p>The name of the SSH key that is used to access the host.</p>', 'HostInfoForCreate$keyName' => '<p>The name of the SSH key that is used to access the host.</p>', ], ], 'LicenseInfo' => [ 'base' => '<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.</p>', 'refs' => [ 'LicenseInfoList$member' => NULL, ], ], 'LicenseInfoList' => [ 'base' => NULL, 'refs' => [ 'CreateEnvironmentRequest$licenseInfo' => '<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 cover a minimum of 256 cores. The vSAN license key must provide at least 110 TiB of vSAN capacity.</p> <p>VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.</p> <p>VCF license information can be retrieved from the Broadcom portal.</p>', 'Environment$licenseInfo' => '<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 cover a minimum of 256 cores. The vSAN license key must provide at least 110 TiB of vSAN capacity.</p>', ], ], 'ListEnvironmentHostsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEnvironmentHostsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEnvironmentVlansRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEnvironmentVlansResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEnvironmentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEnvironmentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListEnvironmentHostsRequest$maxResults' => '<p>The maximum number of results to return. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified.</p>', 'ListEnvironmentVlansRequest$maxResults' => '<p>The maximum number of results to return. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified.</p>', 'ListEnvironmentsRequest$maxResults' => '<p>The maximum number of results to return. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified.</p>', ], ], 'NetworkAclId' => [ 'base' => NULL, 'refs' => [ 'InitialVlans$hcxNetworkAclId' => '<p>A unique ID for a network access control list that the HCX VLAN uses. Required when <code>isHcxPublic</code> is set to <code>true</code>.</p>', 'Vlan$networkAclId' => '<p>A unique ID for a network access control list.</p>', ], ], 'NetworkInterface' => [ 'base' => '<p>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.</p>', 'refs' => [ 'NetworkInterfaceList$member' => NULL, ], ], 'NetworkInterfaceId' => [ 'base' => NULL, 'refs' => [ 'NetworkInterface$networkInterfaceId' => '<p>The unique ID of the elastic network interface.</p>', ], ], 'NetworkInterfaceList' => [ 'base' => NULL, 'refs' => [ 'Host$networkInterfaces' => '<p>The elastic network interfaces that are attached to the host.</p>', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListEnvironmentHostsRequest$nextToken' => '<p>A unique pagination token for each page. If <code>nextToken</code> 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 <i>HTTP 400 InvalidToken</i> error.</p>', 'ListEnvironmentHostsResponse$nextToken' => '<p>A unique pagination token for next page results. Make the call again using this token to retrieve the next page.</p>', 'ListEnvironmentVlansRequest$nextToken' => '<p>A unique pagination token for each page. If <code>nextToken</code> 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 <i>HTTP 400 InvalidToken</i> error.</p>', 'ListEnvironmentVlansResponse$nextToken' => '<p>A unique pagination token for next page results. Make the call again using this token to retrieve the next page.</p>', 'ListEnvironmentsRequest$nextToken' => '<p>A unique pagination token for each page. If <code>nextToken</code> 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 <i>HTTP 400 InvalidToken</i> error.</p>', 'ListEnvironmentsResponse$nextToken' => '<p>A unique pagination token for next page results. Make the call again using this token to retrieve the next page.</p>', ], ], 'PlacementGroupId' => [ 'base' => NULL, 'refs' => [ 'Host$placementGroupId' => '<p>The unique ID of the placement group where the host is placed.</p>', 'HostInfoForCreate$placementGroupId' => '<p>The unique ID of the placement group where the host is placed.</p>', ], ], 'RequestTagMap' => [ 'base' => NULL, 'refs' => [ 'CreateEnvironmentRequest$tags' => '<p>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 Web Services resources.</p>', 'TagResourceRequest$tags' => '<p>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 environment or Amazon Web Services resources.</p>', ], ], 'ResourceNotFoundException' => [ 'base' => '<p>A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a <code>state</code> of <code>DELETED</code>.</p>', 'refs' => [], ], 'ResponseTagMap' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceResponse$tags' => '<p>The tags for the resource.</p>', ], ], 'RouteServerPeering' => [ 'base' => NULL, 'refs' => [ 'RouteServerPeeringList$member' => NULL, ], ], 'RouteServerPeeringList' => [ 'base' => NULL, 'refs' => [ 'ConnectivityInfo$privateRouteServerPeerings' => '<p>The unique IDs for private route server peers.</p>', ], ], 'Secret' => [ 'base' => '<p>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.</p>', 'refs' => [ 'SecretList$member' => NULL, ], ], 'SecretList' => [ 'base' => NULL, 'refs' => [ 'Environment$credentials' => '<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>', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroups$member' => NULL, ], ], 'SecurityGroups' => [ 'base' => NULL, 'refs' => [ 'ServiceAccessSecurityGroups$securityGroups' => '<p>The security groups that allow service access.</p>', ], ], 'ServiceAccessSecurityGroups' => [ 'base' => '<p>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.</p>', 'refs' => [ 'CreateEnvironmentRequest$serviceAccessSecurityGroups' => '<p>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.</p> <p>The security group should allow access to the following.</p> <ul> <li> <p>TCP/UDP access to the DNS servers</p> </li> <li> <p>HTTPS/SSH access to the host management VLAN subnet</p> </li> <li> <p>HTTPS/SSH access to the Management VM VLAN subnet</p> </li> </ul> <p>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.</p>', 'Environment$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>', ], ], 'ServiceQuotaExceededException' => [ 'base' => '<p>The number of one or more Amazon EVS resources exceeds the maximum allowed. For a list of Amazon EVS quotas, see <a href="https://docs.aws.amazon.com/evs/latest/userguide/service-quotas-evs.html">Amazon EVS endpoints and quotas</a> in the <i>Amazon EVS User Guide</i>. Delete some resources or request an increase in your service quota. To request an increase, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">Amazon Web Services Service Quotas</a> in the <i>Amazon Web Services General Reference Guide</i>. </p>', 'refs' => [], ], 'SolutionKey' => [ 'base' => NULL, 'refs' => [ 'LicenseInfo$solutionKey' => '<p> The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must cover a minimum of 256 cores.</p>', ], ], 'StateDetails' => [ 'base' => NULL, 'refs' => [ 'Environment$stateDetails' => '<p>A detailed description of the <code>environmentState</code> of an environment.</p>', 'Host$stateDetails' => '<p> A detailed description of the <code>hostState</code> of a host.</p>', 'Vlan$stateDetails' => '<p>The state details of the VLAN.</p>', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'CreateEnvironmentRequest$kmsKeyId' => '<p>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.</p>', 'CreateEnvironmentRequest$siteId' => '<p>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.</p>', 'Environment$siteId' => '<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$kmsKeyId' => '<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>', 'Host$ec2InstanceId' => '<p>The unique ID of the EC2 instance that represents the host.</p>', 'ResourceNotFoundException$message' => '<p>Describes the error encountered.</p>', 'ResourceNotFoundException$resourceId' => '<p>The ID of the resource that could not be found.</p>', 'ResourceNotFoundException$resourceType' => '<p>The type of the resource that is associated with the error.</p>', 'Secret$secretArn' => '<p> The Amazon Resource Name (ARN) of the secret.</p>', 'ServiceQuotaExceededException$message' => '<p>Describes the error encountered.</p>', 'TagPolicyException$message' => '<p>Describes the error encountered</p>', 'ThrottlingException$message' => '<p>Describes the error encountered.</p>', 'TooManyTagsException$message' => '<p>Describes the error encountered.</p>', 'ValidationException$message' => '<p>Describes the error encountered.</p>', 'ValidationExceptionField$name' => '<p> The field name.</p>', 'ValidationExceptionField$message' => '<p> A message describing why the field failed validation.</p>', 'Vlan$availabilityZone' => '<p>The availability zone of the VLAN.</p>', 'Vlan$functionName' => '<p>The VMware VCF traffic type that is carried over the VLAN. For example, a VLAN with a <code>functionName</code> of <code>hcx</code> is being used to carry VMware HCX traffic.</p>', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'CreateEnvironmentRequest$serviceAccessSubnetId' => '<p>The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to validate mandatory DNS records for your VCF appliances and hosts and create the environment.</p>', 'Environment$serviceAccessSubnetId' => '<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>', 'Vlan$subnetId' => '<p> The unique ID of the VLAN subnet.</p>', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'RequestTagMap$key' => NULL, 'ResponseTagMap$key' => NULL, 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '<p>The keys of the tags to delete.</p>', ], ], 'TagPolicyException' => [ 'base' => '<p><note> <p> <code>TagPolicyException</code> is deprecated. See <a href="https://docs.aws.amazon.com/evs/latest/APIReference/API_ValidationException.html"> <code>ValidationException</code> </a> instead.</p> </note> <p>The request doesn\'t comply with IAM tag policy. Correct your request and then retry it.</p></p>', 'refs' => [], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'RequestTagMap$value' => NULL, 'ResponseTagMap$value' => NULL, ], ], 'ThrottlingException' => [ 'base' => '<p>The operation couldn\'t be performed because the service is throttling requests. This exception is thrown when there are too many requests accepted concurrently from the service endpoint.</p>', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Check$impairedSince' => '<p>The time when environment health began to be impaired.</p>', 'Environment$createdAt' => '<p>The date and time that the environment was created.</p>', 'Environment$modifiedAt' => '<p> The date and time that the environment was modified.</p>', 'EnvironmentSummary$createdAt' => '<p> The date and time that the environment was created.</p>', 'EnvironmentSummary$modifiedAt' => '<p> The date and time that the environment was modified.</p>', 'Host$createdAt' => '<p> The date and time that the host was created.</p>', 'Host$modifiedAt' => '<p> The date and time that the host was modified.</p>', 'Vlan$createdAt' => '<p>The date and time that the VLAN was created.</p>', 'Vlan$modifiedAt' => '<p> The date and time that the VLAN was modified.</p>', ], ], 'TooManyTagsException' => [ 'base' => '<p><note> <p> <code>TooManyTagsException</code> is deprecated. See <a href="https://docs.aws.amazon.com/evs/latest/APIReference/API_ServiceQuotaExceededException.html"> <code>ServiceQuotaExceededException</code> </a> instead.</p> </note> <p>A service resource associated with the request has more than 200 tags.</p></p>', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'VSanLicenseKey' => [ 'base' => NULL, 'refs' => [ 'LicenseInfo$vsanKey' => '<p> The VSAN license key. This license unlocks vSAN features. The vSAN license key must provide at least 110 TiB of vSAN capacity.</p>', ], ], 'ValidationException' => [ 'base' => '<p>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.</p>', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => '<p>Stores information about a field passed inside a request that resulted in an exception.</p>', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => NULL, 'refs' => [ 'ValidationException$fieldList' => '<p>A list of fields that didn\'t validate.</p>', ], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$reason' => '<p>The reason for the exception.</p>', ], ], 'VcfHostnames' => [ 'base' => '<p>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.</p> <p>VMware VCF requires the deployment of two NSX Edge nodes, and three NSX Manager virtual machines.</p>', 'refs' => [ 'CreateEnvironmentRequest$vcfHostnames' => '<p>The DNS hostnames for the virtual machines that host the VCF management appliances. Amazon EVS requires that you provide DNS hostnames for the following appliances: vCenter, NSX Manager, SDDC Manager, and Cloud Builder.</p>', 'Environment$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>', ], ], 'VcfVersion' => [ 'base' => NULL, 'refs' => [ 'CreateEnvironmentRequest$vcfVersion' => '<p> The VCF version to use for the environment. Amazon EVS only supports VCF version 5.2.1 at this time.</p>', 'Environment$vcfVersion' => '<p>The VCF version of the environment.</p>', 'EnvironmentSummary$vcfVersion' => '<p>The VCF version of the environment.</p>', ], ], 'Vlan' => [ 'base' => '<p>The VLANs that Amazon EVS creates during environment creation.</p>', 'refs' => [ 'AssociateEipToVlanResponse$vlan' => NULL, 'DisassociateEipFromVlanResponse$vlan' => NULL, 'VlanList$member' => NULL, ], ], 'VlanId' => [ 'base' => NULL, 'refs' => [ 'Vlan$vlanId' => '<p>The unique ID of the VLAN.</p>', ], ], 'VlanList' => [ 'base' => NULL, 'refs' => [ 'ListEnvironmentVlansResponse$environmentVlans' => '<p>A list of VLANs that are associated with the specified environment.</p>', ], ], 'VlanState' => [ 'base' => NULL, 'refs' => [ 'Vlan$vlanState' => '<p> The state of the VLAN.</p>', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'CreateEnvironmentRequest$vpcId' => '<p>A unique ID for the VPC that the environment is deployed inside.</p> <p>Amazon EVS requires that all VPC subnets exist in a single Availability Zone in a Region where the service is available.</p> <p>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.</p> <p>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.</p> <note> <p>Ensure that you specify a VPC that is adequately sized to accommodate the {evws} subnets.</p> </note>', 'Environment$vpcId' => '<p>The VPC associated with the environment.</p>', ], ], ],];
