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
- type CfnConnectionAliasProps
- type CfnConnectionAlias_ConnectionAliasAssociationProperty
- type CfnWorkspace
- type CfnWorkspaceProps
- type CfnWorkspace_WorkspacePropertiesProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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
// The identifier of the connection alias, returned as a string.
AttrAliasId() *string
// The association status of the connection alias, returned as an array of `ConnectionAliasAssociation` objects.
AttrAssociations() awscdk.IResolvable
// The current state of the connection alias, returned as a string.
AttrConnectionAliasState() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// 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
SetConnectionString(val *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.
// Experimental.
CreationStack() *[]*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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The tags to associate with the connection alias.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
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) .
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"
cfnConnectionAlias := awscdk.Aws_workspaces.NewCfnConnectionAlias(this, jsii.String("MyCfnConnectionAlias"), &cfnConnectionAliasProps{
connectionString: jsii.String("connectionString"),
// the properties below are optional
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
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 `field:"required" json:"connectionString" yaml:"connectionString"`
// The tags to associate with the connection alias.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnConnectionAlias`.
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"
cfnConnectionAliasProps := &cfnConnectionAliasProps{
connectionString: jsii.String("connectionString"),
// the properties below are optional
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnConnectionAlias_ConnectionAliasAssociationProperty ¶
type CfnConnectionAlias_ConnectionAliasAssociationProperty struct {
// The identifier of the AWS account that associated the connection alias with a directory.
AssociatedAccountId *string `field:"optional" json:"associatedAccountId" yaml:"associatedAccountId"`
// The association status of the connection alias.
AssociationStatus *string `field:"optional" 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 `field:"optional" json:"connectionIdentifier" yaml:"connectionIdentifier"`
// The identifier of the directory associated with a connection alias.
ResourceId *string `field:"optional" 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) .
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"
connectionAliasAssociationProperty := &connectionAliasAssociationProperty{
associatedAccountId: jsii.String("associatedAccountId"),
associationStatus: jsii.String("associationStatus"),
connectionIdentifier: jsii.String("connectionIdentifier"),
resourceId: jsii.String("resourceId"),
}
type CfnWorkspace ¶
type CfnWorkspace interface {
awscdk.CfnResource
awscdk.IInspectable
// The identifier of the bundle for the WorkSpace.
BundleId() *string
SetBundleId(val *string)
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
CreationStack() *[]*string
// The identifier of the AWS Directory Service directory for the WorkSpace.
DirectoryId() *string
SetDirectoryId(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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// Indicates whether the data stored on the root volume is encrypted.
RootVolumeEncryptionEnabled() interface{}
SetRootVolumeEncryptionEnabled(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The tags for the WorkSpace.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// 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
SetUserName(val *string)
// Indicates whether the data stored on the user volume is encrypted.
UserVolumeEncryptionEnabled() interface{}
SetUserVolumeEncryptionEnabled(val interface{})
// The symmetric AWS KMS key used to encrypt data stored on your WorkSpace.
//
// Amazon WorkSpaces does not support asymmetric KMS keys.
VolumeEncryptionKey() *string
SetVolumeEncryptionKey(val *string)
// The WorkSpace properties.
WorkspaceProperties() interface{}
SetWorkspaceProperties(val interface{})
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
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.
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"
cfnWorkspace := awscdk.Aws_workspaces.NewCfnWorkspace(this, jsii.String("MyCfnWorkspace"), &cfnWorkspaceProps{
bundleId: jsii.String("bundleId"),
directoryId: jsii.String("directoryId"),
userName: jsii.String("userName"),
// the properties below are optional
rootVolumeEncryptionEnabled: jsii.Boolean(false),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
userVolumeEncryptionEnabled: jsii.Boolean(false),
volumeEncryptionKey: jsii.String("volumeEncryptionKey"),
workspaceProperties: &workspacePropertiesProperty{
computeTypeName: jsii.String("computeTypeName"),
rootVolumeSizeGib: jsii.Number(123),
runningMode: jsii.String("runningMode"),
runningModeAutoStopTimeoutInMinutes: jsii.Number(123),
userVolumeSizeGib: jsii.Number(123),
},
})
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 `field:"required" json:"bundleId" yaml:"bundleId"`
// The identifier of the AWS Directory Service directory for the WorkSpace.
DirectoryId *string `field:"required" 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 `field:"required" json:"userName" yaml:"userName"`
// Indicates whether the data stored on the root volume is encrypted.
RootVolumeEncryptionEnabled interface{} `field:"optional" json:"rootVolumeEncryptionEnabled" yaml:"rootVolumeEncryptionEnabled"`
// The tags for the WorkSpace.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// Indicates whether the data stored on the user volume is encrypted.
UserVolumeEncryptionEnabled interface{} `field:"optional" 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 `field:"optional" json:"volumeEncryptionKey" yaml:"volumeEncryptionKey"`
// The WorkSpace properties.
WorkspaceProperties interface{} `field:"optional" json:"workspaceProperties" yaml:"workspaceProperties"`
}
Properties for defining a `CfnWorkspace`.
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"
cfnWorkspaceProps := &cfnWorkspaceProps{
bundleId: jsii.String("bundleId"),
directoryId: jsii.String("directoryId"),
userName: jsii.String("userName"),
// the properties below are optional
rootVolumeEncryptionEnabled: jsii.Boolean(false),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
userVolumeEncryptionEnabled: jsii.Boolean(false),
volumeEncryptionKey: jsii.String("volumeEncryptionKey"),
workspaceProperties: &workspacePropertiesProperty{
computeTypeName: jsii.String("computeTypeName"),
rootVolumeSizeGib: jsii.Number(123),
runningMode: jsii.String("runningMode"),
runningModeAutoStopTimeoutInMinutes: jsii.Number(123),
userVolumeSizeGib: jsii.Number(123),
},
}
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 `field:"optional" 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 `field:"optional" 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) .
//
// > The `MANUAL` value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see [Amazon WorkSpaces Core](https://docs.aws.amazon.com/workspaces/core/) .
RunningMode *string `field:"optional" json:"runningMode" yaml:"runningMode"`
// The time after a user logs off when WorkSpaces are automatically stopped.
//
// Configured in 60-minute intervals.
RunningModeAutoStopTimeoutInMinutes *float64 `field:"optional" 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 `field:"optional" json:"userVolumeSizeGib" yaml:"userVolumeSizeGib"`
}
Information about a WorkSpace.
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"
workspacePropertiesProperty := &workspacePropertiesProperty{
computeTypeName: jsii.String("computeTypeName"),
rootVolumeSizeGib: jsii.Number(123),
runningMode: jsii.String("runningMode"),
runningModeAutoStopTimeoutInMinutes: jsii.Number(123),
userVolumeSizeGib: jsii.Number(123),
}
Source Files
¶
- awsworkspaces.go
- awsworkspaces_CfnConnectionAlias.go
- awsworkspaces_CfnConnectionAliasProps.go
- awsworkspaces_CfnConnectionAlias_ConnectionAliasAssociationProperty.go
- awsworkspaces_CfnConnectionAlias__runtime_type_checks.go
- awsworkspaces_CfnWorkspace.go
- awsworkspaces_CfnWorkspaceProps.go
- awsworkspaces_CfnWorkspace_WorkspacePropertiesProperty.go
- awsworkspaces_CfnWorkspace__runtime_type_checks.go