CfnStreamGroupPropsMixin

class aws_cdk.mixins_preview.aws_gameliftstreams.mixins.CfnStreamGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::GameLiftStreams::StreamGroup resource defines a group of compute resources that will be running and streaming your game.

When you create a stream group, you specify the hardware configuration (CPU, GPU, RAM) that will run your game (known as the stream class ), the geographical locations where your game can run, and the number of streams that can run simultaneously in each location (known as stream capacity ). Stream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs.

There are two types of stream capacity: always-on and on-demand.

Always-on : The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it’s in use or not. Best for quickest time from streaming request to streaming session. Default is 1 (2 for high stream classes) when creating a stream group or adding a location.
On-demand : The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location.

Values for capacity must be whole number multiples of the tenancy value of the stream group’s stream class. .. epigraph:

Application association is not currently supported in CloudFormation . To link additional applications to a stream group, use the Amazon GameLift Streams console or the AWS CLI .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-streamgroup.html
CloudformationResource:: AWS::GameLiftStreams::StreamGroup
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_gameliftstreams import mixins as gameliftstreams_mixins

cfn_stream_group_props_mixin = gameliftstreams_mixins.CfnStreamGroupPropsMixin(gameliftstreams_mixins.CfnStreamGroupMixinProps(
    default_application=gameliftstreams_mixins.CfnStreamGroupPropsMixin.DefaultApplicationProperty(
        arn="arn",
        id="id"
    ),
    description="description",
    location_configurations=[gameliftstreams_mixins.CfnStreamGroupPropsMixin.LocationConfigurationProperty(
        always_on_capacity=123,
        location_name="locationName",
        maximum_capacity=123,
        on_demand_capacity=123,
        target_idle_capacity=123
    )],
    stream_class="streamClass",
    tags={
        "tags_key": "tags"
    }
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::GameLiftStreams::StreamGroup.

Parameters:

props (Union[CfnStreamGroupMixinProps, 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 = ['defaultApplication', 'description', 'locationConfigurations', 'streamClass', 'tags']

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

DefaultApplicationProperty

class CfnStreamGroupPropsMixin.DefaultApplicationProperty(*, arn=None, id=None)

Bases: object

Represents the default Amazon GameLift Streams application that a stream group hosts.

Parameters:

arn (Optional[str]) – An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
id (Optional[str]) – An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-defaultapplication.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_gameliftstreams import mixins as gameliftstreams_mixins

default_application_property = gameliftstreams_mixins.CfnStreamGroupPropsMixin.DefaultApplicationProperty(
    arn="arn",
    id="id"
)

Attributes

arn

arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-defaultapplication.html#cfn-gameliftstreams-streamgroup-defaultapplication-arn
Type:: An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN

id

An ID that uniquely identifies the application resource.

Example ID: a-9ZY8X7Wv6 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-defaultapplication.html#cfn-gameliftstreams-streamgroup-defaultapplication-id

LocationConfigurationProperty

class CfnStreamGroupPropsMixin.LocationConfigurationProperty(*, always_on_capacity=None, location_name=None, maximum_capacity=None, on_demand_capacity=None, target_idle_capacity=None)

Bases: object

Configuration settings that define a stream group’s stream capacity for a location.

When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types.

Parameters:

always_on_capacity (Union[int, float, None]) – This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
location_name (Optional[str]) – A location’s name. For example, us-east-1 . For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .
maximum_capacity (Union[int, float, None])
on_demand_capacity (Union[int, float, None]) – This field is deprecated. Use MaximumCapacity instead. This parameter is ignored when MaximumCapacity is specified. The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when you create a stream group or add a location.
target_idle_capacity (Union[int, float, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.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_gameliftstreams import mixins as gameliftstreams_mixins

location_configuration_property = gameliftstreams_mixins.CfnStreamGroupPropsMixin.LocationConfigurationProperty(
    always_on_capacity=123,
    location_name="locationName",
    maximum_capacity=123,
    on_demand_capacity=123,
    target_idle_capacity=123
)

Attributes

always_on_capacity

This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service.

You pay for this base level of capacity at all times, whether used or idle.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.html#cfn-gameliftstreams-streamgroup-locationconfiguration-alwaysoncapacity

location_name

A location’s name.

For example, us-east-1 . For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.html#cfn-gameliftstreams-streamgroup-locationconfiguration-locationname

maximum_capacity

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.html#cfn-gameliftstreams-streamgroup-locationconfiguration-maximumcapacity

Type:: see

on_demand_capacity

This field is deprecated. Use MaximumCapacity instead. This parameter is ignored when MaximumCapacity is specified.

The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when you create a stream group or add a location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.html#cfn-gameliftstreams-streamgroup-locationconfiguration-ondemandcapacity

target_idle_capacity

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.html#cfn-gameliftstreams-streamgroup-locationconfiguration-targetidlecapacity

Type:: see