AWS v7.7.0, Sep 5 25

AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi

aws.workspacesweb.UserSettingsAssociation

Explore with Pulumi AI

AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi

pulumi/pulumi-aws

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.workspacesweb.Portal("example", {displayName: "example"});
const exampleUserSettings = new aws.workspacesweb.UserSettings("example", {
    copyAllowed: "Enabled",
    downloadAllowed: "Enabled",
    pasteAllowed: "Enabled",
    printAllowed: "Enabled",
    uploadAllowed: "Enabled",
});
const exampleUserSettingsAssociation = new aws.workspacesweb.UserSettingsAssociation("example", {
    userSettingsArn: exampleUserSettings.userSettingsArn,
    portalArn: example.portalArn,
});

import pulumi
import pulumi_aws as aws

example = aws.workspacesweb.Portal("example", display_name="example")
example_user_settings = aws.workspacesweb.UserSettings("example",
    copy_allowed="Enabled",
    download_allowed="Enabled",
    paste_allowed="Enabled",
    print_allowed="Enabled",
    upload_allowed="Enabled")
example_user_settings_association = aws.workspacesweb.UserSettingsAssociation("example",
    user_settings_arn=example_user_settings.user_settings_arn,
    portal_arn=example.portal_arn)

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/workspacesweb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := workspacesweb.NewPortal(ctx, "example", &workspacesweb.PortalArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleUserSettings, err := workspacesweb.NewUserSettings(ctx, "example", &workspacesweb.UserSettingsArgs{
			CopyAllowed:     pulumi.String("Enabled"),
			DownloadAllowed: pulumi.String("Enabled"),
			PasteAllowed:    pulumi.String("Enabled"),
			PrintAllowed:    pulumi.String("Enabled"),
			UploadAllowed:   pulumi.String("Enabled"),
		})
		if err != nil {
			return err
		}
		_, err = workspacesweb.NewUserSettingsAssociation(ctx, "example", &workspacesweb.UserSettingsAssociationArgs{
			UserSettingsArn: exampleUserSettings.UserSettingsArn,
			PortalArn:       example.PortalArn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.WorkSpacesWeb.Portal("example", new()
    {
        DisplayName = "example",
    });

    var exampleUserSettings = new Aws.WorkSpacesWeb.UserSettings("example", new()
    {
        CopyAllowed = "Enabled",
        DownloadAllowed = "Enabled",
        PasteAllowed = "Enabled",
        PrintAllowed = "Enabled",
        UploadAllowed = "Enabled",
    });

    var exampleUserSettingsAssociation = new Aws.WorkSpacesWeb.UserSettingsAssociation("example", new()
    {
        UserSettingsArn = exampleUserSettings.UserSettingsArn,
        PortalArn = example.PortalArn,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workspacesweb.Portal;
import com.pulumi.aws.workspacesweb.PortalArgs;
import com.pulumi.aws.workspacesweb.UserSettings;
import com.pulumi.aws.workspacesweb.UserSettingsArgs;
import com.pulumi.aws.workspacesweb.UserSettingsAssociation;
import com.pulumi.aws.workspacesweb.UserSettingsAssociationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Portal("example", PortalArgs.builder()
            .displayName("example")
            .build());

        var exampleUserSettings = new UserSettings("exampleUserSettings", UserSettingsArgs.builder()
            .copyAllowed("Enabled")
            .downloadAllowed("Enabled")
            .pasteAllowed("Enabled")
            .printAllowed("Enabled")
            .uploadAllowed("Enabled")
            .build());

        var exampleUserSettingsAssociation = new UserSettingsAssociation("exampleUserSettingsAssociation", UserSettingsAssociationArgs.builder()
            .userSettingsArn(exampleUserSettings.userSettingsArn())
            .portalArn(example.portalArn())
            .build());

    }
}

resources:
  example:
    type: aws:workspacesweb:Portal
    properties:
      displayName: example
  exampleUserSettings:
    type: aws:workspacesweb:UserSettings
    name: example
    properties:
      copyAllowed: Enabled
      downloadAllowed: Enabled
      pasteAllowed: Enabled
      printAllowed: Enabled
      uploadAllowed: Enabled
  exampleUserSettingsAssociation:
    type: aws:workspacesweb:UserSettingsAssociation
    name: example
    properties:
      userSettingsArn: ${exampleUserSettings.userSettingsArn}
      portalArn: ${example.portalArn}

Create UserSettingsAssociation Resource

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

Constructor syntax

new UserSettingsAssociation(name: string, args: UserSettingsAssociationArgs, opts?: CustomResourceOptions);

@overload
def UserSettingsAssociation(resource_name: str,
                            args: UserSettingsAssociationArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def UserSettingsAssociation(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            portal_arn: Optional[str] = None,
                            user_settings_arn: Optional[str] = None,
                            region: Optional[str] = None)

func NewUserSettingsAssociation(ctx *Context, name string, args UserSettingsAssociationArgs, opts ...ResourceOption) (*UserSettingsAssociation, error)

public UserSettingsAssociation(string name, UserSettingsAssociationArgs args, CustomResourceOptions? opts = null)

public UserSettingsAssociation(String name, UserSettingsAssociationArgs args)
public UserSettingsAssociation(String name, UserSettingsAssociationArgs args, CustomResourceOptions options)

type: aws:workspacesweb:UserSettingsAssociation
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 UserSettingsAssociationArgs: 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 UserSettingsAssociationArgs: 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 UserSettingsAssociationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UserSettingsAssociationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args UserSettingsAssociationArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var userSettingsAssociationResource = new Aws.WorkSpacesWeb.UserSettingsAssociation("userSettingsAssociationResource", new()
{
    PortalArn = "string",
    UserSettingsArn = "string",
    Region = "string",
});

example, err := workspacesweb.NewUserSettingsAssociation(ctx, "userSettingsAssociationResource", &workspacesweb.UserSettingsAssociationArgs{
	PortalArn:       pulumi.String("string"),
	UserSettingsArn: pulumi.String("string"),
	Region:          pulumi.String("string"),
})

var userSettingsAssociationResource = new UserSettingsAssociation("userSettingsAssociationResource", UserSettingsAssociationArgs.builder()
    .portalArn("string")
    .userSettingsArn("string")
    .region("string")
    .build());

user_settings_association_resource = aws.workspacesweb.UserSettingsAssociation("userSettingsAssociationResource",
    portal_arn="string",
    user_settings_arn="string",
    region="string")

const userSettingsAssociationResource = new aws.workspacesweb.UserSettingsAssociation("userSettingsAssociationResource", {
    portalArn: "string",
    userSettingsArn: "string",
    region: "string",
});

type: aws:workspacesweb:UserSettingsAssociation
properties:
    portalArn: string
    region: string
    userSettingsArn: string

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

PortalArn string

ARN of the portal to associate with the user settings. Forces replacement if changed.

The following arguments are optional:

UserSettingsArn string

ARN of the user settings to associate with the portal. Forces replacement if changed.

Region string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

PortalArn string

ARN of the portal to associate with the user settings. Forces replacement if changed.

The following arguments are optional:

UserSettingsArn string

ARN of the user settings to associate with the portal. Forces replacement if changed.

Region string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

portalArn String

ARN of the portal to associate with the user settings. Forces replacement if changed.

The following arguments are optional:

userSettingsArn String

ARN of the user settings to associate with the portal. Forces replacement if changed.

region String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

portalArn string

ARN of the portal to associate with the user settings. Forces replacement if changed.

The following arguments are optional:

userSettingsArn string

ARN of the user settings to associate with the portal. Forces replacement if changed.

region string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

portal_arn str

ARN of the portal to associate with the user settings. Forces replacement if changed.

The following arguments are optional:

user_settings_arn str

ARN of the user settings to associate with the portal. Forces replacement if changed.

region str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

portalArn String

ARN of the portal to associate with the user settings. Forces replacement if changed.

The following arguments are optional:

userSettingsArn String

ARN of the user settings to associate with the portal. Forces replacement if changed.

region String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing UserSettingsAssociation Resource

Get an existing UserSettingsAssociation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UserSettingsAssociationState, opts?: CustomResourceOptions): UserSettingsAssociation

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        portal_arn: Optional[str] = None,
        region: Optional[str] = None,
        user_settings_arn: Optional[str] = None) -> UserSettingsAssociation

func GetUserSettingsAssociation(ctx *Context, name string, id IDInput, state *UserSettingsAssociationState, opts ...ResourceOption) (*UserSettingsAssociation, error)

public static UserSettingsAssociation Get(string name, Input<string> id, UserSettingsAssociationState? state, CustomResourceOptions? opts = null)

public static UserSettingsAssociation get(String name, Output<String> id, UserSettingsAssociationState state, CustomResourceOptions options)

resources:  _:    type: aws:workspacesweb:UserSettingsAssociation    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

PortalArn string

ARN of the portal to associate with the user settings. Forces replacement if changed.

The following arguments are optional:

Region string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

UserSettingsArn string

ARN of the user settings to associate with the portal. Forces replacement if changed.

PortalArn string

ARN of the portal to associate with the user settings. Forces replacement if changed.

The following arguments are optional:

Region string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

UserSettingsArn string

ARN of the user settings to associate with the portal. Forces replacement if changed.

portalArn String

ARN of the portal to associate with the user settings. Forces replacement if changed.

The following arguments are optional:

region String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

userSettingsArn String

ARN of the user settings to associate with the portal. Forces replacement if changed.

portalArn string

ARN of the portal to associate with the user settings. Forces replacement if changed.

The following arguments are optional:

region string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

userSettingsArn string

ARN of the user settings to associate with the portal. Forces replacement if changed.

portal_arn str

ARN of the portal to associate with the user settings. Forces replacement if changed.

The following arguments are optional:

region str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

user_settings_arn str

ARN of the user settings to associate with the portal. Forces replacement if changed.

portalArn String

ARN of the portal to associate with the user settings. Forces replacement if changed.

The following arguments are optional:

region String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

userSettingsArn String

ARN of the user settings to associate with the portal. Forces replacement if changed.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi

pulumi/pulumi-aws

aws.workspacesweb.UserSettingsAssociation

On this page

On this page

Example Usage

Basic Usage

Create UserSettingsAssociation Resource

Constructor syntax

Parameters

Constructor example

UserSettingsAssociation Resource Properties

Inputs

Outputs

Look up Existing UserSettingsAssociation Resource

Package Details

On this page

On this page