CfnFleetPropsMixin

class aws_cdk.mixins_preview.aws_appstream.mixins.CfnFleetPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::AppStream::Fleet resource creates a fleet for Amazon AppStream 2.0. A fleet consists of streaming instances that run a specified image when using Always-On or On-Demand.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html
CloudformationResource:: AWS::AppStream::Fleet
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_appstream import mixins as appstream_mixins

cfn_fleet_props_mixin = appstream_mixins.CfnFleetPropsMixin(appstream_mixins.CfnFleetMixinProps(
    compute_capacity=appstream_mixins.CfnFleetPropsMixin.ComputeCapacityProperty(
        desired_instances=123,
        desired_sessions=123
    ),
    description="description",
    disconnect_timeout_in_seconds=123,
    display_name="displayName",
    domain_join_info=appstream_mixins.CfnFleetPropsMixin.DomainJoinInfoProperty(
        directory_name="directoryName",
        organizational_unit_distinguished_name="organizationalUnitDistinguishedName"
    ),
    enable_default_internet_access=False,
    fleet_type="fleetType",
    iam_role_arn="iamRoleArn",
    idle_disconnect_timeout_in_seconds=123,
    image_arn="imageArn",
    image_name="imageName",
    instance_type="instanceType",
    max_concurrent_sessions=123,
    max_sessions_per_instance=123,
    max_user_duration_in_seconds=123,
    name="name",
    platform="platform",
    root_volume_config=appstream_mixins.CfnFleetPropsMixin.VolumeConfigProperty(
        volume_size_in_gb=123
    ),
    session_script_s3_location=appstream_mixins.CfnFleetPropsMixin.S3LocationProperty(
        s3_bucket="s3Bucket",
        s3_key="s3Key"
    ),
    stream_view="streamView",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    usb_device_filter_strings=["usbDeviceFilterStrings"],
    vpc_config=appstream_mixins.CfnFleetPropsMixin.VpcConfigProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::AppStream::Fleet.

Parameters:

props (Union[CfnFleetMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['computeCapacity', 'description', 'disconnectTimeoutInSeconds', 'displayName', 'domainJoinInfo', 'enableDefaultInternetAccess', 'fleetType', 'iamRoleArn', 'idleDisconnectTimeoutInSeconds', 'imageArn', 'imageName', 'instanceType', 'maxConcurrentSessions', 'maxSessionsPerInstance', 'maxUserDurationInSeconds', 'name', 'platform', 'rootVolumeConfig', 'sessionScriptS3Location', 'streamView', 'tags', 'usbDeviceFilterStrings', 'vpcConfig']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ComputeCapacityProperty

class CfnFleetPropsMixin.ComputeCapacityProperty(*, desired_instances=None, desired_sessions=None)

Bases: object

The desired capacity for a fleet.

Parameters:

desired_instances (Union[int, float, None]) – The desired number of streaming instances.
desired_sessions (Union[int, float, None]) – The desired capacity in terms of number of user sessions, for the multi-session fleet. This is not allowed for single-session fleets. When you create a fleet, you must set define either the DesiredSessions or DesiredInstances attribute, based on the type of fleet you create. You can’t define both attributes or leave both attributes blank.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-computecapacity.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.mixins_preview.aws_appstream import mixins as appstream_mixins

compute_capacity_property = appstream_mixins.CfnFleetPropsMixin.ComputeCapacityProperty(
    desired_instances=123,
    desired_sessions=123
)

Attributes

desired_instances

The desired number of streaming instances.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-computecapacity.html#cfn-appstream-fleet-computecapacity-desiredinstances

desired_sessions

The desired capacity in terms of number of user sessions, for the multi-session fleet.

This is not allowed for single-session fleets.

When you create a fleet, you must set define either the DesiredSessions or DesiredInstances attribute, based on the type of fleet you create. You can’t define both attributes or leave both attributes blank.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-computecapacity.html#cfn-appstream-fleet-computecapacity-desiredsessions

DomainJoinInfoProperty

class CfnFleetPropsMixin.DomainJoinInfoProperty(*, directory_name=None, organizational_unit_distinguished_name=None)

Bases: object

The name of the directory and organizational unit (OU) to use to join a fleet to a Microsoft Active Directory domain.

Parameters:

directory_name (Optional[str]) – The fully qualified name of the directory (for example, corp.example.com).
organizational_unit_distinguished_name (Optional[str]) – The distinguished name of the organizational unit for computer accounts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-domainjoininfo.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.mixins_preview.aws_appstream import mixins as appstream_mixins

domain_join_info_property = appstream_mixins.CfnFleetPropsMixin.DomainJoinInfoProperty(
    directory_name="directoryName",
    organizational_unit_distinguished_name="organizationalUnitDistinguishedName"
)

Attributes

directory_name

The fully qualified name of the directory (for example, corp.example.com).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-domainjoininfo.html#cfn-appstream-fleet-domainjoininfo-directoryname

organizational_unit_distinguished_name

The distinguished name of the organizational unit for computer accounts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-domainjoininfo.html#cfn-appstream-fleet-domainjoininfo-organizationalunitdistinguishedname

S3LocationProperty

class CfnFleetPropsMixin.S3LocationProperty(*, s3_bucket=None, s3_key=None)

Bases: object

Describes the S3 location.

Parameters:

s3_bucket (Optional[str]) – The S3 bucket of the S3 object.
s3_key (Optional[str]) – The S3 key of the S3 object.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-s3location.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.mixins_preview.aws_appstream import mixins as appstream_mixins

s3_location_property = appstream_mixins.CfnFleetPropsMixin.S3LocationProperty(
    s3_bucket="s3Bucket",
    s3_key="s3Key"
)

Attributes

s3_bucket

The S3 bucket of the S3 object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-s3location.html#cfn-appstream-fleet-s3location-s3bucket

s3_key

The S3 key of the S3 object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-s3location.html#cfn-appstream-fleet-s3location-s3key

VolumeConfigProperty

class CfnFleetPropsMixin.VolumeConfigProperty(*, volume_size_in_gb=None)

Bases: object

Parameters:: volume_size_in_gb (Union[int, float, None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-volumeconfig.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.mixins_preview.aws_appstream import mixins as appstream_mixins

volume_config_property = appstream_mixins.CfnFleetPropsMixin.VolumeConfigProperty(
    volume_size_in_gb=123
)

Attributes

volume_size_in_gb

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-volumeconfig.html#cfn-appstream-fleet-volumeconfig-volumesizeingb

Type:: see

VpcConfigProperty

class CfnFleetPropsMixin.VpcConfigProperty(*, security_group_ids=None, subnet_ids=None)

Bases: object

The VPC configuration information for the fleet.

Parameters:

security_group_ids (Optional[Sequence[str]]) – The identifiers of the security groups for the fleet.
subnet_ids (Optional[Sequence[str]]) – The identifiers of the subnets to which a network interface is attached from the fleet instance. Fleet instances can use one or two subnets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-vpcconfig.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.mixins_preview.aws_appstream import mixins as appstream_mixins

vpc_config_property = appstream_mixins.CfnFleetPropsMixin.VpcConfigProperty(
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

security_group_ids

The identifiers of the security groups for the fleet.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-vpcconfig.html#cfn-appstream-fleet-vpcconfig-securitygroupids

subnet_ids

The identifiers of the subnets to which a network interface is attached from the fleet instance.

Fleet instances can use one or two subnets.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-vpcconfig.html#cfn-appstream-fleet-vpcconfig-subnetids