1. Packages
  2. AWS Native
  3. API Docs
  4. workspacesweb
  5. Portal

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

aws-native.workspacesweb.Portal

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

    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:

    Outputs

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

    Supporting Types

    PortalAuthenticationType, PortalAuthenticationTypeArgs

    Standard
    Standard
    IamIdentityCenter
    IAM_Identity_Center
    PortalAuthenticationTypeStandard
    Standard
    PortalAuthenticationTypeIamIdentityCenter
    IAM_Identity_Center
    Standard
    Standard
    IamIdentityCenter
    IAM_Identity_Center
    Standard
    Standard
    IamIdentityCenter
    IAM_Identity_Center
    STANDARD
    Standard
    IAM_IDENTITY_CENTER
    IAM_Identity_Center
    "Standard"
    Standard
    "IAM_Identity_Center"
    IAM_Identity_Center

    PortalBrowserType, PortalBrowserTypeArgs

    Chrome
    Chrome
    PortalBrowserTypeChrome
    Chrome
    Chrome
    Chrome
    Chrome
    Chrome
    CHROME
    Chrome
    "Chrome"
    Chrome

    PortalInstanceType, PortalInstanceTypeArgs

    StandardRegular
    standard.regular
    StandardLarge
    standard.large
    StandardXlarge
    standard.xlarge
    PortalInstanceTypeStandardRegular
    standard.regular
    PortalInstanceTypeStandardLarge
    standard.large
    PortalInstanceTypeStandardXlarge
    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
    PortalRendererTypeAppStream
    AppStream
    AppStream
    AppStream
    AppStream
    AppStream
    APP_STREAM
    AppStream
    "AppStream"
    AppStream

    PortalStatus, PortalStatusArgs

    Incomplete
    Incomplete
    Pending
    Pending
    Active
    Active
    PortalStatusIncomplete
    Incomplete
    PortalStatusPending
    Pending
    PortalStatusActive
    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

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi