interface LocationConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.GameLiftStreams.CfnStreamGroup.LocationConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsgameliftstreams#CfnStreamGroup_LocationConfigurationProperty |
 Java | software.amazon.awscdk.services.gameliftstreams.CfnStreamGroup.LocationConfigurationProperty |
 Python | aws_cdk.aws_gameliftstreams.CfnStreamGroup.LocationConfigurationProperty |
 TypeScript | aws-cdk-lib » aws_gameliftstreams » CfnStreamGroup » LocationConfigurationProperty |
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 { aws_gameliftstreams as gameliftstreams } from 'aws-cdk-lib';
const locationConfigurationProperty: gameliftstreams.CfnStreamGroup.LocationConfigurationProperty = {
locationName: 'locationName',
// the properties below are optional
alwaysOnCapacity: 123,
maximumCapacity: 123,
onDemandCapacity: 123,
targetIdleCapacity: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| location | string | A location's name. |
| always | number | This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. |
| maximum | number | |
| on | number | This field is deprecated. Use MaximumCapacity instead. This parameter is ignored when MaximumCapacity is specified. |
| target | number |
locationName
Type:
string
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 .
alwaysOnCapacity?
Type:
number
(optional)
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.
maximumCapacity?
Type:
number
(optional)
onDemandCapacity?
Type:
number
(optional)
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.
targetIdleCapacity?
Type:
number
(optional)