CfnEnvironmentProps

class aws_cdk.aws_workspacesthinclient.CfnEnvironmentProps(*, desktop_arn, desired_software_set_id=None, desktop_endpoint=None, kms_key_arn=None, maintenance_window=None, name=None, software_set_update_mode=None, software_set_update_schedule=None, tags=None)

Bases: object

Properties for defining a CfnEnvironment.

Parameters:
  • 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).

  • 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 .

See:

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

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_props = workspacesthinclient.CfnEnvironmentProps(
    desktop_arn="desktopArn",

    # the properties below are optional
    desired_software_set_id="desiredSoftwareSetId",
    desktop_endpoint="desktopEndpoint",
    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"
    )]
)

Attributes

desired_software_set_id

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

desktop_arn

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

desktop_endpoint

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

kms_key_arn

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

maintenance_window

A specification for a time window to apply software updates.

See:

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

name

The name of the environment.

See:

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

software_set_update_mode

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

software_set_update_schedule

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

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See:

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