Portal class

Resource for managing an AWS WorkSpaces Web Portal.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.workspacesweb.Portal("example", {
    displayName: "example-portal",
    instanceType: "standard.regular",
});
import pulumi
import pulumi_aws as aws

example = aws.workspacesweb.Portal("example",
    display_name="example-portal",
    instance_type="standard.regular")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.WorkSpacesWeb.Portal("example", new()
    {
        DisplayName = "example-portal",
        InstanceType = "standard.regular",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/workspacesweb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := workspacesweb.NewPortal(ctx, "example", &workspacesweb.PortalArgs{
			DisplayName:  pulumi.String("example-portal"),
			InstanceType: pulumi.String("standard.regular"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_workspacesweb_portal" "example" {
  display_name  = "example-portal"
  instance_type = "standard.regular"
}
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());

    }
}
resources:
  example:
    type: aws:workspacesweb:Portal
    properties:
      displayName: example-portal
      instanceType: standard.regular

Complete Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.kms.Key("example", {
    description: "KMS key for WorkSpaces Web Portal",
    deletionWindowInDays: 7,
});
const examplePortal = new aws.workspacesweb.Portal("example", {
    displayName: "example-portal",
    instanceType: "standard.large",
    authenticationType: "IAM_Identity_Center",
    customerManagedKey: example.arn,
    maxConcurrentSessions: 10,
    additionalEncryptionContext: {
        Environment: "Production",
    },
    tags: {
        Name: "example-portal",
    },
}, {
    customTimeouts: {
        create: "10m",
        update: "10m",
        "delete": "10m",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.kms.Key("example",
    description="KMS key for WorkSpaces Web Portal",
    deletion_window_in_days=7)
example_portal = aws.workspacesweb.Portal("example",
    display_name="example-portal",
    instance_type="standard.large",
    authentication_type="IAM_Identity_Center",
    customer_managed_key=example.arn,
    max_concurrent_sessions=10,
    additional_encryption_context={
        "Environment": "Production",
    },
    tags={
        "Name": "example-portal",
    },
    opts = pulumi.ResourceOptions(custom_timeouts=pulumi.CustomTimeouts(create="10m", update="10m", delete="10m")))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Kms.Key("example", new()
    {
        Description = "KMS key for WorkSpaces Web Portal",
        DeletionWindowInDays = 7,
    });

    var examplePortal = new Aws.WorkSpacesWeb.Portal("example", new()
    {
        DisplayName = "example-portal",
        InstanceType = "standard.large",
        AuthenticationType = "IAM_Identity_Center",
        CustomerManagedKey = example.Arn,
        MaxConcurrentSessions = 10,
        AdditionalEncryptionContext =
        {
            { "Environment", "Production" },
        },
        Tags =
        {
            { "Name", "example-portal" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kms"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/workspacesweb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := kms.NewKey(ctx, "example", &kms.KeyArgs{
			Description:          pulumi.String("KMS key for WorkSpaces Web Portal"),
			DeletionWindowInDays: pulumi.Int(7),
		})
		if err != nil {
			return err
		}
		_, err = workspacesweb.NewPortal(ctx, "example", &workspacesweb.PortalArgs{
			DisplayName:           pulumi.String("example-portal"),
			InstanceType:          pulumi.String("standard.large"),
			AuthenticationType:    pulumi.String("IAM_Identity_Center"),
			CustomerManagedKey:    example.Arn,
			MaxConcurrentSessions: pulumi.Int(10),
			AdditionalEncryptionContext: pulumi.StringMap{
				"Environment": pulumi.String("Production"),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example-portal"),
			},
		}, pulumi.Timeouts(&pulumi.CustomTimeouts{Create: "10m", Update: "10m", Delete: "10m"}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_kms_key" "example" {
  description             = "KMS key for WorkSpaces Web Portal"
  deletion_window_in_days = 7
}
resource "aws_workspacesweb_portal" "example" {
  timeouts {
    create = "10m"
    update = "10m"
    delete = "10m"
  }
  display_name            = "example-portal"
  instance_type           = "standard.large"
  authentication_type     = "IAM_Identity_Center"
  customer_managed_key    = aws_kms_key.example.arn
  max_concurrent_sessions = 10
  additional_encryption_context = {
    "Environment" = "Production"
  }
  tags = {
    "Name" = "example-portal"
  }
}
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());

    }
}
resources:
  example:
    type: aws:kms:Key
    properties:
      description: KMS key for WorkSpaces Web Portal
      deletionWindowInDays: 7
  examplePortal:
    type: aws:workspacesweb:Portal
    name: example
    properties:
      displayName: example-portal
      instanceType: standard.large
      authenticationType: IAM_Identity_Center
      customerManagedKey: ${example.arn}
      maxConcurrentSessions: 10
      additionalEncryptionContext:
        Environment: Production
      tags:
        Name: example-portal
    options:
      customTimeouts:
        create: 10m
        update: 10m
        delete: 10m

Import

Using pulumi import, import WorkSpaces Web Portal using the portalArn. For example:

$ pulumi import aws:workspacesweb/portal:Portal example arn:aws:workspaces-web:us-west-2:123456789012:portal/abcdef12345678

Constructors

Portal(String name, {PortalArgs? args, CustomResourceOptions? options})
Creates a new Portal. name The Pulumi resource name. args Arguments used to configure this Portal. The set of arguments for Portal. options Resource options controlling this resource's behavior.
Portal.reference(String urn)
Creates a typed reference to an existing Portal resource.

Properties

additionalEncryptionContext ↔ Output<Map<String, String>?>
Additional encryption context for the customer managed key. Forces replacement if changed.
latefinal
authenticationType ↔ Output<String>
Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
latefinal
browserSettingsArn ↔ Output<String>
ARN of the browser settings to use for the portal.
latefinal
browserType ↔ Output<String>
Browser type of the portal.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
creationDate ↔ Output<String>
Creation date of the portal.
latefinal
customerManagedKey ↔ Output<String?>
ARN of the customer managed key. Forces replacement if changed.
latefinal
dataProtectionSettingsArn ↔ Output<String>
ARN of the data protection settings associated with the portal.
latefinal
displayName ↔ Output<String>
Display name of the portal.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
instanceType ↔ Output<String>
Instance type for the portal. Valid values: standard.regular, standard.large.
latefinal
ipAccessSettingsArn ↔ Output<String>
ARN of the IP access settings associated with the portal.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
maxConcurrentSessions ↔ Output<int>
Maximum number of concurrent sessions for the portal.
latefinal
networkSettingsArn ↔ Output<String>
ARN of the network settings associated with the portal.
latefinal
portalArn ↔ Output<String>
ARN of the portal.
latefinal
portalEndpoint ↔ Output<String>
Endpoint URL of the portal.
latefinal
portalStatus ↔ Output<String>
Status of the portal.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
rendererType ↔ Output<String>
Renderer type of the portal.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sessionLoggerArn ↔ Output<String>
ARN of the session logger associated with the portal.
latefinal
statusReason ↔ Output<String>
Reason for the current status of the portal.
latefinal
tags ↔ Output<Map<String, String>?>
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.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
timeouts ↔ Output<PortalTimeouts?>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
trustStoreArn ↔ Output<String>
ARN of the trust store associated with the portal.
latefinal
urn ↔ Output<String>
latefinalinherited
userAccessLoggingSettingsArn ↔ Output<String>
ARN of the user access logging settings associated with the portal.
latefinal
userSettingsArn ↔ Output<String>
ARN of the user settings associated with the portal.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {PortalState? state, CustomResourceOptions? options}) → Portal
Gets an existing Portal resource's state with the given name and id.