class CfnStreamGroupPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.GameLiftStreams.Mixins.CfnStreamGroupPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsgameliftstreams/mixins#CfnStreamGroupPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.gameliftstreams.mixins.CfnStreamGroupPropsMixin
Python	aws_cdk.mixins_preview.aws_gameliftstreams.mixins.CfnStreamGroupPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_gameliftstreams » mixins » CfnStreamGroupPropsMixin

Implements IMixin

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

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-streamgroup.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as gameliftstreams_mixins } from '@aws-cdk/mixins-preview/aws-gameliftstreams';
const cfnStreamGroupPropsMixin = new gameliftstreams_mixins.CfnStreamGroupPropsMixin({
  defaultApplication: {
    arn: 'arn',
    id: 'id',
  },
  description: 'description',
  locationConfigurations: [{
    alwaysOnCapacity: 123,
    locationName: 'locationName',
    onDemandCapacity: 123,
  }],
  streamClass: 'streamClass',
  tags: {
    tagsKey: 'tags',
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnStreamGroupPropsMixin(props: CfnStreamGroupMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnStreamGroupMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnStreamGroupMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnStreamGroupMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.