awsworkspacesthinclient

README

AWS::WorkSpacesThinClient Construct Library

---

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

---

This module is part of the AWS Cloud Development Kit project.

import workspacesthinclient "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for WorkSpacesThinClient construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::WorkSpacesThinClient resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::WorkSpacesThinClient.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

• func CfnEnvironment_CFN_RESOURCE_TYPE_NAME() *string
• func CfnEnvironment_IsCfnElement(x interface{}) *bool
• func CfnEnvironment_IsCfnResource(x interface{}) *bool
• func CfnEnvironment_IsConstruct(x interface{}) *bool
• func NewCfnEnvironment_Override(c CfnEnvironment, scope constructs.Construct, id *string, ...)
• type CfnEnvironment
  • func NewCfnEnvironment(scope constructs.Construct, id *string, props *CfnEnvironmentProps) CfnEnvironment
• type CfnEnvironmentProps
• type CfnEnvironment_MaintenanceWindowProperty

Functions

func CfnEnvironment_CFN_RESOURCE_TYPE_NAME

func CfnEnvironment_CFN_RESOURCE_TYPE_NAME() *string

func CfnEnvironment_IsCfnElement

func CfnEnvironment_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnEnvironment_IsCfnResource

func CfnEnvironment_IsCfnResource(x interface{}) *bool

Check whether the given object is a CfnResource.

func CfnEnvironment_IsConstruct

func CfnEnvironment_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func NewCfnEnvironment_Override

func NewCfnEnvironment_Override(c CfnEnvironment, scope constructs.Construct, id *string, props *CfnEnvironmentProps)

Types

type CfnEnvironment

type CfnEnvironment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// Activation code for devices associated with environment.
	AttrActivationCode() *string
	// The environment ARN.
	AttrArn() *string
	// The timestamp in unix epoch format when environment was created.
	AttrCreatedAt() *string
	// The type of VDI.
	AttrDesktopType() *string
	// Unique identifier of the environment.
	AttrId() *string
	// The ID of the software set that is pending to be installed.
	AttrPendingSoftwareSetId() *string
	// The version of the software set that is pending to be installed.
	AttrPendingSoftwareSetVersion() *string
	// Number of devices registered to the environment.
	AttrRegisteredDevicesCount() *float64
	// Describes if the software currently installed on all devices in the environment is a supported version.
	AttrSoftwareSetComplianceStatus() *string
	// The timestamp in unix epoch format when environment was last updated.
	AttrUpdatedAt() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The ID of the software set to apply.
	DesiredSoftwareSetId() *string
	SetDesiredSoftwareSetId(val *string)
	// The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
	DesktopArn() *string
	SetDesktopArn(val *string)
	// The URL for the identity provider login (only for environments that use AppStream 2.0).
	DesktopEndpoint() *string
	SetDesktopEndpoint(val *string)
	// The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
	KmsKeyArn() *string
	SetKmsKeyArn(val *string)
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	MaintenanceWindow() interface{}
	SetMaintenanceWindow(val interface{})
	// The name of the environment.
	Name() *string
	SetName(val *string)
	// The tree node.
	Node() constructs.Node
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// An option to define which software updates to apply.
	SoftwareSetUpdateMode() *string
	SetSoftwareSetUpdateMode(val *string)
	// An option to define if software updates should be applied within a maintenance window.
	SoftwareSetUpdateSchedule() *string
	SetSoftwareSetUpdateSchedule(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// An array of key-value pairs to apply to this resource.
	Tags() *[]*awscdk.CfnTag
	SetTags(val *[]*awscdk.CfnTag)
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//   "GlobalSecondaryIndexes": [
	//     {
	//       "Projection": {
	//         "NonKeyAttributes": [ "myattribute" ]
	//         ...
	//       }
	//       ...
	//     },
	//     {
	//       "ProjectionType": "INCLUDE"
	//       ...
	//     },
	//   ]
	//   ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

Resource type definition for AWS::WorkSpacesThinClient::Environment.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnEnvironment := awscdk.Aws_workspacesthinclient.NewCfnEnvironment(this, jsii.String("MyCfnEnvironment"), &CfnEnvironmentProps{
	DesktopArn: jsii.String("desktopArn"),

	// the properties below are optional
	DesiredSoftwareSetId: jsii.String("desiredSoftwareSetId"),
	DesktopEndpoint: jsii.String("desktopEndpoint"),
	KmsKeyArn: jsii.String("kmsKeyArn"),
	MaintenanceWindow: &MaintenanceWindowProperty{
		Type: jsii.String("type"),

		// the properties below are optional
		ApplyTimeOf: jsii.String("applyTimeOf"),
		DaysOfTheWeek: []*string{
			jsii.String("daysOfTheWeek"),
		},
		EndTimeHour: jsii.Number(123),
		EndTimeMinute: jsii.Number(123),
		StartTimeHour: jsii.Number(123),
		StartTimeMinute: jsii.Number(123),
	},
	Name: jsii.String("name"),
	SoftwareSetUpdateMode: jsii.String("softwareSetUpdateMode"),
	SoftwareSetUpdateSchedule: jsii.String("softwareSetUpdateSchedule"),
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
})

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html

func NewCfnEnvironment

func NewCfnEnvironment(scope constructs.Construct, id *string, props *CfnEnvironmentProps) CfnEnvironment

type CfnEnvironmentProps

type CfnEnvironmentProps struct {
	// The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-desktoparn
	//
	DesktopArn *string `field:"required" json:"desktopArn" yaml:"desktopArn"`
	// The ID of the software set to apply.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-desiredsoftwaresetid
	//
	DesiredSoftwareSetId *string `field:"optional" json:"desiredSoftwareSetId" yaml:"desiredSoftwareSetId"`
	// The URL for the identity provider login (only for environments that use AppStream 2.0).
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-desktopendpoint
	//
	DesktopEndpoint *string `field:"optional" json:"desktopEndpoint" yaml:"desktopEndpoint"`
	// The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-kmskeyarn
	//
	KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"`
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-maintenancewindow
	//
	MaintenanceWindow interface{} `field:"optional" json:"maintenanceWindow" yaml:"maintenanceWindow"`
	// The name of the environment.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-name
	//
	Name *string `field:"optional" json:"name" yaml:"name"`
	// An option to define which software updates to apply.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-softwaresetupdatemode
	//
	SoftwareSetUpdateMode *string `field:"optional" json:"softwareSetUpdateMode" yaml:"softwareSetUpdateMode"`
	// An option to define if software updates should be applied within a maintenance window.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-softwaresetupdateschedule
	//
	SoftwareSetUpdateSchedule *string `field:"optional" json:"softwareSetUpdateSchedule" yaml:"softwareSetUpdateSchedule"`
	// An array of key-value pairs to apply to this resource.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html#cfn-workspacesthinclient-environment-tags
	//
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnEnvironment`.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnEnvironmentProps := &CfnEnvironmentProps{
	DesktopArn: jsii.String("desktopArn"),

	// the properties below are optional
	DesiredSoftwareSetId: jsii.String("desiredSoftwareSetId"),
	DesktopEndpoint: jsii.String("desktopEndpoint"),
	KmsKeyArn: jsii.String("kmsKeyArn"),
	MaintenanceWindow: &MaintenanceWindowProperty{
		Type: jsii.String("type"),

		// the properties below are optional
		ApplyTimeOf: jsii.String("applyTimeOf"),
		DaysOfTheWeek: []*string{
			jsii.String("daysOfTheWeek"),
		},
		EndTimeHour: jsii.Number(123),
		EndTimeMinute: jsii.Number(123),
		StartTimeHour: jsii.Number(123),
		StartTimeMinute: jsii.Number(123),
	},
	Name: jsii.String("name"),
	SoftwareSetUpdateMode: jsii.String("softwareSetUpdateMode"),
	SoftwareSetUpdateSchedule: jsii.String("softwareSetUpdateSchedule"),
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesthinclient-environment.html

type CfnEnvironment_MaintenanceWindowProperty

type CfnEnvironment_MaintenanceWindowProperty struct {
	// The type of maintenance window.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesthinclient-environment-maintenancewindow.html#cfn-workspacesthinclient-environment-maintenancewindow-type
	//
	Type *string `field:"required" json:"type" yaml:"type"`
	// The desired time zone maintenance window.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesthinclient-environment-maintenancewindow.html#cfn-workspacesthinclient-environment-maintenancewindow-applytimeof
	//
	ApplyTimeOf *string `field:"optional" json:"applyTimeOf" yaml:"applyTimeOf"`
	// The date of maintenance window.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesthinclient-environment-maintenancewindow.html#cfn-workspacesthinclient-environment-maintenancewindow-daysoftheweek
	//
	DaysOfTheWeek *[]*string `field:"optional" json:"daysOfTheWeek" yaml:"daysOfTheWeek"`
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesthinclient-environment-maintenancewindow.html#cfn-workspacesthinclient-environment-maintenancewindow-endtimehour
	//
	EndTimeHour *float64 `field:"optional" json:"endTimeHour" yaml:"endTimeHour"`
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesthinclient-environment-maintenancewindow.html#cfn-workspacesthinclient-environment-maintenancewindow-endtimeminute
	//
	EndTimeMinute *float64 `field:"optional" json:"endTimeMinute" yaml:"endTimeMinute"`
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesthinclient-environment-maintenancewindow.html#cfn-workspacesthinclient-environment-maintenancewindow-starttimehour
	//
	StartTimeHour *float64 `field:"optional" json:"startTimeHour" yaml:"startTimeHour"`
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesthinclient-environment-maintenancewindow.html#cfn-workspacesthinclient-environment-maintenancewindow-starttimeminute
	//
	StartTimeMinute *float64 `field:"optional" json:"startTimeMinute" yaml:"startTimeMinute"`
}

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

maintenanceWindowProperty := &MaintenanceWindowProperty{
	Type: jsii.String("type"),

	// the properties below are optional
	ApplyTimeOf: jsii.String("applyTimeOf"),
	DaysOfTheWeek: []*string{
		jsii.String("daysOfTheWeek"),
	},
	EndTimeHour: jsii.Number(123),
	EndTimeMinute: jsii.Number(123),
	StartTimeHour: jsii.Number(123),
	StartTimeMinute: jsii.Number(123),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesthinclient-environment-maintenancewindow.html