Package software.amazon.awscdk.services.gameliftstreams

Interface CfnStreamGroup.LocationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStreamGroup.LocationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnStreamGroup

@Stability(Stable)
public static interface CfnStreamGroup.LocationConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gameliftstreams.*;
 LocationConfigurationProperty locationConfigurationProperty = LocationConfigurationProperty.builder()
         .locationName("locationName")
         // the properties below are optional
         .alwaysOnCapacity(123)
         .maximumCapacity(123)
         .onDemandCapacity(123)
         .targetIdleCapacity(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStreamGroup.LocationConfigurationProperty.Builder	A builder for CfnStreamGroup.LocationConfigurationProperty
static final class	CfnStreamGroup.LocationConfigurationProperty.Jsii$Proxy	An implementation for CfnStreamGroup.LocationConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnStreamGroup.LocationConfigurationProperty.Builder	builder()
default Number	getAlwaysOnCapacity()	This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service.
String	getLocationName()	A location's name.
default Number	getMaximumCapacity()
default Number	getOnDemandCapacity()	This field is deprecated.
default Number	getTargetIdleCapacity()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLocationName

@Stability(Stable)
@NotNull
String getLocationName()

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 Also:

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

getAlwaysOnCapacity

@Stability(Stable)
@Nullable
default Number getAlwaysOnCapacity()

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 Also:

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

getMaximumCapacity

@Stability(Stable)
@Nullable
default Number getMaximumCapacity()

See Also:

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

getOnDemandCapacity

@Stability(Stable)
@Nullable
default Number getOnDemandCapacity()

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 Also:

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

getTargetIdleCapacity

@Stability(Stable)
@Nullable
default Number getTargetIdleCapacity()

See Also:

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

builder

@Stability(Stable)
static CfnStreamGroup.LocationConfigurationProperty.Builder builder()

Returns:

a CfnStreamGroup.LocationConfigurationProperty.Builder of CfnStreamGroup.LocationConfigurationProperty