Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. workspacesweb
  5. getPortal

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.workspacesweb.getPortal

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::WorkSpacesWeb::Portal Resource Type

    Using getPortal

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPortal(args: GetPortalArgs, opts?: InvokeOptions): Promise<GetPortalResult>
function getPortalOutput(args: GetPortalOutputArgs, opts?: InvokeOptions): Output<GetPortalResult>
    def get_portal(portal_arn: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetPortalResult
def get_portal_output(portal_arn: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetPortalResult]
    func LookupPortal(ctx *Context, args *LookupPortalArgs, opts ...InvokeOption) (*LookupPortalResult, error)
func LookupPortalOutput(ctx *Context, args *LookupPortalOutputArgs, opts ...InvokeOption) LookupPortalResultOutput

    > Note: This function is named LookupPortal in the Go SDK.

    public static class GetPortal 
{
    public static Task<GetPortalResult> InvokeAsync(GetPortalArgs args, InvokeOptions? opts = null)
    public static Output<GetPortalResult> Invoke(GetPortalInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPortalResult> getPortal(GetPortalArgs args, InvokeOptions options)
public static Output<GetPortalResult> getPortal(GetPortalArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:workspacesweb:getPortal
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PortalArn string
    The ARN of the web portal.
    PortalArn string
    The ARN of the web portal.
    portalArn String
    The ARN of the web portal.
    portalArn string
    The ARN of the web portal.
    portal_arn str
    The ARN of the web portal.
    portalArn String
    The ARN of the web portal.

    getPortal Result

    The following output properties are available:

    AuthenticationType Pulumi.AwsNative.WorkSpacesWeb.PortalAuthenticationType

    The type of authentication integration points used when signing into the web portal. Defaults to Standard .

    Standard web portals are authenticated directly through your identity provider (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Secure Browser’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps:

    1. Create and deploy a CloudFormation template with a Standard portal with no IdentityProvider resource.

    2. Retrieve the SP metadata using Fn:GetAtt , the WorkSpaces Secure Browser console, or by the calling the GetPortalServiceProviderMetadata API.

    3. Submit the data to your IdP.

    4. Add an IdentityProvider resource to your CloudFormation template.

    IAM Identity Center web portals are authenticated through AWS IAM Identity Center . They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration) and other identity provider information must be configured in IAM Identity Center . User and group assignment must be done through the WorkSpaces Secure Browser console. These cannot be configured in CloudFormation.

    BrowserSettingsArn string
    The ARN of the browser settings that is associated with this web portal.
    BrowserType Pulumi.AwsNative.WorkSpacesWeb.PortalBrowserType
    The browser that users see when using a streaming session.
    CreationDate string
    The creation date of the web portal.
    DataProtectionSettingsArn string
    The ARN of the data protection settings.
    DisplayName string
    The name of the web portal.
    InstanceType Pulumi.AwsNative.WorkSpacesWeb.PortalInstanceType
    The type and resources of the underlying instance.
    IpAccessSettingsArn string
    The ARN of the IP access settings that is associated with the web portal.
    MaxConcurrentSessions double
    The maximum number of concurrent sessions for the portal.
    NetworkSettingsArn string
    The ARN of the network settings that is associated with the web portal.
    PortalArn string
    The ARN of the web portal.
    PortalEndpoint string
    The endpoint URL of the web portal that users access in order to start streaming sessions.
    PortalStatus Pulumi.AwsNative.WorkSpacesWeb.PortalStatus
    The status of the web portal.
    RendererType Pulumi.AwsNative.WorkSpacesWeb.PortalRendererType
    The renderer that is used in streaming sessions.
    ServiceProviderSamlMetadata string
    The SAML metadata of the service provider.
    StatusReason string
    A message that explains why the web portal is in its current status.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags to add to the web portal. A tag is a key-value pair.
    TrustStoreArn string
    The ARN of the trust store that is associated with the web portal.
    UserAccessLoggingSettingsArn string
    The ARN of the user access logging settings that is associated with the web portal.
    UserSettingsArn string
    The ARN of the user settings that is associated with the web portal.
    AuthenticationType PortalAuthenticationType

    The type of authentication integration points used when signing into the web portal. Defaults to Standard .

    Standard web portals are authenticated directly through your identity provider (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Secure Browser’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps:

    1. Create and deploy a CloudFormation template with a Standard portal with no IdentityProvider resource.

    2. Retrieve the SP metadata using Fn:GetAtt , the WorkSpaces Secure Browser console, or by the calling the GetPortalServiceProviderMetadata API.

    3. Submit the data to your IdP.

    4. Add an IdentityProvider resource to your CloudFormation template.

    IAM Identity Center web portals are authenticated through AWS IAM Identity Center . They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration) and other identity provider information must be configured in IAM Identity Center . User and group assignment must be done through the WorkSpaces Secure Browser console. These cannot be configured in CloudFormation.

    BrowserSettingsArn string
    The ARN of the browser settings that is associated with this web portal.
    BrowserType PortalBrowserType
    The browser that users see when using a streaming session.
    CreationDate string
    The creation date of the web portal.
    DataProtectionSettingsArn string
    The ARN of the data protection settings.
    DisplayName string
    The name of the web portal.
    InstanceType PortalInstanceType
    The type and resources of the underlying instance.
    IpAccessSettingsArn string
    The ARN of the IP access settings that is associated with the web portal.
    MaxConcurrentSessions float64
    The maximum number of concurrent sessions for the portal.
    NetworkSettingsArn string
    The ARN of the network settings that is associated with the web portal.
    PortalArn string
    The ARN of the web portal.
    PortalEndpoint string
    The endpoint URL of the web portal that users access in order to start streaming sessions.
    PortalStatus PortalStatus
    The status of the web portal.
    RendererType PortalRendererType
    The renderer that is used in streaming sessions.
    ServiceProviderSamlMetadata string
    The SAML metadata of the service provider.
    StatusReason string
    A message that explains why the web portal is in its current status.
    Tags Tag
    The tags to add to the web portal. A tag is a key-value pair.
    TrustStoreArn string
    The ARN of the trust store that is associated with the web portal.
    UserAccessLoggingSettingsArn string
    The ARN of the user access logging settings that is associated with the web portal.
    UserSettingsArn string
    The ARN of the user settings that is associated with the web portal.
    authenticationType PortalAuthenticationType

    The type of authentication integration points used when signing into the web portal. Defaults to Standard .

    Standard web portals are authenticated directly through your identity provider (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Secure Browser’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps:

    1. Create and deploy a CloudFormation template with a Standard portal with no IdentityProvider resource.

    2. Retrieve the SP metadata using Fn:GetAtt , the WorkSpaces Secure Browser console, or by the calling the GetPortalServiceProviderMetadata API.

    3. Submit the data to your IdP.

    4. Add an IdentityProvider resource to your CloudFormation template.

    IAM Identity Center web portals are authenticated through AWS IAM Identity Center . They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration) and other identity provider information must be configured in IAM Identity Center . User and group assignment must be done through the WorkSpaces Secure Browser console. These cannot be configured in CloudFormation.

    browserSettingsArn String
    The ARN of the browser settings that is associated with this web portal.
    browserType PortalBrowserType
    The browser that users see when using a streaming session.
    creationDate String
    The creation date of the web portal.
    dataProtectionSettingsArn String
    The ARN of the data protection settings.
    displayName String
    The name of the web portal.
    instanceType PortalInstanceType
    The type and resources of the underlying instance.
    ipAccessSettingsArn String
    The ARN of the IP access settings that is associated with the web portal.
    maxConcurrentSessions Double
    The maximum number of concurrent sessions for the portal.
    networkSettingsArn String
    The ARN of the network settings that is associated with the web portal.
    portalArn String
    The ARN of the web portal.
    portalEndpoint String
    The endpoint URL of the web portal that users access in order to start streaming sessions.
    portalStatus PortalStatus
    The status of the web portal.
    rendererType PortalRendererType
    The renderer that is used in streaming sessions.
    serviceProviderSamlMetadata String
    The SAML metadata of the service provider.
    statusReason String
    A message that explains why the web portal is in its current status.
    tags List<Tag>
    The tags to add to the web portal. A tag is a key-value pair.
    trustStoreArn String
    The ARN of the trust store that is associated with the web portal.
    userAccessLoggingSettingsArn String
    The ARN of the user access logging settings that is associated with the web portal.
    userSettingsArn String
    The ARN of the user settings that is associated with the web portal.
    authenticationType PortalAuthenticationType

    The type of authentication integration points used when signing into the web portal. Defaults to Standard .

    Standard web portals are authenticated directly through your identity provider (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Secure Browser’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps:

    1. Create and deploy a CloudFormation template with a Standard portal with no IdentityProvider resource.

    2. Retrieve the SP metadata using Fn:GetAtt , the WorkSpaces Secure Browser console, or by the calling the GetPortalServiceProviderMetadata API.

    3. Submit the data to your IdP.

    4. Add an IdentityProvider resource to your CloudFormation template.

    IAM Identity Center web portals are authenticated through AWS IAM Identity Center . They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration) and other identity provider information must be configured in IAM Identity Center . User and group assignment must be done through the WorkSpaces Secure Browser console. These cannot be configured in CloudFormation.

    browserSettingsArn string
    The ARN of the browser settings that is associated with this web portal.
    browserType PortalBrowserType
    The browser that users see when using a streaming session.
    creationDate string
    The creation date of the web portal.
    dataProtectionSettingsArn string
    The ARN of the data protection settings.
    displayName string
    The name of the web portal.
    instanceType PortalInstanceType
    The type and resources of the underlying instance.
    ipAccessSettingsArn string
    The ARN of the IP access settings that is associated with the web portal.
    maxConcurrentSessions number
    The maximum number of concurrent sessions for the portal.
    networkSettingsArn string
    The ARN of the network settings that is associated with the web portal.
    portalArn string
    The ARN of the web portal.
    portalEndpoint string
    The endpoint URL of the web portal that users access in order to start streaming sessions.
    portalStatus PortalStatus
    The status of the web portal.
    rendererType PortalRendererType
    The renderer that is used in streaming sessions.
    serviceProviderSamlMetadata string
    The SAML metadata of the service provider.
    statusReason string
    A message that explains why the web portal is in its current status.
    tags Tag[]
    The tags to add to the web portal. A tag is a key-value pair.
    trustStoreArn string
    The ARN of the trust store that is associated with the web portal.
    userAccessLoggingSettingsArn string
    The ARN of the user access logging settings that is associated with the web portal.
    userSettingsArn string
    The ARN of the user settings that is associated with the web portal.
    authentication_type PortalAuthenticationType

    The type of authentication integration points used when signing into the web portal. Defaults to Standard .

    Standard web portals are authenticated directly through your identity provider (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Secure Browser’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps:

    1. Create and deploy a CloudFormation template with a Standard portal with no IdentityProvider resource.

    2. Retrieve the SP metadata using Fn:GetAtt , the WorkSpaces Secure Browser console, or by the calling the GetPortalServiceProviderMetadata API.

    3. Submit the data to your IdP.

    4. Add an IdentityProvider resource to your CloudFormation template.

    IAM Identity Center web portals are authenticated through AWS IAM Identity Center . They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration) and other identity provider information must be configured in IAM Identity Center . User and group assignment must be done through the WorkSpaces Secure Browser console. These cannot be configured in CloudFormation.

    browser_settings_arn str
    The ARN of the browser settings that is associated with this web portal.
    browser_type PortalBrowserType
    The browser that users see when using a streaming session.
    creation_date str
    The creation date of the web portal.
    data_protection_settings_arn str
    The ARN of the data protection settings.
    display_name str
    The name of the web portal.
    instance_type PortalInstanceType
    The type and resources of the underlying instance.
    ip_access_settings_arn str
    The ARN of the IP access settings that is associated with the web portal.
    max_concurrent_sessions float
    The maximum number of concurrent sessions for the portal.
    network_settings_arn str
    The ARN of the network settings that is associated with the web portal.
    portal_arn str
    The ARN of the web portal.
    portal_endpoint str
    The endpoint URL of the web portal that users access in order to start streaming sessions.
    portal_status PortalStatus
    The status of the web portal.
    renderer_type PortalRendererType
    The renderer that is used in streaming sessions.
    service_provider_saml_metadata str
    The SAML metadata of the service provider.
    status_reason str
    A message that explains why the web portal is in its current status.
    tags Sequence[root_Tag]
    The tags to add to the web portal. A tag is a key-value pair.
    trust_store_arn str
    The ARN of the trust store that is associated with the web portal.
    user_access_logging_settings_arn str
    The ARN of the user access logging settings that is associated with the web portal.
    user_settings_arn str
    The ARN of the user settings that is associated with the web portal.
    authenticationType "Standard" | "IAM_Identity_Center"

    The type of authentication integration points used when signing into the web portal. Defaults to Standard .

    Standard web portals are authenticated directly through your identity provider (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Secure Browser’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps:

    1. Create and deploy a CloudFormation template with a Standard portal with no IdentityProvider resource.

    2. Retrieve the SP metadata using Fn:GetAtt , the WorkSpaces Secure Browser console, or by the calling the GetPortalServiceProviderMetadata API.

    3. Submit the data to your IdP.

    4. Add an IdentityProvider resource to your CloudFormation template.

    IAM Identity Center web portals are authenticated through AWS IAM Identity Center . They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration) and other identity provider information must be configured in IAM Identity Center . User and group assignment must be done through the WorkSpaces Secure Browser console. These cannot be configured in CloudFormation.

    browserSettingsArn String
    The ARN of the browser settings that is associated with this web portal.
    browserType "Chrome"
    The browser that users see when using a streaming session.
    creationDate String
    The creation date of the web portal.
    dataProtectionSettingsArn String
    The ARN of the data protection settings.
    displayName String
    The name of the web portal.
    instanceType "standard.regular" | "standard.large" | "standard.xlarge"
    The type and resources of the underlying instance.
    ipAccessSettingsArn String
    The ARN of the IP access settings that is associated with the web portal.
    maxConcurrentSessions Number
    The maximum number of concurrent sessions for the portal.
    networkSettingsArn String
    The ARN of the network settings that is associated with the web portal.
    portalArn String
    The ARN of the web portal.
    portalEndpoint String
    The endpoint URL of the web portal that users access in order to start streaming sessions.
    portalStatus "Incomplete" | "Pending" | "Active"
    The status of the web portal.
    rendererType "AppStream"
    The renderer that is used in streaming sessions.
    serviceProviderSamlMetadata String
    The SAML metadata of the service provider.
    statusReason String
    A message that explains why the web portal is in its current status.
    tags List<Property Map>
    The tags to add to the web portal. A tag is a key-value pair.
    trustStoreArn String
    The ARN of the trust store that is associated with the web portal.
    userAccessLoggingSettingsArn String
    The ARN of the user access logging settings that is associated with the web portal.
    userSettingsArn String
    The ARN of the user settings that is associated with the web portal.

    Supporting Types

    PortalAuthenticationType

    PortalBrowserType

    PortalInstanceType

    PortalRendererType

    PortalStatus

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native