We recommend new projects start with resources from the AWS provider.
aws-native.workspacesweb.Portal
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::WorkSpacesWeb::Portal Resource Type
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[PortalAuthenticationType] = None,
           browser_settings_arn: Optional[str] = None,
           customer_managed_key: Optional[str] = None,
           data_protection_settings_arn: Optional[str] = None,
           display_name: Optional[str] = None,
           instance_type: Optional[PortalInstanceType] = None,
           ip_access_settings_arn: Optional[str] = None,
           max_concurrent_sessions: Optional[float] = None,
           network_settings_arn: Optional[str] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
           trust_store_arn: Optional[str] = None,
           user_access_logging_settings_arn: Optional[str] = None,
           user_settings_arn: Optional[str] = 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-native: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.
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:
- AdditionalEncryption Dictionary<string, string>Context 
- The additional encryption context of the portal.
- AuthenticationType Pulumi.Aws Native. Work Spaces Web. Portal Authentication Type 
- The type of authentication integration points used when signing into the web portal. Defaults to - Standard.- Standardweb 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:- Create and deploy a CloudFormation template with a - Standardportal with no- IdentityProviderresource.
- Retrieve the SP metadata using - Fn:GetAtt, the WorkSpaces Secure Browser console, or by the calling the- GetPortalServiceProviderMetadataAPI.
- Submit the data to your IdP. 
- Add an - IdentityProviderresource to your CloudFormation template.
 - IAM Identity Centerweb 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.
- BrowserSettings stringArn 
- The ARN of the browser settings that is associated with this web portal.
- CustomerManaged stringKey 
- The customer managed key of the web portal. - Pattern : - ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$
- DataProtection stringSettings Arn 
- The ARN of the data protection settings.
- DisplayName string
- The name of the web portal.
- InstanceType Pulumi.Aws Native. Work Spaces Web. Portal Instance Type 
- The type and resources of the underlying instance.
- IpAccess stringSettings Arn 
- The ARN of the IP access settings that is associated with the web portal.
- MaxConcurrent doubleSessions 
- The maximum number of concurrent sessions for the portal.
- NetworkSettings stringArn 
- The ARN of the network settings that is associated with the web portal.
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- The tags to add to the web portal. A tag is a key-value pair.
- TrustStore stringArn 
- The ARN of the trust store that is associated with the web portal.
- UserAccess stringLogging Settings Arn 
- The ARN of the user access logging settings that is associated with the web portal.
- UserSettings stringArn 
- The ARN of the user settings that is associated with the web portal.
- AdditionalEncryption map[string]stringContext 
- The additional encryption context of the portal.
- AuthenticationType PortalAuthentication Type 
- The type of authentication integration points used when signing into the web portal. Defaults to - Standard.- Standardweb 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:- Create and deploy a CloudFormation template with a - Standardportal with no- IdentityProviderresource.
- Retrieve the SP metadata using - Fn:GetAtt, the WorkSpaces Secure Browser console, or by the calling the- GetPortalServiceProviderMetadataAPI.
- Submit the data to your IdP. 
- Add an - IdentityProviderresource to your CloudFormation template.
 - IAM Identity Centerweb 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.
- BrowserSettings stringArn 
- The ARN of the browser settings that is associated with this web portal.
- CustomerManaged stringKey 
- The customer managed key of the web portal. - Pattern : - ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$
- DataProtection stringSettings Arn 
- The ARN of the data protection settings.
- DisplayName string
- The name of the web portal.
- InstanceType PortalInstance Type 
- The type and resources of the underlying instance.
- IpAccess stringSettings Arn 
- The ARN of the IP access settings that is associated with the web portal.
- MaxConcurrent float64Sessions 
- The maximum number of concurrent sessions for the portal.
- NetworkSettings stringArn 
- The ARN of the network settings that is associated with the web portal.
- 
TagArgs 
- The tags to add to the web portal. A tag is a key-value pair.
- TrustStore stringArn 
- The ARN of the trust store that is associated with the web portal.
- UserAccess stringLogging Settings Arn 
- The ARN of the user access logging settings that is associated with the web portal.
- UserSettings stringArn 
- The ARN of the user settings that is associated with the web portal.
- additionalEncryption Map<String,String>Context 
- The additional encryption context of the portal.
- authenticationType PortalAuthentication Type 
- The type of authentication integration points used when signing into the web portal. Defaults to - Standard.- Standardweb 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:- Create and deploy a CloudFormation template with a - Standardportal with no- IdentityProviderresource.
- Retrieve the SP metadata using - Fn:GetAtt, the WorkSpaces Secure Browser console, or by the calling the- GetPortalServiceProviderMetadataAPI.
- Submit the data to your IdP. 
- Add an - IdentityProviderresource to your CloudFormation template.
 - IAM Identity Centerweb 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.
- browserSettings StringArn 
- The ARN of the browser settings that is associated with this web portal.
- customerManaged StringKey 
- The customer managed key of the web portal. - Pattern : - ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$
- dataProtection StringSettings Arn 
- The ARN of the data protection settings.
- displayName String
- The name of the web portal.
- instanceType PortalInstance Type 
- The type and resources of the underlying instance.
- ipAccess StringSettings Arn 
- The ARN of the IP access settings that is associated with the web portal.
- maxConcurrent DoubleSessions 
- The maximum number of concurrent sessions for the portal.
- networkSettings StringArn 
- The ARN of the network settings that is associated with the web portal.
- List<Tag>
- The tags to add to the web portal. A tag is a key-value pair.
- trustStore StringArn 
- The ARN of the trust store that is associated with the web portal.
- userAccess StringLogging Settings Arn 
- The ARN of the user access logging settings that is associated with the web portal.
- userSettings StringArn 
- The ARN of the user settings that is associated with the web portal.
- additionalEncryption {[key: string]: string}Context 
- The additional encryption context of the portal.
- authenticationType PortalAuthentication Type 
- The type of authentication integration points used when signing into the web portal. Defaults to - Standard.- Standardweb 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:- Create and deploy a CloudFormation template with a - Standardportal with no- IdentityProviderresource.
- Retrieve the SP metadata using - Fn:GetAtt, the WorkSpaces Secure Browser console, or by the calling the- GetPortalServiceProviderMetadataAPI.
- Submit the data to your IdP. 
- Add an - IdentityProviderresource to your CloudFormation template.
 - IAM Identity Centerweb 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.
- browserSettings stringArn 
- The ARN of the browser settings that is associated with this web portal.
- customerManaged stringKey 
- The customer managed key of the web portal. - Pattern : - ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$
- dataProtection stringSettings Arn 
- The ARN of the data protection settings.
- displayName string
- The name of the web portal.
- instanceType PortalInstance Type 
- The type and resources of the underlying instance.
- ipAccess stringSettings Arn 
- The ARN of the IP access settings that is associated with the web portal.
- maxConcurrent numberSessions 
- The maximum number of concurrent sessions for the portal.
- networkSettings stringArn 
- The ARN of the network settings that is associated with the web portal.
- Tag[]
- The tags to add to the web portal. A tag is a key-value pair.
- trustStore stringArn 
- The ARN of the trust store that is associated with the web portal.
- userAccess stringLogging Settings Arn 
- The ARN of the user access logging settings that is associated with the web portal.
- userSettings stringArn 
- The ARN of the user settings that is associated with the web portal.
- additional_encryption_ Mapping[str, str]context 
- The additional encryption context of the portal.
- authentication_type PortalAuthentication Type 
- The type of authentication integration points used when signing into the web portal. Defaults to - Standard.- Standardweb 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:- Create and deploy a CloudFormation template with a - Standardportal with no- IdentityProviderresource.
- Retrieve the SP metadata using - Fn:GetAtt, the WorkSpaces Secure Browser console, or by the calling the- GetPortalServiceProviderMetadataAPI.
- Submit the data to your IdP. 
- Add an - IdentityProviderresource to your CloudFormation template.
 - IAM Identity Centerweb 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_ strarn 
- The ARN of the browser settings that is associated with this web portal.
- customer_managed_ strkey 
- The customer managed key of the web portal. - Pattern : - ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$
- data_protection_ strsettings_ arn 
- The ARN of the data protection settings.
- display_name str
- The name of the web portal.
- instance_type PortalInstance Type 
- The type and resources of the underlying instance.
- ip_access_ strsettings_ arn 
- The ARN of the IP access settings that is associated with the web portal.
- max_concurrent_ floatsessions 
- The maximum number of concurrent sessions for the portal.
- network_settings_ strarn 
- The ARN of the network settings that is associated with the web portal.
- 
Sequence[TagArgs] 
- The tags to add to the web portal. A tag is a key-value pair.
- trust_store_ strarn 
- The ARN of the trust store that is associated with the web portal.
- user_access_ strlogging_ settings_ arn 
- The ARN of the user access logging settings that is associated with the web portal.
- user_settings_ strarn 
- The ARN of the user settings that is associated with the web portal.
- additionalEncryption Map<String>Context 
- The additional encryption context of the portal.
- authenticationType "Standard" | "IAM_Identity_Center"
- The type of authentication integration points used when signing into the web portal. Defaults to - Standard.- Standardweb 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:- Create and deploy a CloudFormation template with a - Standardportal with no- IdentityProviderresource.
- Retrieve the SP metadata using - Fn:GetAtt, the WorkSpaces Secure Browser console, or by the calling the- GetPortalServiceProviderMetadataAPI.
- Submit the data to your IdP. 
- Add an - IdentityProviderresource to your CloudFormation template.
 - IAM Identity Centerweb 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.
- browserSettings StringArn 
- The ARN of the browser settings that is associated with this web portal.
- customerManaged StringKey 
- The customer managed key of the web portal. - Pattern : - ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$
- dataProtection StringSettings Arn 
- 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.
- ipAccess StringSettings Arn 
- The ARN of the IP access settings that is associated with the web portal.
- maxConcurrent NumberSessions 
- The maximum number of concurrent sessions for the portal.
- networkSettings StringArn 
- The ARN of the network settings that is associated with the web portal.
- List<Property Map>
- The tags to add to the web portal. A tag is a key-value pair.
- trustStore StringArn 
- The ARN of the trust store that is associated with the web portal.
- userAccess StringLogging Settings Arn 
- The ARN of the user access logging settings that is associated with the web portal.
- userSettings StringArn 
- The ARN of the user settings that is associated with the web portal.
Outputs
All input properties are implicitly available as output properties. Additionally, the Portal resource produces the following output properties:
- BrowserType Pulumi.Aws Native. Work Spaces Web. Portal Browser Type 
- The browser that users see when using a streaming session.
- CreationDate string
- The creation date of the web portal.
- Id string
- The provider-assigned unique ID for this managed resource.
- 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.Aws Native. Work Spaces Web. Portal Status 
- The status of the web portal.
- RendererType Pulumi.Aws Native. Work Spaces Web. Portal Renderer Type 
- The renderer that is used in streaming sessions.
- ServiceProvider stringSaml Metadata 
- The SAML metadata of the service provider.
- StatusReason string
- A message that explains why the web portal is in its current status.
- BrowserType PortalBrowser Type 
- The browser that users see when using a streaming session.
- CreationDate string
- The creation date of the web portal.
- Id string
- The provider-assigned unique ID for this managed resource.
- 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 PortalRenderer Type 
- The renderer that is used in streaming sessions.
- ServiceProvider stringSaml Metadata 
- The SAML metadata of the service provider.
- StatusReason string
- A message that explains why the web portal is in its current status.
- browserType PortalBrowser Type 
- The browser that users see when using a streaming session.
- creationDate String
- The creation date of the web portal.
- id String
- The provider-assigned unique ID for this managed resource.
- 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 PortalRenderer Type 
- The renderer that is used in streaming sessions.
- serviceProvider StringSaml Metadata 
- The SAML metadata of the service provider.
- statusReason String
- A message that explains why the web portal is in its current status.
- browserType PortalBrowser Type 
- The browser that users see when using a streaming session.
- creationDate string
- The creation date of the web portal.
- id string
- The provider-assigned unique ID for this managed resource.
- 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 PortalRenderer Type 
- The renderer that is used in streaming sessions.
- serviceProvider stringSaml Metadata 
- The SAML metadata of the service provider.
- statusReason string
- A message that explains why the web portal is in its current status.
- browser_type PortalBrowser Type 
- The browser that users see when using a streaming session.
- creation_date str
- The creation date of the web portal.
- id str
- The provider-assigned unique ID for this managed resource.
- 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 PortalRenderer Type 
- The renderer that is used in streaming sessions.
- service_provider_ strsaml_ metadata 
- The SAML metadata of the service provider.
- status_reason str
- A message that explains why the web portal is in its current status.
- browserType "Chrome"
- The browser that users see when using a streaming session.
- creationDate String
- The creation date of the web portal.
- id String
- The provider-assigned unique ID for this managed resource.
- 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.
- serviceProvider StringSaml Metadata 
- The SAML metadata of the service provider.
- statusReason String
- A message that explains why the web portal is in its current status.
Supporting Types
PortalAuthenticationType, PortalAuthenticationTypeArgs      
- Standard
- Standard
- IamIdentity Center 
- IAM_Identity_Center
- PortalAuthentication Type Standard 
- Standard
- PortalAuthentication Type Iam Identity Center 
- IAM_Identity_Center
- Standard
- Standard
- IamIdentity Center 
- IAM_Identity_Center
- Standard
- Standard
- IamIdentity Center 
- IAM_Identity_Center
- STANDARD
- Standard
- IAM_IDENTITY_CENTER
- IAM_Identity_Center
- "Standard"
- Standard
- "IAM_Identity_Center"
- IAM_Identity_Center
PortalBrowserType, PortalBrowserTypeArgs      
- Chrome
- Chrome
- PortalBrowser Type Chrome 
- Chrome
- Chrome
- Chrome
- Chrome
- Chrome
- CHROME
- Chrome
- "Chrome"
- Chrome
PortalInstanceType, PortalInstanceTypeArgs      
- StandardRegular 
- standard.regular
- StandardLarge 
- standard.large
- StandardXlarge 
- standard.xlarge
- PortalInstance Type Standard Regular 
- standard.regular
- PortalInstance Type Standard Large 
- standard.large
- PortalInstance Type Standard Xlarge 
- standard.xlarge
- StandardRegular 
- standard.regular
- StandardLarge 
- standard.large
- StandardXlarge 
- standard.xlarge
- StandardRegular 
- standard.regular
- StandardLarge 
- standard.large
- StandardXlarge 
- standard.xlarge
- STANDARD_REGULAR
- standard.regular
- STANDARD_LARGE
- standard.large
- STANDARD_XLARGE
- standard.xlarge
- "standard.regular"
- standard.regular
- "standard.large"
- standard.large
- "standard.xlarge"
- standard.xlarge
PortalRendererType, PortalRendererTypeArgs      
- AppStream 
- AppStream
- PortalRenderer Type App Stream 
- AppStream
- AppStream 
- AppStream
- AppStream 
- AppStream
- APP_STREAM
- AppStream
- "AppStream" 
- AppStream
PortalStatus, PortalStatusArgs    
- Incomplete
- Incomplete
- Pending
- Pending
- Active
- Active
- PortalStatus Incomplete 
- Incomplete
- PortalStatus Pending 
- Pending
- PortalStatus Active 
- Active
- Incomplete
- Incomplete
- Pending
- Pending
- Active
- Active
- Incomplete
- Incomplete
- Pending
- Pending
- Active
- Active
- INCOMPLETE
- Incomplete
- PENDING
- Pending
- ACTIVE
- Active
- "Incomplete"
- Incomplete
- "Pending"
- Pending
- "Active"
- Active
Tag, TagArgs  
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.