AWS Native is in preview. AWS Classic is fully supported.
aws-native.workspacesweb.Portal
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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,
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.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const aws_nativePortalResource = new aws_native.workspacesweb.Portal("aws-nativePortalResource", {
additionalEncryptionContext: {
string: "string",
},
authenticationType: aws_native.workspacesweb.PortalAuthenticationType.Standard,
browserSettingsArn: "string",
customerManagedKey: "string",
displayName: "string",
instanceType: aws_native.workspacesweb.PortalInstanceType.StandardRegular,
ipAccessSettingsArn: "string",
maxConcurrentSessions: 0,
networkSettingsArn: "string",
tags: [{
key: "string",
value: "string",
}],
trustStoreArn: "string",
userAccessLoggingSettingsArn: "string",
userSettingsArn: "string",
});
Coming soon!
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
The Portal resource accepts the following input properties:
- Additional
Encryption Dictionary<string, string>Context - Authentication
Type Pulumi.Aws Native. Work Spaces Web. Portal Authentication Type - Browser
Settings stringArn - Customer
Managed stringKey - Display
Name string - Instance
Type Pulumi.Aws Native. Work Spaces Web. Portal Instance Type - Ip
Access stringSettings Arn - Max
Concurrent doubleSessions - Network
Settings stringArn - List<Pulumi.
Aws Native. Inputs. Tag> - Trust
Store stringArn - User
Access stringLogging Settings Arn - User
Settings stringArn
- Additional
Encryption map[string]stringContext - Authentication
Type PortalAuthentication Type - Browser
Settings stringArn - Customer
Managed stringKey - Display
Name string - Instance
Type PortalInstance Type - Ip
Access stringSettings Arn - Max
Concurrent float64Sessions - Network
Settings stringArn - Tag
Args - Trust
Store stringArn - User
Access stringLogging Settings Arn - User
Settings stringArn
- additional
Encryption Map<String,String>Context - authentication
Type PortalAuthentication Type - browser
Settings StringArn - customer
Managed StringKey - display
Name String - instance
Type PortalInstance Type - ip
Access StringSettings Arn - max
Concurrent DoubleSessions - network
Settings StringArn - List<Tag>
- trust
Store StringArn - user
Access StringLogging Settings Arn - user
Settings StringArn
- additional
Encryption {[key: string]: string}Context - authentication
Type PortalAuthentication Type - browser
Settings stringArn - customer
Managed stringKey - display
Name string - instance
Type PortalInstance Type - ip
Access stringSettings Arn - max
Concurrent numberSessions - network
Settings stringArn - Tag[]
- trust
Store stringArn - user
Access stringLogging Settings Arn - user
Settings stringArn
- additional_
encryption_ Mapping[str, str]context - authentication_
type PortalAuthentication Type - browser_
settings_ strarn - customer_
managed_ strkey - display_
name str - instance_
type PortalInstance Type - ip_
access_ strsettings_ arn - max_
concurrent_ floatsessions - network_
settings_ strarn - Sequence[Tag
Args] - trust_
store_ strarn - user_
access_ strlogging_ settings_ arn - user_
settings_ strarn
- additional
Encryption Map<String>Context - authentication
Type "Standard" | "IAM_Identity_Center" - browser
Settings StringArn - customer
Managed StringKey - display
Name String - instance
Type "standard.regular" | "standard.large" | "standard.xlarge" - ip
Access StringSettings Arn - max
Concurrent NumberSessions - network
Settings StringArn - List<Property Map>
- trust
Store StringArn - user
Access StringLogging Settings Arn - user
Settings StringArn
Outputs
All input properties are implicitly available as output properties. Additionally, the Portal resource produces the following output properties:
- Browser
Type Pulumi.Aws Native. Work Spaces Web. Portal Browser Type - Creation
Date string - Id string
- The provider-assigned unique ID for this managed resource.
- Portal
Arn string - Portal
Endpoint string - Portal
Status Pulumi.Aws Native. Work Spaces Web. Portal Status - Renderer
Type Pulumi.Aws Native. Work Spaces Web. Portal Renderer Type - Service
Provider stringSaml Metadata - Status
Reason string
- Browser
Type PortalBrowser Type - Creation
Date string - Id string
- The provider-assigned unique ID for this managed resource.
- Portal
Arn string - Portal
Endpoint string - Portal
Status PortalStatus - Renderer
Type PortalRenderer Type - Service
Provider stringSaml Metadata - Status
Reason string
- browser
Type PortalBrowser Type - creation
Date String - id String
- The provider-assigned unique ID for this managed resource.
- portal
Arn String - portal
Endpoint String - portal
Status PortalStatus - renderer
Type PortalRenderer Type - service
Provider StringSaml Metadata - status
Reason String
- browser
Type PortalBrowser Type - creation
Date string - id string
- The provider-assigned unique ID for this managed resource.
- portal
Arn string - portal
Endpoint string - portal
Status PortalStatus - renderer
Type PortalRenderer Type - service
Provider stringSaml Metadata - status
Reason string
- browser_
type PortalBrowser Type - creation_
date str - id str
- The provider-assigned unique ID for this managed resource.
- portal_
arn str - portal_
endpoint str - portal_
status PortalStatus - renderer_
type PortalRenderer Type - service_
provider_ strsaml_ metadata - status_
reason str
- browser
Type "Chrome" - creation
Date String - id String
- The provider-assigned unique ID for this managed resource.
- portal
Arn String - portal
Endpoint String - portal
Status "Incomplete" | "Pending" | "Active" - renderer
Type "AppStream" - service
Provider StringSaml Metadata - status
Reason String
Supporting Types
PortalAuthenticationType, PortalAuthenticationTypeArgs
- Standard
- Standard
- Iam
Identity Center - IAM_Identity_Center
- Portal
Authentication Type Standard - Standard
- Portal
Authentication Type Iam Identity Center - IAM_Identity_Center
- Standard
- Standard
- Iam
Identity Center - IAM_Identity_Center
- Standard
- Standard
- Iam
Identity Center - IAM_Identity_Center
- STANDARD
- Standard
- IAM_IDENTITY_CENTER
- IAM_Identity_Center
- "Standard"
- Standard
- "IAM_Identity_Center"
- IAM_Identity_Center
PortalBrowserType, PortalBrowserTypeArgs
- Chrome
- Chrome
- Portal
Browser Type Chrome - Chrome
- Chrome
- Chrome
- Chrome
- Chrome
- CHROME
- Chrome
- "Chrome"
- Chrome
PortalInstanceType, PortalInstanceTypeArgs
- Standard
Regular - standard.regular
- Standard
Large - standard.large
- Standard
Xlarge - standard.xlarge
- Portal
Instance Type Standard Regular - standard.regular
- Portal
Instance Type Standard Large - standard.large
- Portal
Instance Type Standard Xlarge - 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
- 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
- App
Stream - AppStream
- Portal
Renderer Type App Stream - AppStream
- App
Stream - AppStream
- App
Stream - AppStream
- APP_STREAM
- AppStream
- "App
Stream" - AppStream
PortalStatus, PortalStatusArgs
- Incomplete
- Incomplete
- Pending
- Pending
- Active
- Active
- Portal
Status Incomplete - Incomplete
- Portal
Status Pending - Pending
- Portal
Status 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
AWS Native is in preview. AWS Classic is fully supported.