CfnEnvironment
- class aws_cdk.aws_workspacesthinclient.CfnEnvironment(scope, id, *, desktop_arn, desired_software_set_id=None, desktop_endpoint=None, device_creation_tags=None, kms_key_arn=None, maintenance_window=None, name=None, software_set_update_mode=None, software_set_update_schedule=None, tags=None)
Bases:
CfnResource
Describes an environment.
- See:
- CloudformationResource:
AWS::WorkSpacesThinClient::Environment
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_workspacesthinclient as workspacesthinclient cfn_environment = workspacesthinclient.CfnEnvironment(self, "MyCfnEnvironment", desktop_arn="desktopArn", # the properties below are optional desired_software_set_id="desiredSoftwareSetId", desktop_endpoint="desktopEndpoint", device_creation_tags=[CfnTag( key="key", value="value" )], kms_key_arn="kmsKeyArn", maintenance_window=workspacesthinclient.CfnEnvironment.MaintenanceWindowProperty( type="type", # the properties below are optional apply_time_of="applyTimeOf", days_of_the_week=["daysOfTheWeek"], end_time_hour=123, end_time_minute=123, start_time_hour=123, start_time_minute=123 ), name="name", software_set_update_mode="softwareSetUpdateMode", software_set_update_schedule="softwareSetUpdateSchedule", tags=[CfnTag( key="key", value="value" )] )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).desktop_arn (
str
) – The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.desired_software_set_id (
Optional
[str
]) – The ID of the software set to apply.desktop_endpoint (
Optional
[str
]) – The URL for the identity provider login (only for environments that use AppStream 2.0).device_creation_tags (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,CfnTag
,Dict
[str
,Any
]]],None
]) – The tag keys and optional values for the newly created devices for this environment.kms_key_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.maintenance_window (
Union
[IResolvable
,MaintenanceWindowProperty
,Dict
[str
,Any
],None
]) – A specification for a time window to apply software updates.name (
Optional
[str
]) – The name of the environment.software_set_update_mode (
Optional
[str
]) – An option to define which software updates to apply.software_set_update_schedule (
Optional
[str
]) – An option to define if software updates should be applied within a maintenance window.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
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.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
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.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
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:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
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.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
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.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
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.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::WorkSpacesThinClient::Environment'
- attr_activation_code
The activation code to register a device to the environment.
- CloudformationAttribute:
ActivationCode
- attr_arn
The Amazon Resource Name (ARN) of the environment.
- CloudformationAttribute:
Arn
- attr_created_at
The timestamp of when the environment was created.
- CloudformationAttribute:
CreatedAt
- attr_desktop_type
The type of streaming desktop for the environment.
- CloudformationAttribute:
DesktopType
- attr_id
Unique identifier of the environment.
- CloudformationAttribute:
Id
- attr_pending_software_set_id
The ID of the software set that is pending to be installed.
- CloudformationAttribute:
PendingSoftwareSetId
- attr_pending_software_set_version
The version of the software set that is pending to be installed.
- CloudformationAttribute:
PendingSoftwareSetVersion
- attr_registered_devices_count
The number of devices registered to the environment.
- CloudformationAttribute:
RegisteredDevicesCount
- attr_software_set_compliance_status
Describes if the software currently installed on all devices in the environment is a supported version.
- CloudformationAttribute:
SoftwareSetComplianceStatus
- attr_updated_at
The timestamp of when the device was updated.
- CloudformationAttribute:
UpdatedAt
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
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.
- desired_software_set_id
The ID of the software set to apply.
- desktop_arn
The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
- desktop_endpoint
The URL for the identity provider login (only for environments that use AppStream 2.0).
- device_creation_tags
The tag keys and optional values for the newly created devices for this environment.
- kms_key_arn
The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
- logical_id
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.
- maintenance_window
A specification for a time window to apply software updates.
- name
The name of the environment.
- node
The tree node.
- ref
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 })
.
- software_set_update_mode
An option to define which software updates to apply.
- software_set_update_schedule
An option to define if software updates should be applied within a maintenance window.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
An array of key-value pairs to apply to this resource.
Static Methods
- classmethod is_cfn_element(x)
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.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
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 classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
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 theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
MaintenanceWindowProperty
- class CfnEnvironment.MaintenanceWindowProperty(*, type, apply_time_of=None, days_of_the_week=None, end_time_hour=None, end_time_minute=None, start_time_hour=None, start_time_minute=None)
Bases:
object
Describes the maintenance window for a thin client device.
- Parameters:
type (
str
) – An option to select the default or custom maintenance window.apply_time_of (
Optional
[str
]) – The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).days_of_the_week (
Optional
[Sequence
[str
]]) – The days of the week during which the maintenance window is open.end_time_hour (
Union
[int
,float
,None
]) – The hour for the maintenance window end (00
-23
).end_time_minute (
Union
[int
,float
,None
]) – The minutes for the maintenance window end (00
-59
).start_time_hour (
Union
[int
,float
,None
]) – The hour for the maintenance window start (00
-23
).start_time_minute (
Union
[int
,float
,None
]) – The minutes past the hour for the maintenance window start (00
-59
).
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_workspacesthinclient as workspacesthinclient maintenance_window_property = workspacesthinclient.CfnEnvironment.MaintenanceWindowProperty( type="type", # the properties below are optional apply_time_of="applyTimeOf", days_of_the_week=["daysOfTheWeek"], end_time_hour=123, end_time_minute=123, start_time_hour=123, start_time_minute=123 )
Attributes
- apply_time_of
The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).
- days_of_the_week
The days of the week during which the maintenance window is open.
- end_time_hour
The hour for the maintenance window end (
00
-23
).
- end_time_minute
The minutes for the maintenance window end (
00
-59
).
- start_time_hour
The hour for the maintenance window start (
00
-23
).
- start_time_minute
The minutes past the hour for the maintenance window start (
00
-59
).
- type
An option to select the default or custom maintenance window.