AWS.Tools.WorkspacesInstances.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.WorkspacesInstances</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.WKSI.AddWKSIResourceTagCmdlet"> <summary> Adds tags to a WorkSpace Instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.AddWKSIResourceTagCmdlet.Tag"> <summary> <para> <para>Tags to be added to the WorkSpace Instance.</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.WKSI.AddWKSIResourceTagCmdlet.WorkspaceInstanceId"> <summary> <para> <para>Unique identifier of the WorkSpace Instance to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.AddWKSIResourceTagCmdlet.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.WorkspacesInstances.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.AddWKSIResourceTagCmdlet.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.WKSI.DismountWKSIVolumeCmdlet"> <summary> Detaches a volume from a WorkSpace Instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.DismountWKSIVolumeCmdlet.Device"> <summary> <para> <para>Device path of volume to detach.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.DismountWKSIVolumeCmdlet.DisassociateMode"> <summary> <para> <para>Mode for volume detachment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.DismountWKSIVolumeCmdlet.VolumeId"> <summary> <para> <para>Volume to be detached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.DismountWKSIVolumeCmdlet.WorkspaceInstanceId"> <summary> <para> <para>WorkSpace Instance to detach volume from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.DismountWKSIVolumeCmdlet.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.WorkspacesInstances.Model.DisassociateVolumeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.DismountWKSIVolumeCmdlet.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.WKSI.GetWKSIInstanceTypeListCmdlet"> <summary> Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.<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.WKSI.GetWKSIInstanceTypeListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of instance types to return in a single API call. Enables pagination of instance type results.</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.WKSI.GetWKSIInstanceTypeListCmdlet.NextToken"> <summary> <para> <para>Pagination token for retrieving subsequent pages of instance type results.</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.WKSI.GetWKSIInstanceTypeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InstanceTypes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkspacesInstances.Model.ListInstanceTypesResponse). Specifying the name of a property of type Amazon.WorkspacesInstances.Model.ListInstanceTypesResponse 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.WKSI.GetWKSIInstanceTypeListCmdlet.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.WKSI.GetWKSIRegionListCmdlet"> <summary> Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.<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.WKSI.GetWKSIRegionListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of regions to return in a single API call. Enables pagination of region results.</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.WKSI.GetWKSIRegionListCmdlet.NextToken"> <summary> <para> <para>Pagination token for retrieving subsequent pages of region results.</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.WKSI.GetWKSIRegionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Regions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkspacesInstances.Model.ListRegionsResponse). Specifying the name of a property of type Amazon.WorkspacesInstances.Model.ListRegionsResponse 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.WKSI.GetWKSIRegionListCmdlet.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.WKSI.GetWKSIResourceTagCmdlet"> <summary> Retrieves tags for a WorkSpace Instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.GetWKSIResourceTagCmdlet.WorkspaceInstanceId"> <summary> <para> <para>Unique identifier of the WorkSpace Instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.GetWKSIResourceTagCmdlet.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.WorkspacesInstances.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.WorkspacesInstances.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.WKSI.GetWKSIWorkspaceInstanceCmdlet"> <summary> Retrieves detailed information about a specific WorkSpace Instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.GetWKSIWorkspaceInstanceCmdlet.WorkspaceInstanceId"> <summary> <para> <para>Unique identifier of the WorkSpace Instance to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.GetWKSIWorkspaceInstanceCmdlet.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.WorkspacesInstances.Model.GetWorkspaceInstanceResponse). Specifying the name of a property of type Amazon.WorkspacesInstances.Model.GetWorkspaceInstanceResponse 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.WKSI.GetWKSIWorkspaceInstanceListCmdlet"> <summary> Retrieves a collection of WorkSpaces Instances based on specified filters.<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.WKSI.GetWKSIWorkspaceInstanceListCmdlet.ProvisionState"> <summary> <para> <para>Filter WorkSpaces Instances by their current provisioning states.</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.WKSI.GetWKSIWorkspaceInstanceListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of WorkSpaces Instances to return in a single response.</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.WKSI.GetWKSIWorkspaceInstanceListCmdlet.NextToken"> <summary> <para> <para>Pagination token for retrieving subsequent pages of WorkSpaces Instances.</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.WKSI.GetWKSIWorkspaceInstanceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkspaceInstances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkspacesInstances.Model.ListWorkspaceInstancesResponse). Specifying the name of a property of type Amazon.WorkspacesInstances.Model.ListWorkspaceInstancesResponse 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.WKSI.GetWKSIWorkspaceInstanceListCmdlet.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.WKSI.MountWKSIVolumeCmdlet"> <summary> Attaches a volume to a WorkSpace Instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.MountWKSIVolumeCmdlet.Device"> <summary> <para> <para>Device path for volume attachment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.MountWKSIVolumeCmdlet.VolumeId"> <summary> <para> <para>Volume to be attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.MountWKSIVolumeCmdlet.WorkspaceInstanceId"> <summary> <para> <para>WorkSpace Instance to attach volume to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.MountWKSIVolumeCmdlet.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.WorkspacesInstances.Model.AssociateVolumeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.MountWKSIVolumeCmdlet.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.WKSI.NewWKSIVolumeCmdlet"> <summary> Creates a new volume for WorkSpace Instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIVolumeCmdlet.AvailabilityZone"> <summary> <para> <para>Availability zone for the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIVolumeCmdlet.Encrypted"> <summary> <para> <para>Indicates if the volume should be encrypted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIVolumeCmdlet.Iops"> <summary> <para> <para>Input/output operations per second for the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIVolumeCmdlet.KmsKeyId"> <summary> <para> <para>KMS key for volume encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIVolumeCmdlet.SizeInGB"> <summary> <para> <para>Volume size in gigabytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIVolumeCmdlet.SnapshotId"> <summary> <para> <para>Source snapshot for volume creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIVolumeCmdlet.TagSpecification"> <summary> <para> <para>Metadata tags for the volume.</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.WKSI.NewWKSIVolumeCmdlet.Throughput"> <summary> <para> <para>Volume throughput performance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIVolumeCmdlet.VolumeType"> <summary> <para> <para>Type of EBS volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIVolumeCmdlet.ClientToken"> <summary> <para> <para>Unique token to prevent duplicate volume creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIVolumeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VolumeId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkspacesInstances.Model.CreateVolumeResponse). Specifying the name of a property of type Amazon.WorkspacesInstances.Model.CreateVolumeResponse 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.WKSI.NewWKSIVolumeCmdlet.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.WKSI.NewWKSIWorkspaceInstanceCmdlet"> <summary> Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.Placement_Affinity"> <summary> <para> <para>Specifies host affinity for dedicated instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.CpuOptions_AmdSevSnp"> <summary> <para> <para>AMD Secure Encrypted Virtualization configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.IamInstanceProfile_Arn"> <summary> <para> <para>Amazon Resource Name (ARN) of the IAM instance profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.MaintenanceOptions_AutoRecovery"> <summary> <para> <para>Enables or disables automatic instance recovery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.Placement_AvailabilityZone"> <summary> <para> <para>Identifies the specific AWS availability zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.NetworkPerformanceOptions_BandwidthWeighting"> <summary> <para> <para>Defines bandwidth allocation strategy for network interfaces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_BlockDeviceMapping"> <summary> <para> <para>Configures block device mappings for storage.</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.WKSI.NewWKSIWorkspaceInstanceCmdlet.SpotOptions_BlockDurationMinute"> <summary> <para> <para>Duration of spot instance block reservation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.CapacityReservationTarget_CapacityReservationId"> <summary> <para> <para>Unique identifier for the capacity reservation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.CapacityReservationSpecification_CapacityReservationPreference"> <summary> <para> <para>Preference for using capacity reservation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.CapacityReservationTarget_CapacityReservationResourceGroupArn"> <summary> <para> <para>ARN of the capacity reservation resource group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.HibernationOptions_Configured"> <summary> <para> <para>Enables or disables instance hibernation capability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.CpuOptions_CoreCount"> <summary> <para> <para>Number of CPU cores to allocate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.CreditSpecification_CpuCredit"> <summary> <para> <para>CPU credit specification mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_DisableApiStop"> <summary> <para> <para>Prevents API-initiated instance stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_EbsOptimized"> <summary> <para> <para>Enables optimized EBS performance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.EnclaveOptions_Enabled"> <summary> <para> <para>Enables or disables AWS Nitro Enclaves for enhanced security.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.Monitoring_Enabled"> <summary> <para> <para>Enables or disables detailed instance monitoring.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_EnablePrimaryIpv6"> <summary> <para> <para>Enables primary IPv6 address configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.PrivateDnsNameOptions_EnableResourceNameDnsAAAARecord"> <summary> <para> <para>Enables DNS AAAA record for resource name resolution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.PrivateDnsNameOptions_EnableResourceNameDnsARecord"> <summary> <para> <para>Enables DNS A record for resource name resolution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.Placement_GroupId"> <summary> <para> <para>Unique identifier for placement group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.Placement_GroupName"> <summary> <para> <para>Name of the placement group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.Placement_HostId"> <summary> <para> <para>Identifies the specific dedicated host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.PrivateDnsNameOptions_HostnameType"> <summary> <para> <para>Specifies the type of hostname configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.Placement_HostResourceGroupArn"> <summary> <para> <para>ARN of the host resource group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.MetadataOptions_HttpEndpoint"> <summary> <para> <para>Enables or disables HTTP endpoint for instance metadata.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.MetadataOptions_HttpProtocolIpv6"> <summary> <para> <para>Configures IPv6 support for instance metadata HTTP protocol.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.MetadataOptions_HttpPutResponseHopLimit"> <summary> <para> <para>Sets maximum number of network hops for metadata PUT responses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.MetadataOptions_HttpToken"> <summary> <para> <para>Configures token requirement for instance metadata retrieval.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_ImageId"> <summary> <para> <para>Identifies the Amazon Machine Image (AMI) for the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.SpotOptions_InstanceInterruptionBehavior"> <summary> <para> <para>Specifies behavior when spot instance is interrupted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.MetadataOptions_InstanceMetadataTag"> <summary> <para> <para>Enables or disables instance metadata tags retrieval.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_InstanceType"> <summary> <para> <para>Specifies the WorkSpace Instance type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_Ipv6AddressCount"> <summary> <para> <para>Specifies number of IPv6 addresses to assign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_Ipv6Address"> <summary> <para> <para>Configures specific IPv6 addresses.</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.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_KernelId"> <summary> <para> <para>Identifies the kernel for the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_KeyName"> <summary> <para> <para>Specifies the key pair for instance access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_LicenseSpecification"> <summary> <para> <para>Configures license-related settings.</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.WKSI.NewWKSIWorkspaceInstanceCmdlet.InstanceMarketOptions_MarketType"> <summary> <para> <para>Specifies the type of marketplace for instance deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.SpotOptions_MaxPrice"> <summary> <para> <para>Maximum hourly price for spot instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.IamInstanceProfile_Name"> <summary> <para> <para>Name of the IAM instance profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_NetworkInterface"> <summary> <para> <para>Configures network interface settings.</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.WKSI.NewWKSIWorkspaceInstanceCmdlet.Placement_PartitionNumber"> <summary> <para> <para>Specifies partition number for partition placement groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_PrivateIpAddress"> <summary> <para> <para>Specifies the primary private IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_RamdiskId"> <summary> <para> <para>Identifies the ramdisk for the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_SecurityGroupId"> <summary> <para> <para>Specifies security group identifiers.</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.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_SecurityGroup"> <summary> <para> <para>Configures security group settings.</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.WKSI.NewWKSIWorkspaceInstanceCmdlet.SpotOptions_SpotInstanceType"> <summary> <para> <para>Defines the type of spot instance request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_SubnetId"> <summary> <para> <para>Identifies the subnet for the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.Tag"> <summary> <para> <para>Optional metadata tags for categorizing and managing WorkSpaces Instances.</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.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_TagSpecification"> <summary> <para> <para>Configures resource tagging specifications.</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.WKSI.NewWKSIWorkspaceInstanceCmdlet.Placement_Tenancy"> <summary> <para> <para>Defines instance tenancy configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.CpuOptions_ThreadsPerCore"> <summary> <para> <para>Number of threads per CPU core.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ManagedInstance_UserData"> <summary> <para> <para>Provides custom initialization data for the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.SpotOptions_ValidUntilUtc"> <summary> <para> <para>Timestamp until which spot instance request is valid.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.ClientToken"> <summary> <para> <para>Unique token to ensure idempotent instance creation, preventing duplicate workspace launches.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.NewWKSIWorkspaceInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkspaceInstanceId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkspacesInstances.Model.CreateWorkspaceInstanceResponse). Specifying the name of a property of type Amazon.WorkspacesInstances.Model.CreateWorkspaceInstanceResponse 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.WKSI.NewWKSIWorkspaceInstanceCmdlet.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.WKSI.RemoveWKSIResourceTagCmdlet"> <summary> Removes tags from a WorkSpace Instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.RemoveWKSIResourceTagCmdlet.TagKey"> <summary> <para> <para>Keys of tags to be removed.</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.WKSI.RemoveWKSIResourceTagCmdlet.WorkspaceInstanceId"> <summary> <para> <para>Unique identifier of the WorkSpace Instance to untag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.RemoveWKSIResourceTagCmdlet.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.WorkspacesInstances.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.RemoveWKSIResourceTagCmdlet.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.WKSI.RemoveWKSIVolumeCmdlet"> <summary> Deletes a specified volume. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.RemoveWKSIVolumeCmdlet.VolumeId"> <summary> <para> <para>Identifier of the volume to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.RemoveWKSIVolumeCmdlet.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.WorkspacesInstances.Model.DeleteVolumeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.RemoveWKSIVolumeCmdlet.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.WKSI.RemoveWKSIWorkspaceInstanceCmdlet"> <summary> Deletes the specified WorkSpace </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.RemoveWKSIWorkspaceInstanceCmdlet.WorkspaceInstanceId"> <summary> <para> <para>Unique identifier of the WorkSpaces Instance targeted for deletion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.RemoveWKSIWorkspaceInstanceCmdlet.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.WorkspacesInstances.Model.DeleteWorkspaceInstanceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKSI.RemoveWKSIWorkspaceInstanceCmdlet.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> |