Package com.pulumi.aws.workspaces

Class Pool

  • public class Pool
extends com.pulumi.resources.CustomResource
    Manages a WorkSpaces Pool in the AWS WorkSpaces service. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.workspaces.WorkspacesFunctions;
 import com.pulumi.aws.workspaces.inputs.GetBundleArgs;
 import com.pulumi.aws.workspaces.Directory;
 import com.pulumi.aws.workspaces.DirectoryArgs;
 import com.pulumi.aws.workspaces.Pool;
 import com.pulumi.aws.workspaces.PoolArgs;
 import com.pulumi.aws.workspaces.inputs.PoolCapacityArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         final var example = WorkspacesFunctions.getBundle(GetBundleArgs.builder()
             .owner("AMAZON")
             .name("Standard with Windows 10 (Server 2022 based) (WSP)")
             .build());
 
         var exampleDirectory = new Directory("exampleDirectory", DirectoryArgs.builder()
             .subnetIds(            
                 exampleC.id(),
                 exampleD.id())
             .workspaceType("POOLS")
             .workspaceDirectoryName("example-directory")
             .workspaceDirectoryDescription("Example WorkSpaces Directory for Pools")
             .userIdentityType("CUSTOMER_MANAGED")
             .build());
 
         var examplePool = new Pool("examplePool", PoolArgs.builder()
             .capacity(PoolCapacityArgs.builder()
                 .desiredUserSessions(10)
                 .build())
             .bundleId(example.id())
             .poolName("example-pool")
             .description("Example WorkSpaces Pool")
             .directoryId(exampleDirectory.directoryId())
             .runningMode("AUTO_STOP")
             .build());
 
     }
 }
    ### With Application Settings 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.workspaces.Pool;
 import com.pulumi.aws.workspaces.PoolArgs;
 import com.pulumi.aws.workspaces.inputs.PoolCapacityArgs;
 import com.pulumi.aws.workspaces.inputs.PoolApplicationSettingArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new Pool("example", PoolArgs.builder()
             .capacity(PoolCapacityArgs.builder()
                 .desiredUserSessions(10)
                 .build())
             .bundleId(exampleAwsWorkspacesBundle.id())
             .poolName("example-pool")
             .description("Example WorkSpaces Pool with Application Settings")
             .directoryId(exampleAwsWorkspacesDirectory.directoryId())
             .runningMode("AUTO_STOP")
             .applicationSettings(PoolApplicationSettingArgs.builder()
                 .status("ENABLED")
                 .settingsGroup("my-settings-group")
                 .build())
             .build());
 
     }
 }
    ### With Timeout Settings 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.workspaces.Pool;
 import com.pulumi.aws.workspaces.PoolArgs;
 import com.pulumi.aws.workspaces.inputs.PoolCapacityArgs;
 import com.pulumi.aws.workspaces.inputs.PoolTimeoutSettingArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new Pool("example", PoolArgs.builder()
             .capacity(PoolCapacityArgs.builder()
                 .desiredUserSessions(10)
                 .build())
             .bundleId(exampleAwsWorkspacesBundle.id())
             .poolName("example-pool")
             .description("Example WorkSpaces Pool with Timeout Settings")
             .directoryId(exampleAwsWorkspacesDirectory.directoryId())
             .runningMode("AUTO_STOP")
             .timeoutSettings(PoolTimeoutSettingArgs.builder()
                 .disconnectTimeoutInSeconds(900)
                 .idleDisconnectTimeoutInSeconds(900)
                 .maxUserDurationInSeconds(14400)
                 .build())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import WorkSpaces Pool using the pool ID. For example: ```sh $ pulumi import aws:workspaces/pool:Pool example wspool-12345678 ``` ### Identity Schema #### Required * `poolId` (String) WorkSpaces Pool identifier. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Pool​(java.lang.String name)  
      Pool​(java.lang.String name, PoolArgs args)  
      Pool​(java.lang.String name, PoolArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.List<PoolApplicationSetting>> applicationSettings()  
      com.pulumi.core.Output<java.lang.String> bundleId()  
      com.pulumi.core.Output<java.util.Optional<PoolCapacity>> capacity()  
      com.pulumi.core.Output<java.util.List<PoolCapacityStatus>> capacityStatuses()  
      com.pulumi.core.Output<java.lang.String> createdAt()  
      com.pulumi.core.Output<java.lang.String> description()  
      com.pulumi.core.Output<java.lang.String> directoryId()  
      static Pool get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PoolState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> poolArn()  
      com.pulumi.core.Output<java.lang.String> poolId()  
      com.pulumi.core.Output<java.lang.String> poolName()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> runningMode()  
      com.pulumi.core.Output<java.lang.String> s3BucketName()  
      com.pulumi.core.Output<java.lang.String> state()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<PoolTimeouts>> timeouts()  
      com.pulumi.core.Output<java.util.List<PoolTimeoutSetting>> timeoutSettings()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Pool

        public Pool​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Pool

        public Pool​(java.lang.String name,
            PoolArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Pool

        public Pool​(java.lang.String name,
            PoolArgs args,
            @Nullable
            com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • applicationSettings

        public com.pulumi.core.Output<java.util.List<PoolApplicationSetting>> applicationSettings()
        Returns:
        Application settings configuration for the WorkSpaces Pool. See `applicationSettings` Block below.

      • bundleId

        public com.pulumi.core.Output<java.lang.String> bundleId()
        Returns:
        ID of the bundle for the WorkSpaces Pool.

      • capacity

        public com.pulumi.core.Output<java.util.Optional<PoolCapacity>> capacity()
        Returns:
        Capacity configuration for the WorkSpaces Pool. See `capacity` below.

      • capacityStatuses

        public com.pulumi.core.Output<java.util.List<PoolCapacityStatus>> capacityStatuses()
        Returns:
        Capacity status of the WorkSpaces Pool. See `capacityStatus` Block below.

      • createdAt

        public com.pulumi.core.Output<java.lang.String> createdAt()
        Returns:
        Date and time the WorkSpaces Pool was created.

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        Description of the WorkSpaces Pool.

      • directoryId

        public com.pulumi.core.Output<java.lang.String> directoryId()
        Returns:
        ID of the directory for the WorkSpaces Pool.

      • poolArn

        public com.pulumi.core.Output<java.lang.String> poolArn()
        Returns:
        ARN of the WorkSpaces Pool.

      • poolId

        public com.pulumi.core.Output<java.lang.String> poolId()
        Returns:
        ID of the WorkSpaces Pool.

      • poolName

        public com.pulumi.core.Output<java.lang.String> poolName()
        Returns:
        Name of the WorkSpaces Pool. This cannot be changed after creation.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • runningMode

        public com.pulumi.core.Output<java.lang.String> runningMode()
        Returns:
        Running mode of the WorkSpaces Pool. Valid values are `AUTO_STOP` and `ALWAYS_ON`. The following arguments are optional:

      • s3BucketName

        public com.pulumi.core.Output<java.lang.String> s3BucketName()
        Returns:
        S3 bucket where application settings are stored when `applicationSettings` is enabled.

      • state

        public com.pulumi.core.Output<java.lang.String> state()
        Returns:
        Current state of the WorkSpaces Pool.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • timeoutSettings

        public com.pulumi.core.Output<java.util.List<PoolTimeoutSetting>> timeoutSettings()
        Returns:
        Timeout settings configuration for the WorkSpaces Pool. See `timeoutSettings` Block below.

      • timeouts

        public com.pulumi.core.Output<java.util.Optional<PoolTimeouts>> timeouts()

      • get

        public static Pool get​(java.lang.String name,
                       com.pulumi.core.Output<java.lang.String> id,
                       @Nullable
                       PoolState state,
                       @Nullable
                       com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.