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

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.workspacesweb.UserSettings

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::WorkSpacesWeb::UserSettings Resource Type

    Create UserSettings Resource

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

    Constructor syntax

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

@overload
def UserSettings(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 copy_allowed: Optional[UserSettingsEnabledType] = None,
                 download_allowed: Optional[UserSettingsEnabledType] = None,
                 paste_allowed: Optional[UserSettingsEnabledType] = None,
                 print_allowed: Optional[UserSettingsEnabledType] = None,
                 upload_allowed: Optional[UserSettingsEnabledType] = None,
                 additional_encryption_context: Optional[Mapping[str, str]] = None,
                 cookie_synchronization_configuration: Optional[UserSettingsCookieSynchronizationConfigurationArgs] = None,
                 customer_managed_key: Optional[str] = None,
                 deep_link_allowed: Optional[UserSettingsEnabledType] = None,
                 disconnect_timeout_in_minutes: Optional[float] = None,
                 idle_disconnect_timeout_in_minutes: Optional[float] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewUserSettings(ctx *Context, name string, args UserSettingsArgs, opts ...ResourceOption) (*UserSettings, error)
    public UserSettings(string name, UserSettingsArgs args, CustomResourceOptions? opts = null)
    public UserSettings(String name, UserSettingsArgs args)
public UserSettings(String name, UserSettingsArgs args, CustomResourceOptions options)

    type: aws-native:workspacesweb:UserSettings
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 UserSettingsArgs
    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 UserSettingsArgs
    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 UserSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserSettingsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    UserSettings 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 UserSettings resource accepts the following input properties:

    CopyAllowed Pulumi.AwsNative.WorkSpacesWeb.UserSettingsEnabledType
    Specifies whether the user can copy text from the streaming session to the local device.
    DownloadAllowed Pulumi.AwsNative.WorkSpacesWeb.UserSettingsEnabledType
    Specifies whether the user can download files from the streaming session to the local device.
    PasteAllowed Pulumi.AwsNative.WorkSpacesWeb.UserSettingsEnabledType
    Specifies whether the user can paste text from the local device to the streaming session.
    PrintAllowed Pulumi.AwsNative.WorkSpacesWeb.UserSettingsEnabledType
    Specifies whether the user can print to the local device.
    UploadAllowed Pulumi.AwsNative.WorkSpacesWeb.UserSettingsEnabledType
    Specifies whether the user can upload files from the local device to the streaming session.
    AdditionalEncryptionContext Dictionary<string, string>
    The additional encryption context of the user settings.
    CookieSynchronizationConfiguration Pulumi.AwsNative.WorkSpacesWeb.Inputs.UserSettingsCookieSynchronizationConfiguration
    The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
    CustomerManagedKey string
    The customer managed key used to encrypt sensitive information in the user settings.
    DeepLinkAllowed Pulumi.AwsNative.WorkSpacesWeb.UserSettingsEnabledType
    Specifies whether the user can use deep links that open automatically when connecting to a session.
    DisconnectTimeoutInMinutes double
    The amount of time that a streaming session remains active after users disconnect.
    IdleDisconnectTimeoutInMinutes double
    The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags to add to the user settings resource. A tag is a key-value pair.
    CopyAllowed UserSettingsEnabledType
    Specifies whether the user can copy text from the streaming session to the local device.
    DownloadAllowed UserSettingsEnabledType
    Specifies whether the user can download files from the streaming session to the local device.
    PasteAllowed UserSettingsEnabledType
    Specifies whether the user can paste text from the local device to the streaming session.
    PrintAllowed UserSettingsEnabledType
    Specifies whether the user can print to the local device.
    UploadAllowed UserSettingsEnabledType
    Specifies whether the user can upload files from the local device to the streaming session.
    AdditionalEncryptionContext map[string]string
    The additional encryption context of the user settings.
    CookieSynchronizationConfiguration UserSettingsCookieSynchronizationConfigurationArgs
    The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
    CustomerManagedKey string
    The customer managed key used to encrypt sensitive information in the user settings.
    DeepLinkAllowed UserSettingsEnabledType
    Specifies whether the user can use deep links that open automatically when connecting to a session.
    DisconnectTimeoutInMinutes float64
    The amount of time that a streaming session remains active after users disconnect.
    IdleDisconnectTimeoutInMinutes float64
    The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
    Tags TagArgs
    The tags to add to the user settings resource. A tag is a key-value pair.
    copyAllowed UserSettingsEnabledType
    Specifies whether the user can copy text from the streaming session to the local device.
    downloadAllowed UserSettingsEnabledType
    Specifies whether the user can download files from the streaming session to the local device.
    pasteAllowed UserSettingsEnabledType
    Specifies whether the user can paste text from the local device to the streaming session.
    printAllowed UserSettingsEnabledType
    Specifies whether the user can print to the local device.
    uploadAllowed UserSettingsEnabledType
    Specifies whether the user can upload files from the local device to the streaming session.
    additionalEncryptionContext Map<String,String>
    The additional encryption context of the user settings.
    cookieSynchronizationConfiguration UserSettingsCookieSynchronizationConfiguration
    The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
    customerManagedKey String
    The customer managed key used to encrypt sensitive information in the user settings.
    deepLinkAllowed UserSettingsEnabledType
    Specifies whether the user can use deep links that open automatically when connecting to a session.
    disconnectTimeoutInMinutes Double
    The amount of time that a streaming session remains active after users disconnect.
    idleDisconnectTimeoutInMinutes Double
    The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
    tags List<Tag>
    The tags to add to the user settings resource. A tag is a key-value pair.
    copyAllowed UserSettingsEnabledType
    Specifies whether the user can copy text from the streaming session to the local device.
    downloadAllowed UserSettingsEnabledType
    Specifies whether the user can download files from the streaming session to the local device.
    pasteAllowed UserSettingsEnabledType
    Specifies whether the user can paste text from the local device to the streaming session.
    printAllowed UserSettingsEnabledType
    Specifies whether the user can print to the local device.
    uploadAllowed UserSettingsEnabledType
    Specifies whether the user can upload files from the local device to the streaming session.
    additionalEncryptionContext {[key: string]: string}
    The additional encryption context of the user settings.
    cookieSynchronizationConfiguration UserSettingsCookieSynchronizationConfiguration
    The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
    customerManagedKey string
    The customer managed key used to encrypt sensitive information in the user settings.
    deepLinkAllowed UserSettingsEnabledType
    Specifies whether the user can use deep links that open automatically when connecting to a session.
    disconnectTimeoutInMinutes number
    The amount of time that a streaming session remains active after users disconnect.
    idleDisconnectTimeoutInMinutes number
    The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
    tags Tag[]
    The tags to add to the user settings resource. A tag is a key-value pair.
    copy_allowed UserSettingsEnabledType
    Specifies whether the user can copy text from the streaming session to the local device.
    download_allowed UserSettingsEnabledType
    Specifies whether the user can download files from the streaming session to the local device.
    paste_allowed UserSettingsEnabledType
    Specifies whether the user can paste text from the local device to the streaming session.
    print_allowed UserSettingsEnabledType
    Specifies whether the user can print to the local device.
    upload_allowed UserSettingsEnabledType
    Specifies whether the user can upload files from the local device to the streaming session.
    additional_encryption_context Mapping[str, str]
    The additional encryption context of the user settings.
    cookie_synchronization_configuration UserSettingsCookieSynchronizationConfigurationArgs
    The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
    customer_managed_key str
    The customer managed key used to encrypt sensitive information in the user settings.
    deep_link_allowed UserSettingsEnabledType
    Specifies whether the user can use deep links that open automatically when connecting to a session.
    disconnect_timeout_in_minutes float
    The amount of time that a streaming session remains active after users disconnect.
    idle_disconnect_timeout_in_minutes float
    The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
    tags Sequence[TagArgs]
    The tags to add to the user settings resource. A tag is a key-value pair.
    copyAllowed "Disabled" | "Enabled"
    Specifies whether the user can copy text from the streaming session to the local device.
    downloadAllowed "Disabled" | "Enabled"
    Specifies whether the user can download files from the streaming session to the local device.
    pasteAllowed "Disabled" | "Enabled"
    Specifies whether the user can paste text from the local device to the streaming session.
    printAllowed "Disabled" | "Enabled"
    Specifies whether the user can print to the local device.
    uploadAllowed "Disabled" | "Enabled"
    Specifies whether the user can upload files from the local device to the streaming session.
    additionalEncryptionContext Map<String>
    The additional encryption context of the user settings.
    cookieSynchronizationConfiguration Property Map
    The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
    customerManagedKey String
    The customer managed key used to encrypt sensitive information in the user settings.
    deepLinkAllowed "Disabled" | "Enabled"
    Specifies whether the user can use deep links that open automatically when connecting to a session.
    disconnectTimeoutInMinutes Number
    The amount of time that a streaming session remains active after users disconnect.
    idleDisconnectTimeoutInMinutes Number
    The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
    tags List<Property Map>
    The tags to add to the user settings resource. A tag is a key-value pair.

    Outputs

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

    AssociatedPortalArns List<string>
    A list of web portal ARNs that this user settings resource is associated with.
    Id string
    The provider-assigned unique ID for this managed resource.
    UserSettingsArn string
    The ARN of the user settings.
    AssociatedPortalArns []string
    A list of web portal ARNs that this user settings resource is associated with.
    Id string
    The provider-assigned unique ID for this managed resource.
    UserSettingsArn string
    The ARN of the user settings.
    associatedPortalArns List<String>
    A list of web portal ARNs that this user settings resource is associated with.
    id String
    The provider-assigned unique ID for this managed resource.
    userSettingsArn String
    The ARN of the user settings.
    associatedPortalArns string[]
    A list of web portal ARNs that this user settings resource is associated with.
    id string
    The provider-assigned unique ID for this managed resource.
    userSettingsArn string
    The ARN of the user settings.
    associated_portal_arns Sequence[str]
    A list of web portal ARNs that this user settings resource is associated with.
    id str
    The provider-assigned unique ID for this managed resource.
    user_settings_arn str
    The ARN of the user settings.
    associatedPortalArns List<String>
    A list of web portal ARNs that this user settings resource is associated with.
    id String
    The provider-assigned unique ID for this managed resource.
    userSettingsArn String
    The ARN of the user settings.

    Supporting Types

    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

    UserSettingsCookieSpecification, UserSettingsCookieSpecificationArgs

    Domain string
    The domain of the cookie.
    Name string
    The name of the cookie.
    Path string
    The path of the cookie.
    Domain string
    The domain of the cookie.
    Name string
    The name of the cookie.
    Path string
    The path of the cookie.
    domain String
    The domain of the cookie.
    name String
    The name of the cookie.
    path String
    The path of the cookie.
    domain string
    The domain of the cookie.
    name string
    The name of the cookie.
    path string
    The path of the cookie.
    domain str
    The domain of the cookie.
    name str
    The name of the cookie.
    path str
    The path of the cookie.
    domain String
    The domain of the cookie.
    name String
    The name of the cookie.
    path String
    The path of the cookie.

    UserSettingsCookieSynchronizationConfiguration, UserSettingsCookieSynchronizationConfigurationArgs

    Allowlist List<Pulumi.AwsNative.WorkSpacesWeb.Inputs.UserSettingsCookieSpecification>
    The list of cookie specifications that are allowed to be synchronized to the remote browser.
    Blocklist List<Pulumi.AwsNative.WorkSpacesWeb.Inputs.UserSettingsCookieSpecification>
    The list of cookie specifications that are blocked from being synchronized to the remote browser.
    Allowlist []UserSettingsCookieSpecification
    The list of cookie specifications that are allowed to be synchronized to the remote browser.
    Blocklist []UserSettingsCookieSpecification
    The list of cookie specifications that are blocked from being synchronized to the remote browser.
    allowlist List<UserSettingsCookieSpecification>
    The list of cookie specifications that are allowed to be synchronized to the remote browser.
    blocklist List<UserSettingsCookieSpecification>
    The list of cookie specifications that are blocked from being synchronized to the remote browser.
    allowlist UserSettingsCookieSpecification[]
    The list of cookie specifications that are allowed to be synchronized to the remote browser.
    blocklist UserSettingsCookieSpecification[]
    The list of cookie specifications that are blocked from being synchronized to the remote browser.
    allowlist Sequence[UserSettingsCookieSpecification]
    The list of cookie specifications that are allowed to be synchronized to the remote browser.
    blocklist Sequence[UserSettingsCookieSpecification]
    The list of cookie specifications that are blocked from being synchronized to the remote browser.
    allowlist List<Property Map>
    The list of cookie specifications that are allowed to be synchronized to the remote browser.
    blocklist List<Property Map>
    The list of cookie specifications that are blocked from being synchronized to the remote browser.

    UserSettingsEnabledType, UserSettingsEnabledTypeArgs

    Disabled
    Disabled
    Enabled
    Enabled
    UserSettingsEnabledTypeDisabled
    Disabled
    UserSettingsEnabledTypeEnabled
    Enabled
    Disabled
    Disabled
    Enabled
    Enabled
    Disabled
    Disabled
    Enabled
    Enabled
    DISABLED
    Disabled
    ENABLED
    Enabled
    "Disabled"
    Disabled
    "Enabled"
    Enabled

    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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native