Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. workspacesweb
  5. Portal
AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi
pulumi/pulumi-aws

aws.workspacesweb.Portal

Explore with Pulumi AI

aws logo
AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi
pulumi/pulumi-aws

    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")

    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
	})
}

    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 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.List;
import java.util.ArrayList;
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",
    },
});

    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",
    })

    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"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 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 java.util.List;
import java.util.ArrayList;
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());

    }
}

    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

    Create Portal Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Portal(name: string, args?: PortalArgs, opts?: CustomResourceOptions);
    @overload
def Portal(resource_name: str,
           args: Optional[PortalArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def Portal(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           additional_encryption_context: Optional[Mapping[str, str]] = None,
           authentication_type: Optional[str] = None,
           browser_settings_arn: Optional[str] = None,
           customer_managed_key: Optional[str] = None,
           display_name: Optional[str] = None,
           instance_type: Optional[str] = None,
           max_concurrent_sessions: Optional[int] = None,
           region: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           timeouts: Optional[PortalTimeoutsArgs] = None)
    func NewPortal(ctx *Context, name string, args *PortalArgs, opts ...ResourceOption) (*Portal, error)
    public Portal(string name, PortalArgs? args = null, CustomResourceOptions? opts = null)
    public Portal(String name, PortalArgs args)
public Portal(String name, PortalArgs args, CustomResourceOptions options)

    type: aws:workspacesweb:Portal
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var portalResource = new Aws.WorkSpacesWeb.Portal("portalResource", new()
{
    AdditionalEncryptionContext = 
    {
        { "string", "string" },
    },
    AuthenticationType = "string",
    BrowserSettingsArn = "string",
    CustomerManagedKey = "string",
    DisplayName = "string",
    InstanceType = "string",
    MaxConcurrentSessions = 0,
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.WorkSpacesWeb.Inputs.PortalTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := workspacesweb.NewPortal(ctx, "portalResource", &workspacesweb.PortalArgs{
	AdditionalEncryptionContext: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AuthenticationType:    pulumi.String("string"),
	BrowserSettingsArn:    pulumi.String("string"),
	CustomerManagedKey:    pulumi.String("string"),
	DisplayName:           pulumi.String("string"),
	InstanceType:          pulumi.String("string"),
	MaxConcurrentSessions: pulumi.Int(0),
	Region:                pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &workspacesweb.PortalTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var portalResource = new Portal("portalResource", PortalArgs.builder()
    .additionalEncryptionContext(Map.of("string", "string"))
    .authenticationType("string")
    .browserSettingsArn("string")
    .customerManagedKey("string")
    .displayName("string")
    .instanceType("string")
    .maxConcurrentSessions(0)
    .region("string")
    .tags(Map.of("string", "string"))
    .timeouts(PortalTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    portal_resource = aws.workspacesweb.Portal("portalResource",
    additional_encryption_context={
        "string": "string",
    },
    authentication_type="string",
    browser_settings_arn="string",
    customer_managed_key="string",
    display_name="string",
    instance_type="string",
    max_concurrent_sessions=0,
    region="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const portalResource = new aws.workspacesweb.Portal("portalResource", {
    additionalEncryptionContext: {
        string: "string",
    },
    authenticationType: "string",
    browserSettingsArn: "string",
    customerManagedKey: "string",
    displayName: "string",
    instanceType: "string",
    maxConcurrentSessions: 0,
    region: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: aws:workspacesweb:Portal
properties:
    additionalEncryptionContext:
        string: string
    authenticationType: string
    browserSettingsArn: string
    customerManagedKey: string
    displayName: string
    instanceType: string
    maxConcurrentSessions: 0
    region: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string

    Portal Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Portal resource accepts the following input properties:

    AdditionalEncryptionContext Dictionary<string, string>
    Additional encryption context for the customer managed key. Forces replacement if changed.
    AuthenticationType string
    Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
    BrowserSettingsArn string
    ARN of the browser settings to use for the portal.
    CustomerManagedKey string
    ARN of the customer managed key. Forces replacement if changed.
    DisplayName string
    Display name of the portal.
    InstanceType string
    Instance type for the portal. Valid values: standard.regular, standard.large.
    MaxConcurrentSessions int
    Maximum number of concurrent sessions for the portal.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts PortalTimeouts
    AdditionalEncryptionContext map[string]string
    Additional encryption context for the customer managed key. Forces replacement if changed.
    AuthenticationType string
    Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
    BrowserSettingsArn string
    ARN of the browser settings to use for the portal.
    CustomerManagedKey string
    ARN of the customer managed key. Forces replacement if changed.
    DisplayName string
    Display name of the portal.
    InstanceType string
    Instance type for the portal. Valid values: standard.regular, standard.large.
    MaxConcurrentSessions int
    Maximum number of concurrent sessions for the portal.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts PortalTimeoutsArgs
    additionalEncryptionContext Map<String,String>
    Additional encryption context for the customer managed key. Forces replacement if changed.
    authenticationType String
    Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
    browserSettingsArn String
    ARN of the browser settings to use for the portal.
    customerManagedKey String
    ARN of the customer managed key. Forces replacement if changed.
    displayName String
    Display name of the portal.
    instanceType String
    Instance type for the portal. Valid values: standard.regular, standard.large.
    maxConcurrentSessions Integer
    Maximum number of concurrent sessions for the portal.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts PortalTimeouts
    additionalEncryptionContext {[key: string]: string}
    Additional encryption context for the customer managed key. Forces replacement if changed.
    authenticationType string
    Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
    browserSettingsArn string
    ARN of the browser settings to use for the portal.
    customerManagedKey string
    ARN of the customer managed key. Forces replacement if changed.
    displayName string
    Display name of the portal.
    instanceType string
    Instance type for the portal. Valid values: standard.regular, standard.large.
    maxConcurrentSessions number
    Maximum number of concurrent sessions for the portal.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts PortalTimeouts
    additional_encryption_context Mapping[str, str]
    Additional encryption context for the customer managed key. Forces replacement if changed.
    authentication_type str
    Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
    browser_settings_arn str
    ARN of the browser settings to use for the portal.
    customer_managed_key str
    ARN of the customer managed key. Forces replacement if changed.
    display_name str
    Display name of the portal.
    instance_type str
    Instance type for the portal. Valid values: standard.regular, standard.large.
    max_concurrent_sessions int
    Maximum number of concurrent sessions for the portal.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts PortalTimeoutsArgs
    additionalEncryptionContext Map<String>
    Additional encryption context for the customer managed key. Forces replacement if changed.
    authenticationType String
    Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
    browserSettingsArn String
    ARN of the browser settings to use for the portal.
    customerManagedKey String
    ARN of the customer managed key. Forces replacement if changed.
    displayName String
    Display name of the portal.
    instanceType String
    Instance type for the portal. Valid values: standard.regular, standard.large.
    maxConcurrentSessions Number
    Maximum number of concurrent sessions for the portal.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Portal resource produces the following output properties:

    BrowserType string
    Browser type of the portal.
    CreationDate string
    Creation date of the portal.
    DataProtectionSettingsArn string
    ARN of the data protection settings associated with the portal.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAccessSettingsArn string
    ARN of the IP access settings associated with the portal.
    NetworkSettingsArn string
    ARN of the network settings associated with the portal.
    PortalArn string
    ARN of the portal.
    PortalEndpoint string
    Endpoint URL of the portal.
    PortalStatus string
    Status of the portal.
    RendererType string
    Renderer type of the portal.
    SessionLoggerArn string
    ARN of the session logger associated with the portal.
    StatusReason string
    Reason for the current status of the portal.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    TrustStoreArn string
    ARN of the trust store associated with the portal.
    UserAccessLoggingSettingsArn string
    ARN of the user access logging settings associated with the portal.
    UserSettingsArn string
    ARN of the user settings associated with the portal.
    BrowserType string
    Browser type of the portal.
    CreationDate string
    Creation date of the portal.
    DataProtectionSettingsArn string
    ARN of the data protection settings associated with the portal.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAccessSettingsArn string
    ARN of the IP access settings associated with the portal.
    NetworkSettingsArn string
    ARN of the network settings associated with the portal.
    PortalArn string
    ARN of the portal.
    PortalEndpoint string
    Endpoint URL of the portal.
    PortalStatus string
    Status of the portal.
    RendererType string
    Renderer type of the portal.
    SessionLoggerArn string
    ARN of the session logger associated with the portal.
    StatusReason string
    Reason for the current status of the portal.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    TrustStoreArn string
    ARN of the trust store associated with the portal.
    UserAccessLoggingSettingsArn string
    ARN of the user access logging settings associated with the portal.
    UserSettingsArn string
    ARN of the user settings associated with the portal.
    browserType String
    Browser type of the portal.
    creationDate String
    Creation date of the portal.
    dataProtectionSettingsArn String
    ARN of the data protection settings associated with the portal.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAccessSettingsArn String
    ARN of the IP access settings associated with the portal.
    networkSettingsArn String
    ARN of the network settings associated with the portal.
    portalArn String
    ARN of the portal.
    portalEndpoint String
    Endpoint URL of the portal.
    portalStatus String
    Status of the portal.
    rendererType String
    Renderer type of the portal.
    sessionLoggerArn String
    ARN of the session logger associated with the portal.
    statusReason String
    Reason for the current status of the portal.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    trustStoreArn String
    ARN of the trust store associated with the portal.
    userAccessLoggingSettingsArn String
    ARN of the user access logging settings associated with the portal.
    userSettingsArn String
    ARN of the user settings associated with the portal.
    browserType string
    Browser type of the portal.
    creationDate string
    Creation date of the portal.
    dataProtectionSettingsArn string
    ARN of the data protection settings associated with the portal.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAccessSettingsArn string
    ARN of the IP access settings associated with the portal.
    networkSettingsArn string
    ARN of the network settings associated with the portal.
    portalArn string
    ARN of the portal.
    portalEndpoint string
    Endpoint URL of the portal.
    portalStatus string
    Status of the portal.
    rendererType string
    Renderer type of the portal.
    sessionLoggerArn string
    ARN of the session logger associated with the portal.
    statusReason string
    Reason for the current status of the portal.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    trustStoreArn string
    ARN of the trust store associated with the portal.
    userAccessLoggingSettingsArn string
    ARN of the user access logging settings associated with the portal.
    userSettingsArn string
    ARN of the user settings associated with the portal.
    browser_type str
    Browser type of the portal.
    creation_date str
    Creation date of the portal.
    data_protection_settings_arn str
    ARN of the data protection settings associated with the portal.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_access_settings_arn str
    ARN of the IP access settings associated with the portal.
    network_settings_arn str
    ARN of the network settings associated with the portal.
    portal_arn str
    ARN of the portal.
    portal_endpoint str
    Endpoint URL of the portal.
    portal_status str
    Status of the portal.
    renderer_type str
    Renderer type of the portal.
    session_logger_arn str
    ARN of the session logger associated with the portal.
    status_reason str
    Reason for the current status of the portal.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    trust_store_arn str
    ARN of the trust store associated with the portal.
    user_access_logging_settings_arn str
    ARN of the user access logging settings associated with the portal.
    user_settings_arn str
    ARN of the user settings associated with the portal.
    browserType String
    Browser type of the portal.
    creationDate String
    Creation date of the portal.
    dataProtectionSettingsArn String
    ARN of the data protection settings associated with the portal.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAccessSettingsArn String
    ARN of the IP access settings associated with the portal.
    networkSettingsArn String
    ARN of the network settings associated with the portal.
    portalArn String
    ARN of the portal.
    portalEndpoint String
    Endpoint URL of the portal.
    portalStatus String
    Status of the portal.
    rendererType String
    Renderer type of the portal.
    sessionLoggerArn String
    ARN of the session logger associated with the portal.
    statusReason String
    Reason for the current status of the portal.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    trustStoreArn String
    ARN of the trust store associated with the portal.
    userAccessLoggingSettingsArn String
    ARN of the user access logging settings associated with the portal.
    userSettingsArn String
    ARN of the user settings associated with the portal.

    Look up Existing Portal Resource

    Get an existing Portal resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PortalState, opts?: CustomResourceOptions): Portal
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_encryption_context: Optional[Mapping[str, str]] = None,
        authentication_type: Optional[str] = None,
        browser_settings_arn: Optional[str] = None,
        browser_type: Optional[str] = None,
        creation_date: Optional[str] = None,
        customer_managed_key: Optional[str] = None,
        data_protection_settings_arn: Optional[str] = None,
        display_name: Optional[str] = None,
        instance_type: Optional[str] = None,
        ip_access_settings_arn: Optional[str] = None,
        max_concurrent_sessions: Optional[int] = None,
        network_settings_arn: Optional[str] = None,
        portal_arn: Optional[str] = None,
        portal_endpoint: Optional[str] = None,
        portal_status: Optional[str] = None,
        region: Optional[str] = None,
        renderer_type: Optional[str] = None,
        session_logger_arn: Optional[str] = None,
        status_reason: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[PortalTimeoutsArgs] = None,
        trust_store_arn: Optional[str] = None,
        user_access_logging_settings_arn: Optional[str] = None,
        user_settings_arn: Optional[str] = None) -> Portal
    func GetPortal(ctx *Context, name string, id IDInput, state *PortalState, opts ...ResourceOption) (*Portal, error)
    public static Portal Get(string name, Input<string> id, PortalState? state, CustomResourceOptions? opts = null)
    public static Portal get(String name, Output<String> id, PortalState state, CustomResourceOptions options)
    resources:  _:    type: aws:workspacesweb:Portal    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdditionalEncryptionContext Dictionary<string, string>
    Additional encryption context for the customer managed key. Forces replacement if changed.
    AuthenticationType string
    Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
    BrowserSettingsArn string
    ARN of the browser settings to use for the portal.
    BrowserType string
    Browser type of the portal.
    CreationDate string
    Creation date of the portal.
    CustomerManagedKey string
    ARN of the customer managed key. Forces replacement if changed.
    DataProtectionSettingsArn string
    ARN of the data protection settings associated with the portal.
    DisplayName string
    Display name of the portal.
    InstanceType string
    Instance type for the portal. Valid values: standard.regular, standard.large.
    IpAccessSettingsArn string
    ARN of the IP access settings associated with the portal.
    MaxConcurrentSessions int
    Maximum number of concurrent sessions for the portal.
    NetworkSettingsArn string
    ARN of the network settings associated with the portal.
    PortalArn string
    ARN of the portal.
    PortalEndpoint string
    Endpoint URL of the portal.
    PortalStatus string
    Status of the portal.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    RendererType string
    Renderer type of the portal.
    SessionLoggerArn string
    ARN of the session logger associated with the portal.
    StatusReason string
    Reason for the current status of the portal.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Timeouts PortalTimeouts
    TrustStoreArn string
    ARN of the trust store associated with the portal.
    UserAccessLoggingSettingsArn string
    ARN of the user access logging settings associated with the portal.
    UserSettingsArn string
    ARN of the user settings associated with the portal.
    AdditionalEncryptionContext map[string]string
    Additional encryption context for the customer managed key. Forces replacement if changed.
    AuthenticationType string
    Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
    BrowserSettingsArn string
    ARN of the browser settings to use for the portal.
    BrowserType string
    Browser type of the portal.
    CreationDate string
    Creation date of the portal.
    CustomerManagedKey string
    ARN of the customer managed key. Forces replacement if changed.
    DataProtectionSettingsArn string
    ARN of the data protection settings associated with the portal.
    DisplayName string
    Display name of the portal.
    InstanceType string
    Instance type for the portal. Valid values: standard.regular, standard.large.
    IpAccessSettingsArn string
    ARN of the IP access settings associated with the portal.
    MaxConcurrentSessions int
    Maximum number of concurrent sessions for the portal.
    NetworkSettingsArn string
    ARN of the network settings associated with the portal.
    PortalArn string
    ARN of the portal.
    PortalEndpoint string
    Endpoint URL of the portal.
    PortalStatus string
    Status of the portal.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    RendererType string
    Renderer type of the portal.
    SessionLoggerArn string
    ARN of the session logger associated with the portal.
    StatusReason string
    Reason for the current status of the portal.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Timeouts PortalTimeoutsArgs
    TrustStoreArn string
    ARN of the trust store associated with the portal.
    UserAccessLoggingSettingsArn string
    ARN of the user access logging settings associated with the portal.
    UserSettingsArn string
    ARN of the user settings associated with the portal.
    additionalEncryptionContext Map<String,String>
    Additional encryption context for the customer managed key. Forces replacement if changed.
    authenticationType String
    Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
    browserSettingsArn String
    ARN of the browser settings to use for the portal.
    browserType String
    Browser type of the portal.
    creationDate String
    Creation date of the portal.
    customerManagedKey String
    ARN of the customer managed key. Forces replacement if changed.
    dataProtectionSettingsArn String
    ARN of the data protection settings associated with the portal.
    displayName String
    Display name of the portal.
    instanceType String
    Instance type for the portal. Valid values: standard.regular, standard.large.
    ipAccessSettingsArn String
    ARN of the IP access settings associated with the portal.
    maxConcurrentSessions Integer
    Maximum number of concurrent sessions for the portal.
    networkSettingsArn String
    ARN of the network settings associated with the portal.
    portalArn String
    ARN of the portal.
    portalEndpoint String
    Endpoint URL of the portal.
    portalStatus String
    Status of the portal.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    rendererType String
    Renderer type of the portal.
    sessionLoggerArn String
    ARN of the session logger associated with the portal.
    statusReason String
    Reason for the current status of the portal.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    timeouts PortalTimeouts
    trustStoreArn String
    ARN of the trust store associated with the portal.
    userAccessLoggingSettingsArn String
    ARN of the user access logging settings associated with the portal.
    userSettingsArn String
    ARN of the user settings associated with the portal.
    additionalEncryptionContext {[key: string]: string}
    Additional encryption context for the customer managed key. Forces replacement if changed.
    authenticationType string
    Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
    browserSettingsArn string
    ARN of the browser settings to use for the portal.
    browserType string
    Browser type of the portal.
    creationDate string
    Creation date of the portal.
    customerManagedKey string
    ARN of the customer managed key. Forces replacement if changed.
    dataProtectionSettingsArn string
    ARN of the data protection settings associated with the portal.
    displayName string
    Display name of the portal.
    instanceType string
    Instance type for the portal. Valid values: standard.regular, standard.large.
    ipAccessSettingsArn string
    ARN of the IP access settings associated with the portal.
    maxConcurrentSessions number
    Maximum number of concurrent sessions for the portal.
    networkSettingsArn string
    ARN of the network settings associated with the portal.
    portalArn string
    ARN of the portal.
    portalEndpoint string
    Endpoint URL of the portal.
    portalStatus string
    Status of the portal.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    rendererType string
    Renderer type of the portal.
    sessionLoggerArn string
    ARN of the session logger associated with the portal.
    statusReason string
    Reason for the current status of the portal.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    timeouts PortalTimeouts
    trustStoreArn string
    ARN of the trust store associated with the portal.
    userAccessLoggingSettingsArn string
    ARN of the user access logging settings associated with the portal.
    userSettingsArn string
    ARN of the user settings associated with the portal.
    additional_encryption_context Mapping[str, str]
    Additional encryption context for the customer managed key. Forces replacement if changed.
    authentication_type str
    Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
    browser_settings_arn str
    ARN of the browser settings to use for the portal.
    browser_type str
    Browser type of the portal.
    creation_date str
    Creation date of the portal.
    customer_managed_key str
    ARN of the customer managed key. Forces replacement if changed.
    data_protection_settings_arn str
    ARN of the data protection settings associated with the portal.
    display_name str
    Display name of the portal.
    instance_type str
    Instance type for the portal. Valid values: standard.regular, standard.large.
    ip_access_settings_arn str
    ARN of the IP access settings associated with the portal.
    max_concurrent_sessions int
    Maximum number of concurrent sessions for the portal.
    network_settings_arn str
    ARN of the network settings associated with the portal.
    portal_arn str
    ARN of the portal.
    portal_endpoint str
    Endpoint URL of the portal.
    portal_status str
    Status of the portal.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    renderer_type str
    Renderer type of the portal.
    session_logger_arn str
    ARN of the session logger associated with the portal.
    status_reason str
    Reason for the current status of the portal.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    timeouts PortalTimeoutsArgs
    trust_store_arn str
    ARN of the trust store associated with the portal.
    user_access_logging_settings_arn str
    ARN of the user access logging settings associated with the portal.
    user_settings_arn str
    ARN of the user settings associated with the portal.
    additionalEncryptionContext Map<String>
    Additional encryption context for the customer managed key. Forces replacement if changed.
    authenticationType String
    Authentication type for the portal. Valid values: Standard, IAM_Identity_Center.
    browserSettingsArn String
    ARN of the browser settings to use for the portal.
    browserType String
    Browser type of the portal.
    creationDate String
    Creation date of the portal.
    customerManagedKey String
    ARN of the customer managed key. Forces replacement if changed.
    dataProtectionSettingsArn String
    ARN of the data protection settings associated with the portal.
    displayName String
    Display name of the portal.
    instanceType String
    Instance type for the portal. Valid values: standard.regular, standard.large.
    ipAccessSettingsArn String
    ARN of the IP access settings associated with the portal.
    maxConcurrentSessions Number
    Maximum number of concurrent sessions for the portal.
    networkSettingsArn String
    ARN of the network settings associated with the portal.
    portalArn String
    ARN of the portal.
    portalEndpoint String
    Endpoint URL of the portal.
    portalStatus String
    Status of the portal.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    rendererType String
    Renderer type of the portal.
    sessionLoggerArn String
    ARN of the session logger associated with the portal.
    statusReason String
    Reason for the current status of the portal.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    timeouts Property Map
    trustStoreArn String
    ARN of the trust store associated with the portal.
    userAccessLoggingSettingsArn String
    ARN of the user access logging settings associated with the portal.
    userSettingsArn String
    ARN of the user settings associated with the portal.

    Supporting Types

    PortalTimeouts, PortalTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi
    pulumi/pulumi-aws
      AI Agentic Workflows: Register now