Module workspaces

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Data Sources

Others

Resources

Resource Directory

class Directory extends CustomResource

Provides a directory registration in AWS WorkSpaces Service

Example Usage

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

const mainVpc = new aws.ec2.Vpc("main", {
    cidrBlock: "10.0.0.0/16",
});
const privateA = new aws.ec2.Subnet("private-a", {
    availabilityZone: "us-east-1a",
    cidrBlock: "10.0.0.0/24",
    vpcId: mainVpc.id,
});
const privateB = new aws.ec2.Subnet("private-b", {
    availabilityZone: "us-east-1b",
    cidrBlock: "10.0.1.0/24",
    vpcId: mainVpc.id,
});
const mainDirectory = new aws.directoryservice.Directory("main", {
    password: "#S1ncerely",
    size: "Small",
    vpcSettings: {
        subnetIds: [
            private_a.id,
            private_b.id,
        ],
        vpcId: mainVpc.id,
    },
});
const mainWorkspacesDirectory = new aws.workspaces.Directory("main", {
    directoryId: mainDirectory.id,
    selfServicePermissions: {
        increaseVolumeSize: true,
        rebuildWorkspace: true,
    },
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/workspaces_directory.html.markdown.

constructor

new Directory(name: string, args: DirectoryArgs, opts?: pulumi.CustomResourceOptions)

Create a Directory resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DirectoryState, opts?: pulumi.CustomResourceOptions): Directory

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Directory

Returns true if the given object is an instance of Directory. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property directoryId

public directoryId: pulumi.Output<string>;

The directory identifier for registration in WorkSpaces service.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property selfServicePermissions

public selfServicePermissions: pulumi.Output<DirectorySelfServicePermissions>;

The permissions to enable or disable self-service capabilities.

property subnetIds

public subnetIds: pulumi.Output<string[]>;

The identifiers of the subnets where the directory resides.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags assigned to the WorkSpaces directory.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource IpGroup

class IpGroup extends CustomResource

Provides an IP access control group in AWS WorkSpaces Service

Example Usage

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

const contractors = new aws.workspaces.IpGroup("contractors", {
    description: "Contractors IP access control group",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/workspaces_ip_group.html.markdown.

constructor

new IpGroup(name: string, args?: IpGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a IpGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IpGroupState, opts?: pulumi.CustomResourceOptions): IpGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IpGroup

Returns true if the given object is an instance of IpGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

The description.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the IP group.

property rules

public rules: pulumi.Output<IpGroupRule[] | undefined>;

One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Data Sources

Data Source getBundle

getBundle(args: GetBundleArgs, opts?: pulumi.InvokeOptions): Promise<GetBundleResult> & GetBundleResult

Use this data source to get information about a WorkSpaces Bundle.

Example Usage

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

const example = aws.workspaces.getBundle({
    bundleId: "wsb-b0s22j3d7",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/workspaces_bundle.html.markdown.

Others

interface DirectoryArgs

interface DirectoryArgs

The set of arguments for constructing a Directory resource.

property directoryId

directoryId: pulumi.Input<string>;

The directory identifier for registration in WorkSpaces service.

property selfServicePermissions

selfServicePermissions?: pulumi.Input<DirectorySelfServicePermissions>;

The permissions to enable or disable self-service capabilities.

property subnetIds

subnetIds?: pulumi.Input<pulumi.Input<string>[]>;

The identifiers of the subnets where the directory resides.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags assigned to the WorkSpaces directory.

interface DirectoryState

interface DirectoryState

Input properties used for looking up and filtering Directory resources.

property directoryId

directoryId?: pulumi.Input<string>;

The directory identifier for registration in WorkSpaces service.

property selfServicePermissions

selfServicePermissions?: pulumi.Input<DirectorySelfServicePermissions>;

The permissions to enable or disable self-service capabilities.

property subnetIds

subnetIds?: pulumi.Input<pulumi.Input<string>[]>;

The identifiers of the subnets where the directory resides.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags assigned to the WorkSpaces directory.

interface GetBundleArgs

interface GetBundleArgs

A collection of arguments for invoking getBundle.

property bundleId

bundleId: string;

The ID of the bundle.

interface GetBundleResult

interface GetBundleResult

A collection of values returned by getBundle.

property bundleId

bundleId: string;

property computeTypes

computeTypes: GetBundleComputeType[];

The compute type. See supported fields below.

property description

description: string;

The description of the bundle.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property name

name: string;

The name of the compute type.

property owner

owner: string;

The owner of the bundle.

property rootStorages

rootStorages: GetBundleRootStorage[];

The root volume. See supported fields below.

property userStorages

userStorages: GetBundleUserStorage[];

The user storage. See supported fields below.

interface IpGroupArgs

interface IpGroupArgs

The set of arguments for constructing a IpGroup resource.

property description

description?: pulumi.Input<string>;

The description.

property name

name?: pulumi.Input<string>;

The name of the IP group.

property rules

rules?: pulumi.Input<pulumi.Input<IpGroupRule>[]>;

One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

interface IpGroupState

interface IpGroupState

Input properties used for looking up and filtering IpGroup resources.

property description

description?: pulumi.Input<string>;

The description.

property name

name?: pulumi.Input<string>;

The name of the IP group.

property rules

rules?: pulumi.Input<pulumi.Input<IpGroupRule>[]>;

One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate.

property tags

tags?: pulumi.Input<{[key: string]: any}>;