Class CfnStreamGroupPropsMixin.LocationConfigurationProperty

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

Inheritance

object

CfnStreamGroupPropsMixin.LocationConfigurationProperty

Implements

CfnStreamGroupPropsMixin.ILocationConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.GameLiftStreams.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnStreamGroupPropsMixin.LocationConfigurationProperty : CfnStreamGroupPropsMixin.ILocationConfigurationProperty

Syntax (vb)

Public Class CfnStreamGroupPropsMixin.LocationConfigurationProperty Implements CfnStreamGroupPropsMixin.ILocationConfigurationProperty

Remarks

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

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

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.Mixins.Preview.AWS.GameLiftStreams.Mixins;

             var locationConfigurationProperty = new LocationConfigurationProperty {
                 AlwaysOnCapacity = 123,
                 LocationName = "locationName",
                 MaximumCapacity = 123,
                 OnDemandCapacity = 123,
                 TargetIdleCapacity = 123
             };

Synopsis

Constructors

LocationConfigurationProperty()

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

Properties

AlwaysOnCapacity	This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service.
LocationName	A location's name.
MaximumCapacity	Configuration settings that define a stream group's stream capacity for a location.
OnDemandCapacity	This field is deprecated. Use MaximumCapacity instead. This parameter is ignored when MaximumCapacity is specified.
TargetIdleCapacity	Configuration settings that define a stream group's stream capacity for a location.

Constructors

LocationConfigurationProperty()

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

public LocationConfigurationProperty()

Remarks

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

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

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.Mixins.Preview.AWS.GameLiftStreams.Mixins;

             var locationConfigurationProperty = new LocationConfigurationProperty {
                 AlwaysOnCapacity = 123,
                 LocationName = "locationName",
                 MaximumCapacity = 123,
                 OnDemandCapacity = 123,
                 TargetIdleCapacity = 123
             };

Properties

AlwaysOnCapacity

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

public double? AlwaysOnCapacity { get; set; }

Property Value

double?

Remarks

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

LocationName

A location's name.

public string? LocationName { get; set; }

Property Value

string

Remarks

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 .

MaximumCapacity

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

public double? MaximumCapacity { get; set; }

Property Value

double?

Remarks

OnDemandCapacity

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

public double? OnDemandCapacity { get; set; }

Property Value

double?

Remarks

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.

TargetIdleCapacity

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

public double? TargetIdleCapacity { get; set; }