AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Workspaces Instances CreateWorkspaceInstance API operation.

Syntax

New-WKSIWorkspaceInstance
-Placement_Affinity <String>
-CpuOptions_AmdSevSnp <AmdSevSnpEnum>
-IamInstanceProfile_Arn <String>
-MaintenanceOptions_AutoRecovery <AutoRecoveryEnum>
-Placement_AvailabilityZone <String>
-NetworkPerformanceOptions_BandwidthWeighting <BandwidthWeightingEnum>
-ManagedInstance_BlockDeviceMapping <BlockDeviceMappingRequest[]>
-SpotOptions_BlockDurationMinute <Int32>
-CapacityReservationTarget_CapacityReservationId <String>
-CapacityReservationSpecification_CapacityReservationPreference <CapacityReservationPreferenceEnum>
-CapacityReservationTarget_CapacityReservationResourceGroupArn <String>
-HibernationOptions_Configured <Boolean>
-CpuOptions_CoreCount <Int32>
-CreditSpecification_CpuCredit <CpuCreditsEnum>
-ManagedInstance_DisableApiStop <Boolean>
-ManagedInstance_EbsOptimized <Boolean>
-EnclaveOptions_Enabled <Boolean>
-Monitoring_Enabled <Boolean>
-ManagedInstance_EnablePrimaryIpv6 <Boolean>
-PrivateDnsNameOptions_EnableResourceNameDnsAAAARecord <Boolean>
-PrivateDnsNameOptions_EnableResourceNameDnsARecord <Boolean>
-Placement_GroupId <String>
-Placement_GroupName <String>
-Placement_HostId <String>
-PrivateDnsNameOptions_HostnameType <HostnameTypeEnum>
-Placement_HostResourceGroupArn <String>
-MetadataOptions_HttpEndpoint <HttpEndpointEnum>
-MetadataOptions_HttpProtocolIpv6 <HttpProtocolIpv6Enum>
-MetadataOptions_HttpPutResponseHopLimit <Int32>
-MetadataOptions_HttpToken <HttpTokensEnum>
-ManagedInstance_ImageId <String>
-SpotOptions_InstanceInterruptionBehavior <InstanceInterruptionBehaviorEnum>
-MetadataOptions_InstanceMetadataTag <InstanceMetadataTagsEnum>
-ManagedInstance_InstanceType <String>
-ManagedInstance_Ipv6AddressCount <Int32>
-ManagedInstance_Ipv6Address <InstanceIpv6Address[]>
-ManagedInstance_KernelId <String>
-ManagedInstance_KeyName <String>
-ManagedInstance_LicenseSpecification <LicenseConfigurationRequest[]>
-InstanceMarketOptions_MarketType <MarketTypeEnum>
-SpotOptions_MaxPrice <String>
-IamInstanceProfile_Name <String>
-ManagedInstance_NetworkInterface <InstanceNetworkInterfaceSpecification[]>
-Placement_PartitionNumber <Int32>
-ManagedInstance_PrivateIpAddress <String>
-ManagedInstance_RamdiskId <String>
-ManagedInstance_SecurityGroupId <String[]>
-ManagedInstance_SecurityGroup <String[]>
-SpotOptions_SpotInstanceType <SpotInstanceTypeEnum>
-ManagedInstance_SubnetId <String>
-Tag <Tag[]>
-ManagedInstance_TagSpecification <TagSpecification[]>
-Placement_Tenancy <TenancyEnum>
-CpuOptions_ThreadsPerCore <Int32>
-ManagedInstance_UserData <String>
-SpotOptions_ValidUntilUtc <DateTime>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonWorkspacesInstancesConfig>

Description

Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.

Parameters

-CapacityReservationSpecification_CapacityReservationPreference <CapacityReservationPreferenceEnum>
Preference for using capacity reservation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_CapacityReservationSpecification_CapacityReservationPreference
-CapacityReservationTarget_CapacityReservationId <String>
Unique identifier for the capacity reservation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_CapacityReservationSpecification_CapacityReservationTarget_CapacityReservationId
-CapacityReservationTarget_CapacityReservationResourceGroupArn <String>
ARN of the capacity reservation resource group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_CapacityReservationSpecification_CapacityReservationTarget_CapacityReservationResourceGroupArn
-ClientConfig <AmazonWorkspacesInstancesConfig>
Amazon.PowerShell.Cmdlets.WKSI.AmazonWorkspacesInstancesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Unique token to ensure idempotent instance creation, preventing duplicate workspace launches.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CpuOptions_AmdSevSnp <AmdSevSnpEnum>
AMD Secure Encrypted Virtualization configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_CpuOptions_AmdSevSnp
-CpuOptions_CoreCount <Int32>
Number of CPU cores to allocate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_CpuOptions_CoreCount
-CpuOptions_ThreadsPerCore <Int32>
Number of threads per CPU core.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_CpuOptions_ThreadsPerCore
-CreditSpecification_CpuCredit <CpuCreditsEnum>
CPU credit specification mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_CreditSpecification_CpuCredits
-EnclaveOptions_Enabled <Boolean>
Enables or disables AWS Nitro Enclaves for enhanced security.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_EnclaveOptions_Enabled
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HibernationOptions_Configured <Boolean>
Enables or disables instance hibernation capability.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_HibernationOptions_Configured
-IamInstanceProfile_Arn <String>
Amazon Resource Name (ARN) of the IAM instance profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_IamInstanceProfile_Arn
-IamInstanceProfile_Name <String>
Name of the IAM instance profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_IamInstanceProfile_Name
-InstanceMarketOptions_MarketType <MarketTypeEnum>
Specifies the type of marketplace for instance deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_InstanceMarketOptions_MarketType
-MaintenanceOptions_AutoRecovery <AutoRecoveryEnum>
Enables or disables automatic instance recovery.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_MaintenanceOptions_AutoRecovery
-ManagedInstance_BlockDeviceMapping <BlockDeviceMappingRequest[]>
Configures block device mappings for storage. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_BlockDeviceMappings
-ManagedInstance_DisableApiStop <Boolean>
Prevents API-initiated instance stop.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstance_EbsOptimized <Boolean>
Enables optimized EBS performance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstance_EnablePrimaryIpv6 <Boolean>
Enables primary IPv6 address configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstance_ImageId <String>
Identifies the Amazon Machine Image (AMI) for the instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstance_InstanceType <String>
Specifies the WorkSpace Instance type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstance_Ipv6Address <InstanceIpv6Address[]>
Configures specific IPv6 addresses. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_Ipv6Addresses
-ManagedInstance_Ipv6AddressCount <Int32>
Specifies number of IPv6 addresses to assign.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstance_KernelId <String>
Identifies the kernel for the instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstance_KeyName <String>
Specifies the key pair for instance access.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstance_LicenseSpecification <LicenseConfigurationRequest[]>
Configures license-related settings. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_LicenseSpecifications
-ManagedInstance_NetworkInterface <InstanceNetworkInterfaceSpecification[]>
Configures network interface settings. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_NetworkInterfaces
-ManagedInstance_PrivateIpAddress <String>
Specifies the primary private IP address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstance_RamdiskId <String>
Identifies the ramdisk for the instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstance_SecurityGroup <String[]>
Configures security group settings. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_SecurityGroups
-ManagedInstance_SecurityGroupId <String[]>
Specifies security group identifiers. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_SecurityGroupIds
-ManagedInstance_SubnetId <String>
Identifies the subnet for the instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstance_TagSpecification <TagSpecification[]>
Configures resource tagging specifications. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_TagSpecifications
-ManagedInstance_UserData <String>
Provides custom initialization data for the instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MetadataOptions_HttpEndpoint <HttpEndpointEnum>
Enables or disables HTTP endpoint for instance metadata.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_MetadataOptions_HttpEndpoint
-MetadataOptions_HttpProtocolIpv6 <HttpProtocolIpv6Enum>
Configures IPv6 support for instance metadata HTTP protocol.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_MetadataOptions_HttpProtocolIpv6
-MetadataOptions_HttpPutResponseHopLimit <Int32>
Sets maximum number of network hops for metadata PUT responses.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_MetadataOptions_HttpPutResponseHopLimit
-MetadataOptions_HttpToken <HttpTokensEnum>
Configures token requirement for instance metadata retrieval.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_MetadataOptions_HttpTokens
-MetadataOptions_InstanceMetadataTag <InstanceMetadataTagsEnum>
Enables or disables instance metadata tags retrieval.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_MetadataOptions_InstanceMetadataTags
-Monitoring_Enabled <Boolean>
Enables or disables detailed instance monitoring.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_Monitoring_Enabled
-NetworkPerformanceOptions_BandwidthWeighting <BandwidthWeightingEnum>
Defines bandwidth allocation strategy for network interfaces.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_NetworkPerformanceOptions_BandwidthWeighting
-Placement_Affinity <String>
Specifies host affinity for dedicated instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_Placement_Affinity
-Placement_AvailabilityZone <String>
Identifies the specific AWS availability zone.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_Placement_AvailabilityZone
-Placement_GroupId <String>
Unique identifier for placement group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_Placement_GroupId
-Placement_GroupName <String>
Name of the placement group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_Placement_GroupName
-Placement_HostId <String>
Identifies the specific dedicated host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_Placement_HostId
-Placement_HostResourceGroupArn <String>
ARN of the host resource group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_Placement_HostResourceGroupArn
-Placement_PartitionNumber <Int32>
Specifies partition number for partition placement groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_Placement_PartitionNumber
-Placement_Tenancy <TenancyEnum>
Defines instance tenancy configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_Placement_Tenancy
-PrivateDnsNameOptions_EnableResourceNameDnsAAAARecord <Boolean>
Enables DNS AAAA record for resource name resolution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_PrivateDnsNameOptions_EnableResourceNameDnsAAAARecord
-PrivateDnsNameOptions_EnableResourceNameDnsARecord <Boolean>
Enables DNS A record for resource name resolution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_PrivateDnsNameOptions_EnableResourceNameDnsARecord
-PrivateDnsNameOptions_HostnameType <HostnameTypeEnum>
Specifies the type of hostname configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_PrivateDnsNameOptions_HostnameType
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SpotOptions_BlockDurationMinute <Int32>
Duration of spot instance block reservation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_InstanceMarketOptions_SpotOptions_BlockDurationMinutes
-SpotOptions_InstanceInterruptionBehavior <InstanceInterruptionBehaviorEnum>
Specifies behavior when spot instance is interrupted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_InstanceMarketOptions_SpotOptions_InstanceInterruptionBehavior
-SpotOptions_MaxPrice <String>
Maximum hourly price for spot instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_InstanceMarketOptions_SpotOptions_MaxPrice
-SpotOptions_SpotInstanceType <SpotInstanceTypeEnum>
Defines the type of spot instance request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_InstanceMarketOptions_SpotOptions_SpotInstanceType
-SpotOptions_ValidUntilUtc <DateTime>
Timestamp until which spot instance request is valid.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstance_InstanceMarketOptions_SpotOptions_ValidUntilUtc
-Tag <Tag[]>
Optional metadata tags for categorizing and managing WorkSpaces Instances. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.WorkspacesInstances.Model.CreateWorkspaceInstanceResponse
This cmdlet returns a System.String object. The service call response (type Amazon.WorkspacesInstances.Model.CreateWorkspaceInstanceResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z