Class CfnStreamGroup

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnStreamGroup

Implements

IInspectable

IStreamGroupRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.GameLiftStreams

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnStreamGroup : CfnResource, IInspectable, IStreamGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnStreamGroup Inherits CfnResource Implements IInspectable, IStreamGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GameLiftStreams;

             var cfnStreamGroup = new CfnStreamGroup(this, "MyCfnStreamGroup", new CfnStreamGroupProps {
                 Description = "description",
                 LocationConfigurations = new [] { new LocationConfigurationProperty {
                     LocationName = "locationName",

                     // the properties below are optional
                     AlwaysOnCapacity = 123,
                     MaximumCapacity = 123,
                     OnDemandCapacity = 123,
                     TargetIdleCapacity = 123,
                     VpcTransitConfiguration = new VpcTransitConfigurationProperty {
                         Ipv4CidrBlocks = new [] { "ipv4CidrBlocks" },
                         VpcId = "vpcId"
                     }
                 } },
                 StreamClass = "streamClass",

                 // the properties below are optional
                 DefaultApplication = new DefaultApplicationProperty {
                     Arn = "arn",
                     Id = "id"
                 },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Synopsis

Constructors

CfnStreamGroup(Construct, string, ICfnStreamGroupProps)

Create a new AWS::GameLiftStreams::StreamGroup.

Properties

AttrArn	An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .
AttrId	An ID that uniquely identifies the stream group resource.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	The AWS::GameLiftStreams::StreamGroup resource defines a group of compute resources that will be running and streaming your game.
CfnPropertyNames	The AWS::GameLiftStreams::StreamGroup resource defines a group of compute resources that will be running and streaming your game.
DefaultApplication	Object that identifies the Amazon GameLift Streams application to stream with this stream group.
Description	A descriptive label for the stream group.
LocationConfigurations	A set of one or more locations and the streaming capacity for each location.
StreamClass	The target stream quality for sessions that are hosted in this stream group.
StreamGroupRef	A reference to a StreamGroup resource.
Tags	A list of labels to assign to the new stream group resource.

Methods

ArnForStreamGroup(IStreamGroupRef)	The AWS::GameLiftStreams::StreamGroup resource defines a group of compute resources that will be running and streaming your game.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnStreamGroup(object)	Checks whether the given object is a CfnStreamGroup.
RenderProperties(IDictionary<string, object>)	The AWS::GameLiftStreams::StreamGroup resource defines a group of compute resources that will be running and streaming your game.

Constructors

CfnStreamGroup(Construct, string, ICfnStreamGroupProps)

Create a new AWS::GameLiftStreams::StreamGroup.

public CfnStreamGroup(Construct scope, string id, ICfnStreamGroupProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnStreamGroupProps

Resource properties.

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

Properties

AttrArn

An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrId

An ID that uniquely identifies the stream group resource.

public virtual string AttrId { get; }

Property Value

string

Remarks

For example: sg-1AB2C3De4 .

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

CfnPropertyNames

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

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

DefaultApplication

Object that identifies the Amazon GameLift Streams application to stream with this stream group.

public virtual object? DefaultApplication { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnStreamGroup.IDefaultApplicationProperty

Description

A descriptive label for the stream group.

public virtual string Description { get; set; }

Property Value

string

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

LocationConfigurations

A set of one or more locations and the streaming capacity for each location.

public virtual object LocationConfigurations { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnStreamGroup.ILocationConfigurationProperty)[]

StreamClass

The target stream quality for sessions that are hosted in this stream group.

public virtual string StreamClass { get; set; }

Property Value

string

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

StreamGroupRef

A reference to a StreamGroup resource.

public virtual IStreamGroupReference StreamGroupRef { get; }

Property Value

IStreamGroupReference

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

Tags

A list of labels to assign to the new stream group resource.

public virtual IDictionary<string, string>? Tags { get; set; }

Property Value

IDictionary<string, string>

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

Methods

ArnForStreamGroup(IStreamGroupRef)

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

public static string ArnForStreamGroup(IStreamGroupRef resource)

Parameters

resource IStreamGroupRef

Returns

string

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GameLiftStreams;

             var cfnStreamGroup = new CfnStreamGroup(this, "MyCfnStreamGroup", new CfnStreamGroupProps {
                 Description = "description",
                 LocationConfigurations = new [] { new LocationConfigurationProperty {
                     LocationName = "locationName",

                     // the properties below are optional
                     AlwaysOnCapacity = 123,
                     MaximumCapacity = 123,
                     OnDemandCapacity = 123,
                     TargetIdleCapacity = 123,
                     VpcTransitConfiguration = new VpcTransitConfigurationProperty {
                         Ipv4CidrBlocks = new [] { "ipv4CidrBlocks" },
                         VpcId = "vpcId"
                     }
                 } },
                 StreamClass = "streamClass",

                 // the properties below are optional
                 DefaultApplication = new DefaultApplicationProperty {
                     Arn = "arn",
                     Id = "id"
                 },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

IsCfnStreamGroup(object)

Checks whether the given object is a CfnStreamGroup.

public static bool IsCfnStreamGroup(object x)

Parameters

x object

Returns

bool

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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.

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

CloudformationResource: AWS::GameLiftStreams::StreamGroup

ExampleMetadata: fixture=_generated

Implements

IInspectable

IStreamGroupRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2