awsworkspaces

Documentation

Index

• func CfnConnectionAlias_CFN_RESOURCE_TYPE_NAME() *string
• func CfnConnectionAlias_IsCfnElement(x interface{}) *bool
• func CfnConnectionAlias_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnConnectionAlias_IsConstruct(x interface{}) *bool
• func CfnWorkspace_CFN_RESOURCE_TYPE_NAME() *string
• func CfnWorkspace_IsCfnElement(x interface{}) *bool
• func CfnWorkspace_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnWorkspace_IsConstruct(x interface{}) *bool
• func NewCfnConnectionAlias_Override(c CfnConnectionAlias, scope awscdk.Construct, id *string, ...)
• func NewCfnWorkspace_Override(c CfnWorkspace, scope awscdk.Construct, id *string, props *CfnWorkspaceProps)
• type CfnConnectionAlias
  • func NewCfnConnectionAlias(scope awscdk.Construct, id *string, props *CfnConnectionAliasProps) CfnConnectionAlias
• type CfnConnectionAliasProps
• type CfnConnectionAlias_ConnectionAliasAssociationProperty
• type CfnWorkspace
  • func NewCfnWorkspace(scope awscdk.Construct, id *string, props *CfnWorkspaceProps) CfnWorkspace
• type CfnWorkspaceProps
• type CfnWorkspace_WorkspacePropertiesProperty

Functions

func CfnConnectionAlias_CFN_RESOURCE_TYPE_NAME

func CfnConnectionAlias_CFN_RESOURCE_TYPE_NAME() *string

func CfnConnectionAlias_IsCfnElement

func CfnConnectionAlias_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. Experimental.

func CfnConnectionAlias_IsCfnResource

func CfnConnectionAlias_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnConnectionAlias_IsConstruct

func CfnConnectionAlias_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnWorkspace_CFN_RESOURCE_TYPE_NAME

func CfnWorkspace_CFN_RESOURCE_TYPE_NAME() *string

func CfnWorkspace_IsCfnElement

func CfnWorkspace_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. Experimental.

func CfnWorkspace_IsCfnResource

func CfnWorkspace_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnWorkspace_IsConstruct

func CfnWorkspace_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnConnectionAlias_Override

func NewCfnConnectionAlias_Override(c CfnConnectionAlias, scope awscdk.Construct, id *string, props *CfnConnectionAliasProps)

Create a new `AWS::WorkSpaces::ConnectionAlias`.

func NewCfnWorkspace_Override

func NewCfnWorkspace_Override(c CfnWorkspace, scope awscdk.Construct, id *string, props *CfnWorkspaceProps)

Create a new `AWS::WorkSpaces::Workspace`.

Types

type CfnConnectionAlias

type CfnConnectionAlias interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrAliasId() *string
	AttrAssociations() awscdk.IResolvable
	AttrConnectionAliasState() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConnectionString() *string
	SetConnectionString(val *string)
	CreationStack() *[]*string
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::WorkSpaces::ConnectionAlias`.

The `AWS::WorkSpaces::ConnectionAlias` resource specifies a connection alias. Connection aliases are used for cross-Region redirection. For more information, see [Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) .

TODO: EXAMPLE

func NewCfnConnectionAlias

func NewCfnConnectionAlias(scope awscdk.Construct, id *string, props *CfnConnectionAliasProps) CfnConnectionAlias

Create a new `AWS::WorkSpaces::ConnectionAlias`.

type CfnConnectionAliasProps

type CfnConnectionAliasProps struct {
	// The connection string specified for the connection alias.
	//
	// The connection string must be in the form of a fully qualified domain name (FQDN), such as `www.example.com` .
	ConnectionString *string `json:"connectionString" yaml:"connectionString"`
	// The tags to associate with the connection alias.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnConnectionAlias`.

TODO: EXAMPLE

type CfnConnectionAlias_ConnectionAliasAssociationProperty

type CfnConnectionAlias_ConnectionAliasAssociationProperty struct {
	// The identifier of the AWS account that associated the connection alias with a directory.
	AssociatedAccountId *string `json:"associatedAccountId" yaml:"associatedAccountId"`
	// The association status of the connection alias.
	AssociationStatus *string `json:"associationStatus" yaml:"associationStatus"`
	// The identifier of the connection alias association.
	//
	// You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
	ConnectionIdentifier *string `json:"connectionIdentifier" yaml:"connectionIdentifier"`
	// The identifier of the directory associated with a connection alias.
	ResourceId *string `json:"resourceId" yaml:"resourceId"`
}

Describes a connection alias association that is used for cross-Region redirection.

For more information, see [Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) .

TODO: EXAMPLE

type CfnWorkspace

type CfnWorkspace interface {
	awscdk.CfnResource
	awscdk.IInspectable
	BundleId() *string
	SetBundleId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DirectoryId() *string
	SetDirectoryId(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	RootVolumeEncryptionEnabled() interface{}
	SetRootVolumeEncryptionEnabled(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	UserName() *string
	SetUserName(val *string)
	UserVolumeEncryptionEnabled() interface{}
	SetUserVolumeEncryptionEnabled(val interface{})
	VolumeEncryptionKey() *string
	SetVolumeEncryptionKey(val *string)
	WorkspaceProperties() interface{}
	SetWorkspaceProperties(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::WorkSpaces::Workspace`.

The `AWS::WorkSpaces::Workspace` resource specifies a WorkSpace.

Updates are not supported for the `BundleId` , `RootVolumeEncryptionEnabled` , `UserVolumeEncryptionEnabled` , or `VolumeEncryptionKey` properties. To update these properties, you must also update a property that triggers a replacement, such as the `UserName` property.

TODO: EXAMPLE

func NewCfnWorkspace

func NewCfnWorkspace(scope awscdk.Construct, id *string, props *CfnWorkspaceProps) CfnWorkspace

Create a new `AWS::WorkSpaces::Workspace`.

type CfnWorkspaceProps

type CfnWorkspaceProps struct {
	// The identifier of the bundle for the WorkSpace.
	BundleId *string `json:"bundleId" yaml:"bundleId"`
	// The identifier of the AWS Directory Service directory for the WorkSpace.
	DirectoryId *string `json:"directoryId" yaml:"directoryId"`
	// The user name of the user for the WorkSpace.
	//
	// This user name must exist in the AWS Directory Service directory for the WorkSpace.
	UserName *string `json:"userName" yaml:"userName"`
	// Indicates whether the data stored on the root volume is encrypted.
	RootVolumeEncryptionEnabled interface{} `json:"rootVolumeEncryptionEnabled" yaml:"rootVolumeEncryptionEnabled"`
	// The tags for the WorkSpace.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// Indicates whether the data stored on the user volume is encrypted.
	UserVolumeEncryptionEnabled interface{} `json:"userVolumeEncryptionEnabled" yaml:"userVolumeEncryptionEnabled"`
	// The symmetric AWS KMS key used to encrypt data stored on your WorkSpace.
	//
	// Amazon WorkSpaces does not support asymmetric KMS keys.
	VolumeEncryptionKey *string `json:"volumeEncryptionKey" yaml:"volumeEncryptionKey"`
	// The WorkSpace properties.
	WorkspaceProperties interface{} `json:"workspaceProperties" yaml:"workspaceProperties"`
}

Properties for defining a `CfnWorkspace`.

TODO: EXAMPLE

type CfnWorkspace_WorkspacePropertiesProperty

type CfnWorkspace_WorkspacePropertiesProperty struct {
	// The compute type.
	//
	// For more information, see [Amazon WorkSpaces Bundles](https://docs.aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles) .
	ComputeTypeName *string `json:"computeTypeName" yaml:"computeTypeName"`
	// The size of the root volume.
	//
	// For important information about how to modify the size of the root and user volumes, see [Modify a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) .
	RootVolumeSizeGib *float64 `json:"rootVolumeSizeGib" yaml:"rootVolumeSizeGib"`
	// The running mode.
	//
	// For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html) .
	RunningMode *string `json:"runningMode" yaml:"runningMode"`
	// The time after a user logs off when WorkSpaces are automatically stopped.
	//
	// Configured in 60-minute intervals.
	RunningModeAutoStopTimeoutInMinutes *float64 `json:"runningModeAutoStopTimeoutInMinutes" yaml:"runningModeAutoStopTimeoutInMinutes"`
	// The size of the user storage.
	//
	// For important information about how to modify the size of the root and user volumes, see [Modify a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) .
	UserVolumeSizeGib *float64 `json:"userVolumeSizeGib" yaml:"userVolumeSizeGib"`
}

Information about a WorkSpace.

TODO: EXAMPLE