Package com.pulumi.aws.workspacesweb

Class Portal

  • public class Portal
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS WorkSpaces Web Portal. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.workspacesweb.Portal;
 import com.pulumi.aws.workspacesweb.PortalArgs;
 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 Portal("example", PortalArgs.builder()
             .displayName("example-portal")
             .instanceType("standard.regular")
             .build());
 
     }
 }
    ### Complete Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.kms.Key;
 import com.pulumi.aws.kms.KeyArgs;
 import com.pulumi.aws.workspacesweb.Portal;
 import com.pulumi.aws.workspacesweb.PortalArgs;
 import com.pulumi.resources.CustomResourceOptions;
 import com.pulumi.resources.CustomTimeouts;
 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 Key("example", KeyArgs.builder()
             .description("KMS key for WorkSpaces Web Portal")
             .deletionWindowInDays(7)
             .build());
 
         var examplePortal = new Portal("examplePortal", PortalArgs.builder()
             .displayName("example-portal")
             .instanceType("standard.large")
             .authenticationType("IAM_Identity_Center")
             .customerManagedKey(example.arn())
             .maxConcurrentSessions(10)
             .additionalEncryptionContext(Map.of("Environment", "Production"))
             .tags(Map.of("Name", "example-portal"))
             .build(), CustomResourceOptions.builder()
                 .customTimeouts(CustomTimeouts.builder()
                     .create(CustomTimeouts.parseTimeoutString("10m"))
                     .update(CustomTimeouts.parseTimeoutString("10m"))
                     .delete(CustomTimeouts.parseTimeoutString("10m"))
                 .build())
                 .build());
 
     }
 }
    ## Import Using `pulumi import`, import WorkSpaces Web Portal using the `portalArn`. For example: ```sh $ pulumi import aws:workspacesweb/portal:Portal example arn:aws:workspaces-web:us-west-2:123456789012:portal/abcdef12345678 ```

    • 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
      Portal​(java.lang.String name)  
      Portal​(java.lang.String name, PortalArgs args)  
      Portal​(java.lang.String name, PortalArgs 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.Optional<java.util.Map<java.lang.String,​java.lang.String>>> additionalEncryptionContext()  
      com.pulumi.core.Output<java.lang.String> authenticationType()  
      com.pulumi.core.Output<java.lang.String> browserSettingsArn()  
      com.pulumi.core.Output<java.lang.String> browserType()  
      com.pulumi.core.Output<java.lang.String> creationDate()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> customerManagedKey()  
      com.pulumi.core.Output<java.lang.String> dataProtectionSettingsArn()  
      com.pulumi.core.Output<java.lang.String> displayName()  
      static Portal get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PortalState 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> instanceType()  
      com.pulumi.core.Output<java.lang.String> ipAccessSettingsArn()  
      com.pulumi.core.Output<java.lang.Integer> maxConcurrentSessions()  
      com.pulumi.core.Output<java.lang.String> networkSettingsArn()  
      com.pulumi.core.Output<java.lang.String> portalArn()  
      com.pulumi.core.Output<java.lang.String> portalEndpoint()  
      com.pulumi.core.Output<java.lang.String> portalStatus()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> rendererType()  
      com.pulumi.core.Output<java.lang.String> sessionLoggerArn()  
      com.pulumi.core.Output<java.lang.String> statusReason()  
      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<PortalTimeouts>> timeouts()  
      com.pulumi.core.Output<java.lang.String> trustStoreArn()  
      com.pulumi.core.Output<java.lang.String> userAccessLoggingSettingsArn()  
      com.pulumi.core.Output<java.lang.String> userSettingsArn()  

      • 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

      • Portal

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

      • Portal

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

      • Portal

        public Portal​(java.lang.String name,
              @Nullable
              PortalArgs 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

      • additionalEncryptionContext

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> additionalEncryptionContext()
        Returns:
        Additional encryption context for the customer managed key. Forces replacement if changed.

      • authenticationType

        public com.pulumi.core.Output<java.lang.String> authenticationType()
        Returns:
        Authentication type for the portal. Valid values: `Standard`, `IAM_Identity_Center`.

      • browserSettingsArn

        public com.pulumi.core.Output<java.lang.String> browserSettingsArn()
        Returns:
        ARN of the browser settings to use for the portal.

      • browserType

        public com.pulumi.core.Output<java.lang.String> browserType()
        Returns:
        Browser type of the portal.

      • creationDate

        public com.pulumi.core.Output<java.lang.String> creationDate()
        Returns:
        Creation date of the portal.

      • customerManagedKey

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> customerManagedKey()
        Returns:
        ARN of the customer managed key. Forces replacement if changed.

      • dataProtectionSettingsArn

        public com.pulumi.core.Output<java.lang.String> dataProtectionSettingsArn()
        Returns:
        ARN of the data protection settings associated with the portal.

      • displayName

        public com.pulumi.core.Output<java.lang.String> displayName()
        Returns:
        Display name of the portal.

      • instanceType

        public com.pulumi.core.Output<java.lang.String> instanceType()
        Returns:
        Instance type for the portal. Valid values: `standard.regular`, `standard.large`.

      • ipAccessSettingsArn

        public com.pulumi.core.Output<java.lang.String> ipAccessSettingsArn()
        Returns:
        ARN of the IP access settings associated with the portal.

      • maxConcurrentSessions

        public com.pulumi.core.Output<java.lang.Integer> maxConcurrentSessions()
        Returns:
        Maximum number of concurrent sessions for the portal.

      • networkSettingsArn

        public com.pulumi.core.Output<java.lang.String> networkSettingsArn()
        Returns:
        ARN of the network settings associated with the portal.

      • portalArn

        public com.pulumi.core.Output<java.lang.String> portalArn()
        Returns:
        ARN of the portal.

      • portalEndpoint

        public com.pulumi.core.Output<java.lang.String> portalEndpoint()
        Returns:
        Endpoint URL of the portal.

      • portalStatus

        public com.pulumi.core.Output<java.lang.String> portalStatus()
        Returns:
        Status of the portal.

      • 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.

      • rendererType

        public com.pulumi.core.Output<java.lang.String> rendererType()
        Returns:
        Renderer type of the portal.

      • sessionLoggerArn

        public com.pulumi.core.Output<java.lang.String> sessionLoggerArn()
        Returns:
        ARN of the session logger associated with the portal.

      • statusReason

        public com.pulumi.core.Output<java.lang.String> statusReason()
        Returns:
        Reason for the current status of the portal.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. 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.

      • timeouts

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

      • trustStoreArn

        public com.pulumi.core.Output<java.lang.String> trustStoreArn()
        Returns:
        ARN of the trust store associated with the portal.

      • userAccessLoggingSettingsArn

        public com.pulumi.core.Output<java.lang.String> userAccessLoggingSettingsArn()
        Returns:
        ARN of the user access logging settings associated with the portal.

      • userSettingsArn

        public com.pulumi.core.Output<java.lang.String> userSettingsArn()
        Returns:
        ARN of the user settings associated with the portal.

      • get

        public static Portal get​(java.lang.String name,
                         com.pulumi.core.Output<java.lang.String> id,
                         @Nullable
                         PortalState 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.