| Column Name | Column Data Type |
|---|
fleet_id Required Input Column
A unique identifier for the fleet that is associated with this scaling policy. | VARCHAR |
location Input Column
The fleet location. | VARCHAR |
status_filter Input Column
Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status. -
ACTIVE -- The scaling policy is currently in force. -
UPDATEREQUESTED -- A request to update the scaling policy has been received. -
UPDATING -- A change is being made to the scaling policy. -
DELETEREQUESTED -- A request to delete the scaling policy has been received. -
DELETING -- The scaling policy is being deleted. -
DELETED -- The scaling policy has been deleted. -
ERROR -- An error occurred in creating the policy. It should be removed and recreated. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
comparison_operator
Comparison operator to use when measuring a metric against the threshold value. | VARCHAR |
evaluation_periods
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered. | BIGINT |
fleet_arn
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. | VARCHAR |
metric_name
Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch. -
ActivatingGameSessions -- Game sessions in the process of being created. -
ActiveGameSessions -- Game sessions that are currently running. -
ActiveInstances -- Fleet instances that are currently running at least one game session. -
AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity. -
AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included. -
CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player. -
IdleInstances -- Active instances that are currently hosting zero game sessions. -
PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy. -
PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions. -
QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination. -
WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. | VARCHAR |
name
A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. | VARCHAR |
policy_type
The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment. | VARCHAR |
scaling_adjustment
Amount of adjustment to make, based on the scaling adjustment type. | BIGINT |
scaling_adjustment_type
The type of adjustment to make to a fleet's instance count. -
ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down. -
ExactCapacity -- set the instance count to the scaling adjustment value. -
PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down. | VARCHAR |
status
Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change. -
ACTIVE -- The scaling policy can be used for auto-scaling a fleet. -
UPDATE_REQUESTED -- A request to update the scaling policy has been received. -
UPDATING -- A change is being made to the scaling policy. -
DELETE_REQUESTED -- A request to delete the scaling policy has been received. -
DELETING -- The scaling policy is being deleted. -
DELETED -- The scaling policy has been deleted. -
ERROR -- An error occurred in creating the policy. It should be removed and recreated. | VARCHAR |
target_configuration
An object that contains settings for a target-based scaling policy. | STRUCT(
"target_value" DOUBLE
) |
Show child fields- target_configuration.target_value
Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
|
threshold
Metric value used to trigger a scaling event. | DOUBLE |
update_status
The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location. | VARCHAR |