UNPKG

@pulumi/aws

Version:

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

104 lines (103 loc) 4.32 kB
import * as pulumi from "@pulumi/pulumi"; /** * Resource for managing an AWS WorkSpaces Web User Settings Association. * * ## Example Usage * * ### Basic Usage * * ```typescript * 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, * }); * ``` */ export declare class UserSettingsAssociation extends pulumi.CustomResource { /** * Get an existing UserSettingsAssociation resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserSettingsAssociationState, opts?: pulumi.CustomResourceOptions): UserSettingsAssociation; /** * Returns true if the given object is an instance of UserSettingsAssociation. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is UserSettingsAssociation; /** * ARN of the portal to associate with the user settings. Forces replacement if changed. * * The following arguments are optional: */ readonly portalArn: pulumi.Output<string>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ readonly region: pulumi.Output<string>; /** * ARN of the user settings to associate with the portal. Forces replacement if changed. */ readonly userSettingsArn: pulumi.Output<string>; /** * Create a UserSettingsAssociation resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: UserSettingsAssociationArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering UserSettingsAssociation resources. */ export interface UserSettingsAssociationState { /** * ARN of the portal to associate with the user settings. Forces replacement if changed. * * The following arguments are optional: */ portalArn?: pulumi.Input<string>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input<string>; /** * ARN of the user settings to associate with the portal. Forces replacement if changed. */ userSettingsArn?: pulumi.Input<string>; } /** * The set of arguments for constructing a UserSettingsAssociation resource. */ export interface UserSettingsAssociationArgs { /** * ARN of the portal to associate with the user settings. Forces replacement if changed. * * The following arguments are optional: */ portalArn: pulumi.Input<string>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input<string>; /** * ARN of the user settings to associate with the portal. Forces replacement if changed. */ userSettingsArn: pulumi.Input<string>; }