import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateWorkspaceInstanceRequest, CreateWorkspaceInstanceResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateWorkspaceInstanceCommand}. */ export interface CreateWorkspaceInstanceCommandInput extends CreateWorkspaceInstanceRequest { } /** * @public * * The output of {@link CreateWorkspaceInstanceCommand}. */ export interface CreateWorkspaceInstanceCommandOutput extends CreateWorkspaceInstanceResponse, __MetadataBearer { } declare const CreateWorkspaceInstanceCommand_base: { new (input: CreateWorkspaceInstanceCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateWorkspaceInstanceCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { WorkspacesInstancesClient, CreateWorkspaceInstanceCommand } from "@aws-sdk/client-workspaces-instances"; // ES Modules import * // const { WorkspacesInstancesClient, CreateWorkspaceInstanceCommand } = require("@aws-sdk/client-workspaces-instances"); // CommonJS import * // import type { WorkspacesInstancesClientConfig } from "@aws-sdk/client-workspaces-instances"; * const config = {}; // type is WorkspacesInstancesClientConfig * const client = new WorkspacesInstancesClient(config); * const input = { // CreateWorkspaceInstanceRequest * ClientToken: "STRING_VALUE", * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", * Value: "STRING_VALUE", * }, * ], * ManagedInstance: { // ManagedInstanceRequest * BlockDeviceMappings: [ // BlockDeviceMappings * { // BlockDeviceMappingRequest * DeviceName: "STRING_VALUE", * Ebs: { // EbsBlockDevice * VolumeType: "standard" || "io1" || "io2" || "gp2" || "sc1" || "st1" || "gp3", * Encrypted: true || false, * KmsKeyId: "STRING_VALUE", * Iops: Number("int"), * Throughput: Number("int"), * VolumeSize: Number("int"), * }, * NoDevice: "STRING_VALUE", * VirtualName: "STRING_VALUE", * }, * ], * CapacityReservationSpecification: { // CapacityReservationSpecification * CapacityReservationPreference: "capacity-reservations-only" || "open" || "none", * CapacityReservationTarget: { // CapacityReservationTarget * CapacityReservationId: "STRING_VALUE", * CapacityReservationResourceGroupArn: "STRING_VALUE", * }, * }, * CpuOptions: { // CpuOptionsRequest * AmdSevSnp: "enabled" || "disabled", * CoreCount: Number("int"), * ThreadsPerCore: Number("int"), * NestedVirtualization: "enabled" || "disabled", * }, * CreditSpecification: { // CreditSpecificationRequest * CpuCredits: "standard" || "unlimited", * }, * DisableApiStop: true || false, * EbsOptimized: true || false, * EnablePrimaryIpv6: true || false, * EnclaveOptions: { // EnclaveOptionsRequest * Enabled: true || false, * }, * HibernationOptions: { // HibernationOptionsRequest * Configured: true || false, * }, * IamInstanceProfile: { // IamInstanceProfileSpecification * Arn: "STRING_VALUE", * Name: "STRING_VALUE", * }, * ImageId: "STRING_VALUE", * InstanceMarketOptions: { // InstanceMarketOptionsRequest * MarketType: "spot" || "capacity-block", * SpotOptions: { // SpotMarketOptions * BlockDurationMinutes: Number("int"), * InstanceInterruptionBehavior: "hibernate" || "stop", * MaxPrice: "STRING_VALUE", * SpotInstanceType: "one-time" || "persistent", * ValidUntilUtc: new Date("TIMESTAMP"), * }, * }, * InstanceType: "STRING_VALUE", * Ipv6Addresses: [ // Ipv6Addresses * { // InstanceIpv6Address * Ipv6Address: "STRING_VALUE", * IsPrimaryIpv6: true || false, * }, * ], * Ipv6AddressCount: Number("int"), * KernelId: "STRING_VALUE", * KeyName: "STRING_VALUE", * LicenseSpecifications: [ // LicenseSpecifications * { // LicenseConfigurationRequest * LicenseConfigurationArn: "STRING_VALUE", * }, * ], * MaintenanceOptions: { // InstanceMaintenanceOptionsRequest * AutoRecovery: "disabled" || "default", * }, * MetadataOptions: { // InstanceMetadataOptionsRequest * HttpEndpoint: "enabled" || "disabled", * HttpProtocolIpv6: "enabled" || "disabled", * HttpPutResponseHopLimit: Number("int"), * HttpTokens: "optional" || "required", * InstanceMetadataTags: "enabled" || "disabled", * }, * Monitoring: { // RunInstancesMonitoringEnabled * Enabled: true || false, * }, * NetworkInterfaces: [ // NetworkInterfaces * { // InstanceNetworkInterfaceSpecification * AssociateCarrierIpAddress: true || false, * AssociatePublicIpAddress: true || false, * ConnectionTrackingSpecification: { // ConnectionTrackingSpecificationRequest * TcpEstablishedTimeout: Number("int"), * UdpStreamTimeout: Number("int"), * UdpTimeout: Number("int"), * }, * Description: "STRING_VALUE", * DeviceIndex: Number("int"), * EnaSrdSpecification: { // EnaSrdSpecificationRequest * EnaSrdEnabled: true || false, * EnaSrdUdpSpecification: { // EnaSrdUdpSpecificationRequest * EnaSrdUdpEnabled: true || false, * }, * }, * InterfaceType: "interface" || "efa" || "efa-only", * Ipv4Prefixes: [ // Ipv4Prefixes * { // Ipv4PrefixSpecificationRequest * Ipv4Prefix: "STRING_VALUE", * }, * ], * Ipv4PrefixCount: Number("int"), * Ipv6AddressCount: Number("int"), * Ipv6Addresses: [ * { * Ipv6Address: "STRING_VALUE", * IsPrimaryIpv6: true || false, * }, * ], * Ipv6Prefixes: [ // Ipv6Prefixes * { // Ipv6PrefixSpecificationRequest * Ipv6Prefix: "STRING_VALUE", * }, * ], * Ipv6PrefixCount: Number("int"), * NetworkCardIndex: Number("int"), * NetworkInterfaceId: "STRING_VALUE", * PrimaryIpv6: true || false, * PrivateIpAddress: "STRING_VALUE", * PrivateIpAddresses: [ // PrivateIpAddresses * { // PrivateIpAddressSpecification * Primary: true || false, * PrivateIpAddress: "STRING_VALUE", * }, * ], * SecondaryPrivateIpAddressCount: Number("int"), * Groups: [ // SecurityGroupIds * "STRING_VALUE", * ], * SubnetId: "STRING_VALUE", * }, * ], * NetworkPerformanceOptions: { // InstanceNetworkPerformanceOptionsRequest * BandwidthWeighting: "default" || "vpc-1" || "ebs-1", * }, * Placement: { // Placement * Affinity: "STRING_VALUE", * AvailabilityZone: "STRING_VALUE", * GroupId: "STRING_VALUE", * GroupName: "STRING_VALUE", * HostId: "STRING_VALUE", * HostResourceGroupArn: "STRING_VALUE", * PartitionNumber: Number("int"), * Tenancy: "default" || "dedicated" || "host", * }, * PrivateDnsNameOptions: { // PrivateDnsNameOptionsRequest * HostnameType: "ip-name" || "resource-name", * EnableResourceNameDnsARecord: true || false, * EnableResourceNameDnsAAAARecord: true || false, * }, * PrivateIpAddress: "STRING_VALUE", * RamdiskId: "STRING_VALUE", * SecurityGroupIds: [ * "STRING_VALUE", * ], * SecurityGroups: [ // SecurityGroupNames * "STRING_VALUE", * ], * SubnetId: "STRING_VALUE", * TagSpecifications: [ // TagSpecifications * { // TagSpecification * ResourceType: "instance" || "volume" || "spot-instances-request" || "network-interface", * Tags: [ * { * Key: "STRING_VALUE", * Value: "STRING_VALUE", * }, * ], * }, * ], * UserData: "STRING_VALUE", * }, * BillingConfiguration: { // BillingConfiguration * BillingMode: "MONTHLY" || "HOURLY", // required * }, * }; * const command = new CreateWorkspaceInstanceCommand(input); * const response = await client.send(command); * // { // CreateWorkspaceInstanceResponse * // WorkspaceInstanceId: "STRING_VALUE", * // }; * * ``` * * @param CreateWorkspaceInstanceCommandInput - {@link CreateWorkspaceInstanceCommandInput} * @returns {@link CreateWorkspaceInstanceCommandOutput} * @see {@link CreateWorkspaceInstanceCommandInput} for command's `input` shape. * @see {@link CreateWorkspaceInstanceCommandOutput} for command's `response` shape. * @see {@link WorkspacesInstancesClientResolvedConfig | config} for WorkspacesInstancesClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Indicates insufficient permissions to perform the requested action.

* * @throws {@link ConflictException} (client fault) *

Signals a conflict with the current state of the resource.

* * @throws {@link InternalServerException} (server fault) *

Indicates an unexpected server-side error occurred.

* * @throws {@link ServiceQuotaExceededException} (client fault) *

Indicates that a service quota has been exceeded.

* * @throws {@link ThrottlingException} (client fault) *

Indicates the request rate has exceeded limits.

* * @throws {@link ValidationException} (client fault) *

Indicates invalid input parameters in the request.

* * @throws {@link WorkspacesInstancesServiceException} *

Base exception class for all service exceptions from WorkspacesInstances service.

* * * @public */ export declare class CreateWorkspaceInstanceCommand extends CreateWorkspaceInstanceCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateWorkspaceInstanceRequest; output: CreateWorkspaceInstanceResponse; }; sdk: { input: CreateWorkspaceInstanceCommandInput; output: CreateWorkspaceInstanceCommandOutput; }; }; }