AWS.Tools.Evs.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Evs</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.EVS.AddEVSResourceTagCmdlet"> <summary> Associates the specified tags to an Amazon EVS resource with the specified <c>resourceArn</c>. 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.AddEVSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to add tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.AddEVSResourceTagCmdlet.Tag"> <summary> <para> <para>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.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.AddEVSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Evs.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.AddEVSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentCmdlet"> <summary> Returns a description of the specified environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentCmdlet.EnvironmentId"> <summary> <para> <para>A unique ID for the environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Evs.Model.GetEnvironmentResponse). Specifying the name of a property of type Amazon.Evs.Model.GetEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentHostListCmdlet"> <summary> List the hosts within an environment.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentHostListCmdlet.EnvironmentId"> <summary> <para> <para>A unique ID for the environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentHostListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return. If you specify <c>MaxResults</c> in the request, the response includes information up to the limit specified.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentHostListCmdlet.NextToken"> <summary> <para> <para>A unique pagination token for each page. If <c>nextToken</c> 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.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentHostListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentHosts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Evs.Model.ListEnvironmentHostsResponse). Specifying the name of a property of type Amazon.Evs.Model.ListEnvironmentHostsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentHostListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentListCmdlet"> <summary> Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentListCmdlet.State"> <summary> <para> <para>The state of an environment. Used to filter response results to return only environments with the specified <c>environmentState</c>.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return. If you specify <c>MaxResults</c> in the request, the response includes information up to the limit specified.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentListCmdlet.NextToken"> <summary> <para> <para>A unique pagination token for each page. If <c>nextToken</c> 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.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Evs.Model.ListEnvironmentsResponse). Specifying the name of a property of type Amazon.Evs.Model.ListEnvironmentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentVlanListCmdlet"> <summary> Lists environment VLANs that are associated with the specified environment.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentVlanListCmdlet.EnvironmentId"> <summary> <para> <para>A unique ID for the environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentVlanListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return. If you specify <c>MaxResults</c> in the request, the response includes information up to the limit specified.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentVlanListCmdlet.NextToken"> <summary> <para> <para>A unique pagination token for each page. If <c>nextToken</c> 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.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentVlanListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentVlans'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Evs.Model.ListEnvironmentVlansResponse). Specifying the name of a property of type Amazon.Evs.Model.ListEnvironmentVlansResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSEnvironmentVlanListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EVS.GetEVSResourceTagCmdlet"> <summary> Lists the tags for an Amazon EVS resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the resource to list tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.GetEVSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Evs.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Evs.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet"> <summary> Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server. <para> During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF. </para><para> It can take several hours to create an environment. After the deployment completes, you can configure VCF according to your unique requirements. </para><note><para> You cannot use the <c>dedicatedHostId</c> and <c>placementGroupId</c> parameters together in the same <c>CreateEnvironment</c> action. This results in a <c>ValidationException</c> response. </para></note><note><para> EC2 instances created through Amazon EVS do not support associating an IAM instance profile. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.EdgeVTep_Cidr"> <summary> <para> <para> The CIDR block that you provide to create a VLAN subnet. VLAN CIDR blocks must not overlap with other subnets in the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.ExpansionVlan1_Cidr"> <summary> <para> <para> The CIDR block that you provide to create a VLAN subnet. VLAN CIDR blocks must not overlap with other subnets in the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.ExpansionVlan2_Cidr"> <summary> <para> <para> The CIDR block that you provide to create a VLAN subnet. VLAN CIDR blocks must not overlap with other subnets in the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.Hcx_Cidr"> <summary> <para> <para> The CIDR block that you provide to create a VLAN subnet. VLAN CIDR blocks must not overlap with other subnets in the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.NsxUplink_Cidr"> <summary> <para> <para> The CIDR block that you provide to create a VLAN subnet. VLAN CIDR blocks must not overlap with other subnets in the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VmkManagement_Cidr"> <summary> <para> <para> The CIDR block that you provide to create a VLAN subnet. VLAN CIDR blocks must not overlap with other subnets in the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VmManagement_Cidr"> <summary> <para> <para> The CIDR block that you provide to create a VLAN subnet. VLAN CIDR blocks must not overlap with other subnets in the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VMotion_Cidr"> <summary> <para> <para> The CIDR block that you provide to create a VLAN subnet. VLAN CIDR blocks must not overlap with other subnets in the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VSan_Cidr"> <summary> <para> <para> The CIDR block that you provide to create a VLAN subnet. VLAN CIDR blocks must not overlap with other subnets in the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VTep_Cidr"> <summary> <para> <para> The CIDR block that you provide to create a VLAN subnet. VLAN CIDR blocks must not overlap with other subnets in the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VcfHostnames_CloudBuilder"> <summary> <para> <para>The hostname for VMware Cloud Builder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.EnvironmentName"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.Hosts"> <summary> <para> <para>The ESXi hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation.</para><para>For each host, you must provide the desired hostname, EC2 SSH key, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.KmsKeyId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.LicenseInfo"> <summary> <para> <para>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. VCF licenses must have sufficient core entitlements to cover vCPU core and vSAN storage capacity needs.</para><para>VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.</para><para>VCF license information can be retrieved from the Broadcom portal.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VcfHostnames_Nsx"> <summary> <para> <para>The VMware NSX hostname.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VcfHostnames_NsxEdge1"> <summary> <para> <para>The hostname for the first NSX Edge node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VcfHostnames_NsxEdge2"> <summary> <para> <para>The hostname for the second NSX Edge node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VcfHostnames_NsxManager1"> <summary> <para> <para>The hostname for the first VMware NSX Manager virtual machine (VM).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VcfHostnames_NsxManager2"> <summary> <para> <para>The hostname for the second VMware NSX Manager virtual machine (VM).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VcfHostnames_NsxManager3"> <summary> <para> <para>The hostname for the third VMware NSX Manager virtual machine (VM).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.ConnectivityInfo_PrivateRouteServerPeering"> <summary> <para> <para>The unique IDs for private route server peers.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VcfHostnames_SddcManager"> <summary> <para> <para>The hostname for SDDC Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.ServiceAccessSecurityGroups_SecurityGroup"> <summary> <para> <para>The security groups that allow service access.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.ServiceAccessSubnetId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.SiteId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.Tag"> <summary> <para> <para>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.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.TermsAccepted"> <summary> <para> <para>Customer confirmation that the customer has purchased and maintains sufficient VCF software licenses to cover all physical processor cores in the environment, in compliance with VMware's licensing requirements and terms of use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VcfHostnames_VCenter"> <summary> <para> <para>The VMware vCenter hostname.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VcfVersion"> <summary> <para> <para> The VCF version to use for the environment. Amazon EVS only supports VCF version 5.2.1 at this time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.VpcId"> <summary> <para> <para>A unique ID for the VPC that connects to the environment control plane for service access.</para><para>Amazon EVS requires that all VPC subnets exist in a single Availability Zone in a Region where the service is available.</para><para>The VPC that you select 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.</para><para>If you plan to use HCX over the internet, choose a VPC that has a primary CIDR block and a /28 secondary CIDR block from an IPAM pool. Make sure that your VPC also has an attached internet gateway.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.ClientToken"> <summary> <para> <para><note><para>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</para></note><para>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.</para></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Evs.Model.CreateEnvironmentResponse). Specifying the name of a property of type Amazon.Evs.Model.CreateEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentHostCmdlet"> <summary> Creates an ESXi host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment. <para> This action can only be used after the Amazon EVS environment is deployed. All Amazon EVS hosts are created with the latest AMI release version for the respective VCF version of the environment. </para><para> You can use the <c>dedicatedHostId</c> parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation. </para><para> You can use the <c>placementGroupId</c> parameter to specify a cluster or partition placement group to launch EC2 instances into. </para><note><para> You cannot use the <c>dedicatedHostId</c> and <c>placementGroupId</c> parameters together in the same <c>CreateEnvironmentHost</c> action. This results in a <c>ValidationException</c> response. </para></note><note><para> EC2 instances created through Amazon EVS do not support associating an IAM instance profile. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentHostCmdlet.Host_DedicatedHostId"> <summary> <para> <para>The unique ID of the Amazon EC2 Dedicated Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentHostCmdlet.EnvironmentId"> <summary> <para> <para>A unique ID for the environment that the host is added to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentHostCmdlet.Host_HostName"> <summary> <para> <para>The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentHostCmdlet.Host_InstanceType"> <summary> <para> <para>The EC2 instance type that represents the host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentHostCmdlet.Host_KeyName"> <summary> <para> <para>The name of the SSH key that is used to access the host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentHostCmdlet.Host_PlacementGroupId"> <summary> <para> <para>The unique ID of the placement group where the host is placed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentHostCmdlet.ClientToken"> <summary> <para> <para><note><para>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</para></note><para>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.</para></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentHostCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Evs.Model.CreateEnvironmentHostResponse). Specifying the name of a property of type Amazon.Evs.Model.CreateEnvironmentHostResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.NewEVSEnvironmentHostCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSEnvironmentCmdlet"> <summary> Deletes an Amazon EVS environment. <para> Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the <c>DeleteEnvironmentHost</c> action. </para><para> Environment deletion also deletes the associated Amazon EVS VLAN subnets. Other associated Amazon Web Services resources are not deleted. These resources may continue to incur costs. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSEnvironmentCmdlet.EnvironmentId"> <summary> <para> <para>A unique ID associated with the environment to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSEnvironmentCmdlet.ClientToken"> <summary> <para> <para><note><para>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</para></note><para>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.</para></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Evs.Model.DeleteEnvironmentResponse). Specifying the name of a property of type Amazon.Evs.Model.DeleteEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSEnvironmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSEnvironmentHostCmdlet"> <summary> Deletes a host from an Amazon EVS environment. <note><para> 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. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSEnvironmentHostCmdlet.EnvironmentId"> <summary> <para> <para>A unique ID for the host's environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSEnvironmentHostCmdlet.HostName"> <summary> <para> <para>The DNS hostname associated with the host to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSEnvironmentHostCmdlet.ClientToken"> <summary> <para> <para><note><para>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</para></note><para>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.</para></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSEnvironmentHostCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Evs.Model.DeleteEnvironmentHostResponse). Specifying the name of a property of type Amazon.Evs.Model.DeleteEnvironmentHostResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSEnvironmentHostCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSResourceTagCmdlet"> <summary> Deletes specified tags from an Amazon EVS resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to delete tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to delete.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Evs.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EVS.RemoveEVSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |