aws-sdk-gamelift 1.53.0 → 1.56.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-gamelift/client.rb +604 -485
- data/lib/aws-sdk-gamelift/types.rb +558 -416
- data/lib/aws-sdk-gamelift.rb +1 -1
- metadata +4 -4
@@ -143,7 +143,7 @@ module Aws::GameLift
|
|
143
143
|
# @return [Float]
|
144
144
|
#
|
145
145
|
# @!attribute [rw] sl
|
146
|
-
# For a list of up to
|
146
|
+
# For a list of up to 100 strings. Maximum length for each string is
|
147
147
|
# 100 characters. Duplicate values are not recognized; all occurrences
|
148
148
|
# of the repeated value after the first of a repeated value are
|
149
149
|
# ignored.
|
@@ -166,16 +166,16 @@ module Aws::GameLift
|
|
166
166
|
end
|
167
167
|
|
168
168
|
# Temporary access credentials used for uploading game build files to
|
169
|
-
# Amazon
|
169
|
+
# Amazon Web Services. They are valid for a limited time. If they expire
|
170
170
|
# before you upload your game build, get a new set by calling
|
171
171
|
# RequestUploadCredentials.
|
172
172
|
#
|
173
173
|
# @!attribute [rw] access_key_id
|
174
|
-
# Temporary key allowing access to the Amazon
|
174
|
+
# Temporary key allowing access to the Amazon Web Services S3 account.
|
175
175
|
# @return [String]
|
176
176
|
#
|
177
177
|
# @!attribute [rw] secret_access_key
|
178
|
-
# Temporary secret key allowing access to the Amazon
|
178
|
+
# Temporary secret key allowing access to the Amazon Web Services S3
|
179
179
|
# account.
|
180
180
|
# @return [String]
|
181
181
|
#
|
@@ -253,7 +253,8 @@ module Aws::GameLift
|
|
253
253
|
#
|
254
254
|
# @!attribute [rw] size_on_disk
|
255
255
|
# File size of the uploaded game build, expressed in bytes. When the
|
256
|
-
# build status is `INITIALIZED
|
256
|
+
# build status is `INITIALIZED` or when using a custom Amazon S3
|
257
|
+
# storage location, this value is 0.
|
257
258
|
# @return [Integer]
|
258
259
|
#
|
259
260
|
# @!attribute [rw] operating_system
|
@@ -425,13 +426,14 @@ module Aws::GameLift
|
|
425
426
|
#
|
426
427
|
# @!attribute [rw] tags
|
427
428
|
# A list of labels to assign to the new alias resource. Tags are
|
428
|
-
# developer-defined key-value pairs. Tagging
|
429
|
-
# for resource management, access management and
|
430
|
-
# more information, see [ Tagging
|
431
|
-
#
|
432
|
-
#
|
433
|
-
# and
|
434
|
-
#
|
429
|
+
# developer-defined key-value pairs. Tagging Amazon Web Services
|
430
|
+
# resources are useful for resource management, access management and
|
431
|
+
# cost allocation. For more information, see [ Tagging Amazon Web
|
432
|
+
# Services Resources][1] in the *Amazon Web Services General
|
433
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
434
|
+
# UntagResource, and ListTagsForResource to add, remove, and view
|
435
|
+
# tags. The maximum tag limit may be lower than stated. See the Amazon
|
436
|
+
# Web Services General Reference for actual tagging limits.
|
435
437
|
#
|
436
438
|
#
|
437
439
|
#
|
@@ -503,9 +505,13 @@ module Aws::GameLift
|
|
503
505
|
# this parameter only when creating a build with files stored in an
|
504
506
|
# Amazon S3 bucket that you own. The storage location must specify an
|
505
507
|
# Amazon S3 bucket name and key. The location must also specify a role
|
506
|
-
# ARN that you set up to allow Amazon
|
507
|
-
# S3 bucket. The S3 bucket and your new build must be in the
|
508
|
-
# Region.
|
508
|
+
# ARN that you set up to allow Amazon Web Services to access your
|
509
|
+
# Amazon S3 bucket. The S3 bucket and your new build must be in the
|
510
|
+
# same Region.
|
511
|
+
#
|
512
|
+
# If a `StorageLocation` is specified, the size of your file can be
|
513
|
+
# found in your Amazon S3 bucket. Amazon Web Services will report a
|
514
|
+
# `SizeOnDisk` of 0.
|
509
515
|
# @return [Types::S3Location]
|
510
516
|
#
|
511
517
|
# @!attribute [rw] operating_system
|
@@ -520,13 +526,14 @@ module Aws::GameLift
|
|
520
526
|
#
|
521
527
|
# @!attribute [rw] tags
|
522
528
|
# A list of labels to assign to the new build resource. Tags are
|
523
|
-
# developer-defined key-value pairs. Tagging
|
524
|
-
# for resource management, access management and
|
525
|
-
# more information, see [ Tagging
|
526
|
-
#
|
527
|
-
#
|
528
|
-
# and
|
529
|
-
#
|
529
|
+
# developer-defined key-value pairs. Tagging Amazon Web Services
|
530
|
+
# resources are useful for resource management, access management and
|
531
|
+
# cost allocation. For more information, see [ Tagging Amazon Web
|
532
|
+
# Services Resources][1] in the *Amazon Web Services General
|
533
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
534
|
+
# UntagResource, and ListTagsForResource to add, remove, and view
|
535
|
+
# tags. The maximum tag limit may be lower than stated. See the Amazon
|
536
|
+
# Web Services General Reference for actual tagging limits.
|
530
537
|
#
|
531
538
|
#
|
532
539
|
#
|
@@ -556,8 +563,8 @@ module Aws::GameLift
|
|
556
563
|
# This element is returned only when the operation is called without a
|
557
564
|
# storage location. It contains credentials to use when you are
|
558
565
|
# uploading a build file to an Amazon S3 bucket that is owned by
|
559
|
-
# Amazon
|
560
|
-
# these credentials, call RequestUploadCredentials.
|
566
|
+
# Amazon Web Services. Credentials have a limited life span. To
|
567
|
+
# refresh these credentials, call RequestUploadCredentials.
|
561
568
|
# @return [Types::AwsCredentials]
|
562
569
|
#
|
563
570
|
# @!attribute [rw] storage_location
|
@@ -682,11 +689,12 @@ module Aws::GameLift
|
|
682
689
|
# @return [Array<String>]
|
683
690
|
#
|
684
691
|
# @!attribute [rw] ec2_instance_type
|
685
|
-
# The GameLift-supported EC2 instance type to use for all fleet
|
692
|
+
# The GameLift-supported Amazon EC2 instance type to use for all fleet
|
686
693
|
# instances. Instance type determines the computing resources that
|
687
694
|
# will be used to host your game servers, including CPU, memory,
|
688
|
-
# storage, and networking capacity. See [Amazon
|
689
|
-
# for detailed descriptions of EC2 instance
|
695
|
+
# storage, and networking capacity. See [Amazon Elastic Compute Cloud
|
696
|
+
# Instance Types][1] for detailed descriptions of Amazon EC2 instance
|
697
|
+
# types.
|
690
698
|
#
|
691
699
|
#
|
692
700
|
#
|
@@ -736,25 +744,26 @@ module Aws::GameLift
|
|
736
744
|
# @return [Types::ResourceCreationLimitPolicy]
|
737
745
|
#
|
738
746
|
# @!attribute [rw] metric_groups
|
739
|
-
# The name of an
|
740
|
-
# metric group is used to aggregate the metrics for
|
741
|
-
# You can specify an existing metric group name or
|
742
|
-
# create a new metric group. A fleet can be included
|
743
|
-
# metric group at a time.
|
747
|
+
# The name of an Amazon Web Services CloudWatch metric group to add
|
748
|
+
# this fleet to. A metric group is used to aggregate the metrics for
|
749
|
+
# multiple fleets. You can specify an existing metric group name or
|
750
|
+
# set a new name to create a new metric group. A fleet can be included
|
751
|
+
# in only one metric group at a time.
|
744
752
|
# @return [Array<String>]
|
745
753
|
#
|
746
754
|
# @!attribute [rw] peer_vpc_aws_account_id
|
747
755
|
# Used when peering your GameLift fleet with a VPC, the unique
|
748
|
-
# identifier for the
|
749
|
-
# account ID in the
|
756
|
+
# identifier for the Amazon Web Services account that owns the VPC.
|
757
|
+
# You can find your account ID in the Amazon Web Services Management
|
758
|
+
# Console under account settings.
|
750
759
|
# @return [String]
|
751
760
|
#
|
752
761
|
# @!attribute [rw] peer_vpc_id
|
753
762
|
# A unique identifier for a VPC with resources to be accessed by your
|
754
763
|
# GameLift fleet. The VPC must be in the same Region as your fleet. To
|
755
|
-
# look up a VPC ID, use the [VPC Dashboard][1] in the
|
756
|
-
# Console. Learn more about VPC peering in [VPC
|
757
|
-
# Fleets][2].
|
764
|
+
# look up a VPC ID, use the [VPC Dashboard][1] in the Amazon Web
|
765
|
+
# Services Management Console. Learn more about VPC peering in [VPC
|
766
|
+
# Peering with GameLift Fleets][2].
|
758
767
|
#
|
759
768
|
#
|
760
769
|
#
|
@@ -774,15 +783,15 @@ module Aws::GameLift
|
|
774
783
|
# @return [String]
|
775
784
|
#
|
776
785
|
# @!attribute [rw] instance_role_arn
|
777
|
-
# A unique identifier for an
|
778
|
-
#
|
779
|
-
# runs on an instance in this fleet can assume the
|
780
|
-
# install scripts, server processes, and daemons
|
781
|
-
# processes). Create a role or look up a role's ARN by
|
782
|
-
# dashboard][1] in the
|
783
|
-
# on-box credentials for your game
|
784
|
-
# resources from a game server][2]. This
|
785
|
-
# after the fleet is created.
|
786
|
+
# A unique identifier for an IAM role that manages access to your
|
787
|
+
# Amazon Web Services services. With an instance role ARN set, any
|
788
|
+
# application that runs on an instance in this fleet can assume the
|
789
|
+
# role, including install scripts, server processes, and daemons
|
790
|
+
# (background processes). Create a role or look up a role's ARN by
|
791
|
+
# using the [IAM dashboard][1] in the Amazon Web Services Management
|
792
|
+
# Console. Learn more about using on-box credentials for your game
|
793
|
+
# servers at [ Access external resources from a game server][2]. This
|
794
|
+
# property cannot be changed after the fleet is created.
|
786
795
|
#
|
787
796
|
#
|
788
797
|
#
|
@@ -794,38 +803,36 @@ module Aws::GameLift
|
|
794
803
|
# Prompts GameLift to generate a TLS/SSL certificate for the fleet.
|
795
804
|
# TLS certificates are used for encrypting traffic between game
|
796
805
|
# clients and the game servers that are running on GameLift. By
|
797
|
-
# default, the `CertificateConfiguration` is set to `DISABLED`.
|
798
|
-
#
|
799
|
-
#
|
800
|
-
#
|
801
|
-
#
|
802
|
-
#
|
803
|
-
#
|
804
|
-
#
|
805
|
-
#
|
806
|
-
#
|
807
|
-
#
|
808
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-howitworks.html#gamelift-howitworks-security
|
806
|
+
# default, the `CertificateConfiguration` is set to `DISABLED`. This
|
807
|
+
# property cannot be changed after the fleet is created.
|
808
|
+
#
|
809
|
+
# Note: This feature requires the Amazon Web Services Certificate
|
810
|
+
# Manager (ACM) service, which is not available in all Amazon Web
|
811
|
+
# Services regions. When working in a region that does not support
|
812
|
+
# this feature, a fleet creation request with certificate generation
|
813
|
+
# fails with a 4xx error.
|
809
814
|
# @return [Types::CertificateConfiguration]
|
810
815
|
#
|
811
816
|
# @!attribute [rw] locations
|
812
817
|
# A set of remote locations to deploy additional instances to and
|
813
818
|
# manage as part of the fleet. This parameter can only be used when
|
814
|
-
# creating fleets in
|
815
|
-
# can add any GameLift-supported
|
816
|
-
#
|
817
|
-
#
|
819
|
+
# creating fleets in Amazon Web Services Regions that support multiple
|
820
|
+
# locations. You can add any GameLift-supported Amazon Web Services
|
821
|
+
# Region as a remote location, in the form of an Amazon Web Services
|
822
|
+
# Region code such as `us-west-2`. To create a fleet with instances in
|
823
|
+
# the home Region only, omit this parameter.
|
818
824
|
# @return [Array<Types::LocationConfiguration>]
|
819
825
|
#
|
820
826
|
# @!attribute [rw] tags
|
821
827
|
# A list of labels to assign to the new fleet resource. Tags are
|
822
|
-
# developer-defined key-value pairs. Tagging
|
823
|
-
# for resource management, access management and
|
824
|
-
# more information, see [ Tagging
|
825
|
-
#
|
826
|
-
#
|
827
|
-
# and
|
828
|
-
#
|
828
|
+
# developer-defined key-value pairs. Tagging Amazon Web Services
|
829
|
+
# resources are useful for resource management, access management and
|
830
|
+
# cost allocation. For more information, see [ Tagging Amazon Web
|
831
|
+
# Services Resources][1] in the *Amazon Web Services General
|
832
|
+
# Reference*. Once the fleet is created, you can use TagResource,
|
833
|
+
# UntagResource, and ListTagsForResource to add, remove, and view
|
834
|
+
# tags. The maximum tag limit may be lower than stated. See the
|
835
|
+
# *Amazon Web Services General Reference* for actual tagging limits.
|
829
836
|
#
|
830
837
|
#
|
831
838
|
#
|
@@ -880,9 +887,9 @@ module Aws::GameLift
|
|
880
887
|
#
|
881
888
|
# @!attribute [rw] locations
|
882
889
|
# A list of locations to deploy additional instances to and manage as
|
883
|
-
# part of the fleet. You can add any GameLift-supported
|
884
|
-
# a remote location, in the form of an
|
885
|
-
# `us-west-2`.
|
890
|
+
# part of the fleet. You can add any GameLift-supported Amazon Web
|
891
|
+
# Services Region as a remote location, in the form of an Amazon Web
|
892
|
+
# Services Region code such as `us-west-2`.
|
886
893
|
# @return [Array<Types::LocationConfiguration>]
|
887
894
|
#
|
888
895
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateFleetLocationsInput AWS API Documentation
|
@@ -995,14 +1002,14 @@ module Aws::GameLift
|
|
995
1002
|
#
|
996
1003
|
# @!attribute [rw] game_server_group_name
|
997
1004
|
# An identifier for the new game server group. This value is used to
|
998
|
-
# generate unique ARN identifiers for the EC2 Auto Scaling
|
999
|
-
# the GameLift FleetIQ game server group. The name must be
|
1000
|
-
# Region per
|
1005
|
+
# generate unique ARN identifiers for the Amazon EC2 Auto Scaling
|
1006
|
+
# group and the GameLift FleetIQ game server group. The name must be
|
1007
|
+
# unique per Region per Amazon Web Services account.
|
1001
1008
|
# @return [String]
|
1002
1009
|
#
|
1003
1010
|
# @!attribute [rw] role_arn
|
1004
1011
|
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows
|
1005
|
-
# Amazon
|
1012
|
+
# Amazon Web Services to access your Amazon EC2 Auto Scaling groups.
|
1006
1013
|
#
|
1007
1014
|
#
|
1008
1015
|
#
|
@@ -1010,31 +1017,31 @@ module Aws::GameLift
|
|
1010
1017
|
# @return [String]
|
1011
1018
|
#
|
1012
1019
|
# @!attribute [rw] min_size
|
1013
|
-
# The minimum number of instances allowed in the EC2 Auto
|
1014
|
-
# group. During automatic scaling events, GameLift FleetIQ and
|
1015
|
-
# not scale down the group below this minimum. In
|
1016
|
-
# value should be set to at least 1. After the Auto
|
1017
|
-
# created, update this value directly in the Auto
|
1018
|
-
# the
|
1020
|
+
# The minimum number of instances allowed in the Amazon EC2 Auto
|
1021
|
+
# Scaling group. During automatic scaling events, GameLift FleetIQ and
|
1022
|
+
# Amazon EC2 do not scale down the group below this minimum. In
|
1023
|
+
# production, this value should be set to at least 1. After the Auto
|
1024
|
+
# Scaling group is created, update this value directly in the Auto
|
1025
|
+
# Scaling group using the Amazon Web Services console or APIs.
|
1019
1026
|
# @return [Integer]
|
1020
1027
|
#
|
1021
1028
|
# @!attribute [rw] max_size
|
1022
|
-
# The maximum number of instances allowed in the EC2 Auto
|
1023
|
-
# group. During automatic scaling events, GameLift FleetIQ and
|
1024
|
-
# not scale up the group above this maximum. After the Auto
|
1025
|
-
# group is created, update this value directly in the Auto
|
1026
|
-
# group using the
|
1029
|
+
# The maximum number of instances allowed in the Amazon EC2 Auto
|
1030
|
+
# Scaling group. During automatic scaling events, GameLift FleetIQ and
|
1031
|
+
# EC2 do not scale up the group above this maximum. After the Auto
|
1032
|
+
# Scaling group is created, update this value directly in the Auto
|
1033
|
+
# Scaling group using the Amazon Web Services console or APIs.
|
1027
1034
|
# @return [Integer]
|
1028
1035
|
#
|
1029
1036
|
# @!attribute [rw] launch_template
|
1030
|
-
# The EC2 launch template that contains configuration settings
|
1031
|
-
# game server code to be deployed to all instances in the game
|
1032
|
-
# group. You can specify the template using either the template
|
1033
|
-
# or ID. For help with creating a launch template, see [Creating
|
1034
|
-
# Launch Template for an Auto Scaling Group][1] in the *Amazon
|
1035
|
-
# Auto Scaling User Guide*. After the Auto
|
1036
|
-
# update this value directly in the Auto
|
1037
|
-
# console or APIs.
|
1037
|
+
# The Amazon EC2 launch template that contains configuration settings
|
1038
|
+
# and game server code to be deployed to all instances in the game
|
1039
|
+
# server group. You can specify the template using either the template
|
1040
|
+
# name or ID. For help with creating a launch template, see [Creating
|
1041
|
+
# a Launch Template for an Auto Scaling Group][1] in the *Amazon
|
1042
|
+
# Elastic Compute Cloud Auto Scaling User Guide*. After the Auto
|
1043
|
+
# Scaling group is created, update this value directly in the Auto
|
1044
|
+
# Scaling group using the Amazon Web Services console or APIs.
|
1038
1045
|
#
|
1039
1046
|
# <note markdown="1"> If you specify network interfaces in your launch template, you must
|
1040
1047
|
# explicitly set the property `AssociatePublicIpAddress` to "true".
|
@@ -1049,16 +1056,16 @@ module Aws::GameLift
|
|
1049
1056
|
# @return [Types::LaunchTemplateSpecification]
|
1050
1057
|
#
|
1051
1058
|
# @!attribute [rw] instance_definitions
|
1052
|
-
# The EC2 instance types and sizes to use in the Auto Scaling
|
1053
|
-
# The instance definitions must specify at least two different
|
1059
|
+
# The Amazon EC2 instance types and sizes to use in the Auto Scaling
|
1060
|
+
# group. The instance definitions must specify at least two different
|
1054
1061
|
# instance types that are supported by GameLift FleetIQ. For more
|
1055
1062
|
# information on instance types, see [EC2 Instance Types][1] in the
|
1056
|
-
# *Amazon
|
1057
|
-
# weighting for each instance type. If no weight
|
1058
|
-
# for an instance type, it is set to the default
|
1059
|
-
# information about capacity weighting, see [
|
1060
|
-
# Amazon EC2 Auto Scaling][2] in the Amazon EC2
|
1061
|
-
# Guide.
|
1063
|
+
# *Amazon Elastic Compute Cloud User Guide*. You can optionally
|
1064
|
+
# specify capacity weighting for each instance type. If no weight
|
1065
|
+
# value is specified for an instance type, it is set to the default
|
1066
|
+
# value "1". For more information about capacity weighting, see [
|
1067
|
+
# Instance Weighting for Amazon EC2 Auto Scaling][2] in the Amazon EC2
|
1068
|
+
# Auto Scaling User Guide.
|
1062
1069
|
#
|
1063
1070
|
#
|
1064
1071
|
#
|
@@ -1072,7 +1079,8 @@ module Aws::GameLift
|
|
1072
1079
|
# uses the metric `"PercentUtilizedGameServers"` to maintain a buffer
|
1073
1080
|
# of idle game servers that can immediately accommodate new games and
|
1074
1081
|
# players. After the Auto Scaling group is created, update this value
|
1075
|
-
# directly in the Auto Scaling group using the
|
1082
|
+
# directly in the Auto Scaling group using the Amazon Web Services
|
1083
|
+
# console or APIs.
|
1076
1084
|
# @return [Types::GameServerGroupAutoScalingPolicy]
|
1077
1085
|
#
|
1078
1086
|
# @!attribute [rw] balancing_strategy
|
@@ -1107,8 +1115,8 @@ module Aws::GameLift
|
|
1107
1115
|
# instances cannot be terminated while there are active game servers
|
1108
1116
|
# running except in the event of a forced game server group deletion
|
1109
1117
|
# (see ). An exception to this is with Spot Instances, which can be
|
1110
|
-
# terminated by
|
1111
|
-
# set to `NO_PROTECTION` by default.
|
1118
|
+
# terminated by Amazon Web Services regardless of protection status.
|
1119
|
+
# This property is set to `NO_PROTECTION` by default.
|
1112
1120
|
# @return [String]
|
1113
1121
|
#
|
1114
1122
|
# @!attribute [rw] vpc_subnets
|
@@ -1123,14 +1131,15 @@ module Aws::GameLift
|
|
1123
1131
|
#
|
1124
1132
|
# @!attribute [rw] tags
|
1125
1133
|
# A list of labels to assign to the new game server group resource.
|
1126
|
-
# Tags are developer-defined key-value pairs. Tagging
|
1127
|
-
# useful for resource management, access
|
1128
|
-
# allocation. For more information, see [ Tagging
|
1129
|
-
#
|
1130
|
-
#
|
1131
|
-
#
|
1132
|
-
#
|
1133
|
-
#
|
1134
|
+
# Tags are developer-defined key-value pairs. Tagging Amazon Web
|
1135
|
+
# Services resources is useful for resource management, access
|
1136
|
+
# management, and cost allocation. For more information, see [ Tagging
|
1137
|
+
# Amazon Web Services Resources][1] in the *Amazon Web Services
|
1138
|
+
# General Reference*. Once the resource is created, you can use
|
1139
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
1140
|
+
# and view tags, respectively. The maximum tag limit may be lower than
|
1141
|
+
# stated. See the Amazon Web Services General Reference for actual
|
1142
|
+
# tagging limits.
|
1134
1143
|
#
|
1135
1144
|
#
|
1136
1145
|
#
|
@@ -1158,9 +1167,9 @@ module Aws::GameLift
|
|
1158
1167
|
# @!attribute [rw] game_server_group
|
1159
1168
|
# The newly created game server group object, including the new ARN
|
1160
1169
|
# value for the GameLift FleetIQ game server group and the object's
|
1161
|
-
# status. The EC2 Auto Scaling group ARN is initially null,
|
1162
|
-
# group has not yet been created. This value is added once
|
1163
|
-
# server group status reaches `ACTIVE`.
|
1170
|
+
# status. The Amazon EC2 Auto Scaling group ARN is initially null,
|
1171
|
+
# since the group has not yet been created. This value is added once
|
1172
|
+
# the game server group status reaches `ACTIVE`.
|
1164
1173
|
# @return [Types::GameServerGroup]
|
1165
1174
|
#
|
1166
1175
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameServerGroupOutput AWS API Documentation
|
@@ -1221,7 +1230,11 @@ module Aws::GameLift
|
|
1221
1230
|
# A set of custom properties for a game session, formatted as
|
1222
1231
|
# key:value pairs. These properties are passed to a game server
|
1223
1232
|
# process in the GameSession object with a request to start a new game
|
1224
|
-
# session.
|
1233
|
+
# session (see [Start a Game Session][1]).
|
1234
|
+
#
|
1235
|
+
#
|
1236
|
+
#
|
1237
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
1225
1238
|
# @return [Array<Types::GameProperty>]
|
1226
1239
|
#
|
1227
1240
|
# @!attribute [rw] creator_id
|
@@ -1258,14 +1271,19 @@ module Aws::GameLift
|
|
1258
1271
|
# @!attribute [rw] game_session_data
|
1259
1272
|
# A set of custom game session properties, formatted as a single
|
1260
1273
|
# string value. This data is passed to a game server process in the
|
1261
|
-
# GameSession object with a request to start a new game session
|
1274
|
+
# GameSession object with a request to start a new game session (see
|
1275
|
+
# [Start a Game Session][1]).
|
1276
|
+
#
|
1277
|
+
#
|
1278
|
+
#
|
1279
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
1262
1280
|
# @return [String]
|
1263
1281
|
#
|
1264
1282
|
# @!attribute [rw] location
|
1265
1283
|
# A fleet's remote location to place the new game session in. If this
|
1266
1284
|
# parameter is not set, the new game session is placed in the fleet's
|
1267
|
-
# home Region. Specify a remote location with an
|
1268
|
-
# as `us-west-2`.
|
1285
|
+
# home Region. Specify a remote location with an Amazon Web Services
|
1286
|
+
# Region code such as `us-west-2`.
|
1269
1287
|
# @return [String]
|
1270
1288
|
#
|
1271
1289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameSessionInput AWS API Documentation
|
@@ -1365,9 +1383,9 @@ module Aws::GameLift
|
|
1365
1383
|
#
|
1366
1384
|
# @!attribute [rw] filter_configuration
|
1367
1385
|
# A list of locations where a queue is allowed to place new game
|
1368
|
-
# sessions. Locations are specified in the form of
|
1369
|
-
# such as `us-west-2`. If this parameter is not set,
|
1370
|
-
# be placed in any queue location.
|
1386
|
+
# sessions. Locations are specified in the form of Amazon Web Services
|
1387
|
+
# Region codes, such as `us-west-2`. If this parameter is not set,
|
1388
|
+
# game sessions can be placed in any queue location.
|
1371
1389
|
# @return [Types::FilterConfiguration]
|
1372
1390
|
#
|
1373
1391
|
# @!attribute [rw] priority_configuration
|
@@ -1395,13 +1413,14 @@ module Aws::GameLift
|
|
1395
1413
|
#
|
1396
1414
|
# @!attribute [rw] tags
|
1397
1415
|
# A list of labels to assign to the new game session queue resource.
|
1398
|
-
# Tags are developer-defined key-value pairs. Tagging
|
1399
|
-
# are useful for resource management, access
|
1400
|
-
# allocation. For more information, see [ Tagging
|
1401
|
-
#
|
1402
|
-
#
|
1403
|
-
#
|
1404
|
-
#
|
1416
|
+
# Tags are developer-defined key-value pairs. Tagging Amazon Web
|
1417
|
+
# Services resources are useful for resource management, access
|
1418
|
+
# management and cost allocation. For more information, see [ Tagging
|
1419
|
+
# Amazon Web Services Resources][1] in the *Amazon Web Services
|
1420
|
+
# General Reference*. Once the resource is created, you can use
|
1421
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
1422
|
+
# and view tags. The maximum tag limit may be lower than stated. See
|
1423
|
+
# the Amazon Web Services General Reference for actual tagging limits.
|
1405
1424
|
#
|
1406
1425
|
#
|
1407
1426
|
#
|
@@ -1605,14 +1624,14 @@ module Aws::GameLift
|
|
1605
1624
|
#
|
1606
1625
|
# @!attribute [rw] tags
|
1607
1626
|
# A list of labels to assign to the new matchmaking configuration
|
1608
|
-
# resource. Tags are developer-defined key-value pairs. Tagging
|
1609
|
-
# resources are useful for resource management, access
|
1610
|
-
# cost allocation. For more information, see [ Tagging
|
1611
|
-
# Resources][1] in the *
|
1612
|
-
# created, you can use
|
1613
|
-
# ListTagsForResource to add, remove,
|
1614
|
-
# limit may be lower than stated. See
|
1615
|
-
# actual tagging limits.
|
1627
|
+
# resource. Tags are developer-defined key-value pairs. Tagging Amazon
|
1628
|
+
# Web Services resources are useful for resource management, access
|
1629
|
+
# management and cost allocation. For more information, see [ Tagging
|
1630
|
+
# Amazon Web Services Resources][1] in the *Amazon Web Services
|
1631
|
+
# General Reference*. Once the resource is created, you can use
|
1632
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
1633
|
+
# and view tags. The maximum tag limit may be lower than stated. See
|
1634
|
+
# the Amazon Web Services General Reference for actual tagging limits.
|
1616
1635
|
#
|
1617
1636
|
#
|
1618
1637
|
#
|
@@ -1686,13 +1705,14 @@ module Aws::GameLift
|
|
1686
1705
|
#
|
1687
1706
|
# @!attribute [rw] tags
|
1688
1707
|
# A list of labels to assign to the new matchmaking rule set resource.
|
1689
|
-
# Tags are developer-defined key-value pairs. Tagging
|
1690
|
-
# are useful for resource management, access
|
1691
|
-
# allocation. For more information, see [ Tagging
|
1692
|
-
#
|
1693
|
-
#
|
1694
|
-
#
|
1695
|
-
#
|
1708
|
+
# Tags are developer-defined key-value pairs. Tagging Amazon Web
|
1709
|
+
# Services resources are useful for resource management, access
|
1710
|
+
# management and cost allocation. For more information, see [ Tagging
|
1711
|
+
# Amazon Web Services Resources][1] in the *Amazon Web Services
|
1712
|
+
# General Reference*. Once the resource is created, you can use
|
1713
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
1714
|
+
# and view tags. The maximum tag limit may be lower than stated. See
|
1715
|
+
# the Amazon Web Services General Reference for actual tagging limits.
|
1696
1716
|
#
|
1697
1717
|
#
|
1698
1718
|
#
|
@@ -1794,10 +1814,10 @@ module Aws::GameLift
|
|
1794
1814
|
#
|
1795
1815
|
# @!attribute [rw] player_data_map
|
1796
1816
|
# Map of string pairs, each specifying a player ID and a set of
|
1797
|
-
# developer-defined information related to the player. Amazon
|
1798
|
-
# does not use this data, so it can be formatted as needed
|
1799
|
-
# the game. Any player data strings for player IDs that are
|
1800
|
-
# included in the `PlayerIds` parameter are ignored.
|
1817
|
+
# developer-defined information related to the player. Amazon Web
|
1818
|
+
# Services does not use this data, so it can be formatted as needed
|
1819
|
+
# for use in the game. Any player data strings for player IDs that are
|
1820
|
+
# not included in the `PlayerIds` parameter are ignored.
|
1801
1821
|
# @return [Hash<String,String>]
|
1802
1822
|
#
|
1803
1823
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreatePlayerSessionsInput AWS API Documentation
|
@@ -1862,12 +1882,12 @@ module Aws::GameLift
|
|
1862
1882
|
# The location of the Amazon S3 bucket where a zipped file containing
|
1863
1883
|
# your Realtime scripts is stored. The storage location must specify
|
1864
1884
|
# the Amazon S3 bucket name, the zip file name (the "key"), and a
|
1865
|
-
# role ARN that allows Amazon
|
1866
|
-
# location. The S3 bucket must be in the same Region where you
|
1867
|
-
# create a new script. By default, Amazon
|
1868
|
-
# version of the zip file; if you have S3 object versioning
|
1869
|
-
# you can use the `ObjectVersion` parameter to specify an
|
1870
|
-
# version.
|
1885
|
+
# role ARN that allows Amazon Web Services to access the Amazon S3
|
1886
|
+
# storage location. The S3 bucket must be in the same Region where you
|
1887
|
+
# want to create a new script. By default, Amazon Web Services uploads
|
1888
|
+
# the latest version of the zip file; if you have S3 object versioning
|
1889
|
+
# turned on, you can use the `ObjectVersion` parameter to specify an
|
1890
|
+
# earlier version.
|
1871
1891
|
# @return [Types::S3Location]
|
1872
1892
|
#
|
1873
1893
|
# @!attribute [rw] zip_file
|
@@ -1875,21 +1895,22 @@ module Aws::GameLift
|
|
1875
1895
|
# zip file. The zip file can have one or multiple files. Maximum size
|
1876
1896
|
# of a zip file is 5 MB.
|
1877
1897
|
#
|
1878
|
-
# When using the
|
1879
|
-
# set to the zip file name. It must be prepended with the
|
1880
|
-
# "fileb://" to indicate that the file data is a binary
|
1881
|
-
# example: `--zip-file fileb://myRealtimeScript.zip`.
|
1898
|
+
# When using the Amazon Web Services CLI tool to create a script, this
|
1899
|
+
# parameter is set to the zip file name. It must be prepended with the
|
1900
|
+
# string "fileb://" to indicate that the file data is a binary
|
1901
|
+
# object. For example: `--zip-file fileb://myRealtimeScript.zip`.
|
1882
1902
|
# @return [String]
|
1883
1903
|
#
|
1884
1904
|
# @!attribute [rw] tags
|
1885
1905
|
# A list of labels to assign to the new script resource. Tags are
|
1886
|
-
# developer-defined key-value pairs. Tagging
|
1887
|
-
# for resource management, access management and
|
1888
|
-
# more information, see [ Tagging
|
1889
|
-
#
|
1890
|
-
#
|
1891
|
-
# and
|
1892
|
-
#
|
1906
|
+
# developer-defined key-value pairs. Tagging Amazon Web Services
|
1907
|
+
# resources are useful for resource management, access management and
|
1908
|
+
# cost allocation. For more information, see [ Tagging Amazon Web
|
1909
|
+
# Services Resources][1] in the *Amazon Web Services General
|
1910
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
1911
|
+
# UntagResource, and ListTagsForResource to add, remove, and view
|
1912
|
+
# tags. The maximum tag limit may be lower than stated. See the Amazon
|
1913
|
+
# Web Services General Reference for actual tagging limits.
|
1893
1914
|
#
|
1894
1915
|
#
|
1895
1916
|
#
|
@@ -1915,7 +1936,7 @@ module Aws::GameLift
|
|
1915
1936
|
# storage location reflects the information that was provided in the
|
1916
1937
|
# *CreateScript* request; (2) If the script file was uploaded from a
|
1917
1938
|
# local zip file, the storage location reflects an S3 location
|
1918
|
-
# controls by the Amazon
|
1939
|
+
# controls by the Amazon Web Services service.
|
1919
1940
|
# @return [Types::Script]
|
1920
1941
|
#
|
1921
1942
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateScriptOutput AWS API Documentation
|
@@ -1937,17 +1958,17 @@ module Aws::GameLift
|
|
1937
1958
|
# }
|
1938
1959
|
#
|
1939
1960
|
# @!attribute [rw] game_lift_aws_account_id
|
1940
|
-
# A unique identifier for the
|
1941
|
-
# GameLift fleet. You can find your Account ID in the
|
1942
|
-
# Console under account settings.
|
1961
|
+
# A unique identifier for the Amazon Web Services account that you use
|
1962
|
+
# to manage your GameLift fleet. You can find your Account ID in the
|
1963
|
+
# Amazon Web Services Management Console under account settings.
|
1943
1964
|
# @return [String]
|
1944
1965
|
#
|
1945
1966
|
# @!attribute [rw] peer_vpc_id
|
1946
1967
|
# A unique identifier for a VPC with resources to be accessed by your
|
1947
1968
|
# GameLift fleet. The VPC must be in the same Region as your fleet. To
|
1948
|
-
# look up a VPC ID, use the [VPC Dashboard][1] in the
|
1949
|
-
# Console. Learn more about VPC peering in [VPC
|
1950
|
-
# Fleets][2].
|
1969
|
+
# look up a VPC ID, use the [VPC Dashboard][1] in the Amazon Web
|
1970
|
+
# Services Management Console. Learn more about VPC peering in [VPC
|
1971
|
+
# Peering with GameLift Fleets][2].
|
1951
1972
|
#
|
1952
1973
|
#
|
1953
1974
|
#
|
@@ -1992,22 +2013,23 @@ module Aws::GameLift
|
|
1992
2013
|
#
|
1993
2014
|
# @!attribute [rw] fleet_id
|
1994
2015
|
# A unique identifier for the fleet. You can use either the fleet ID
|
1995
|
-
# or ARN value. This tells Amazon
|
1996
|
-
# with.
|
2016
|
+
# or ARN value. This tells Amazon Web Services which GameLift VPC to
|
2017
|
+
# peer with.
|
1997
2018
|
# @return [String]
|
1998
2019
|
#
|
1999
2020
|
# @!attribute [rw] peer_vpc_aws_account_id
|
2000
|
-
# A unique identifier for the
|
2001
|
-
# to peer your Amazon
|
2002
|
-
# ID in the
|
2021
|
+
# A unique identifier for the Amazon Web Services account with the VPC
|
2022
|
+
# that you want to peer your Amazon Web Services fleet with. You can
|
2023
|
+
# find your Account ID in the Amazon Web Services Management Console
|
2024
|
+
# under account settings.
|
2003
2025
|
# @return [String]
|
2004
2026
|
#
|
2005
2027
|
# @!attribute [rw] peer_vpc_id
|
2006
2028
|
# A unique identifier for a VPC with resources to be accessed by your
|
2007
2029
|
# GameLift fleet. The VPC must be in the same Region as your fleet. To
|
2008
|
-
# look up a VPC ID, use the [VPC Dashboard][1] in the
|
2009
|
-
# Console. Learn more about VPC peering in [VPC
|
2010
|
-
# Fleets][2].
|
2030
|
+
# look up a VPC ID, use the [VPC Dashboard][1] in the Amazon Web
|
2031
|
+
# Services Management Console. Learn more about VPC peering in [VPC
|
2032
|
+
# Peering with GameLift Fleets][2].
|
2011
2033
|
#
|
2012
2034
|
#
|
2013
2035
|
#
|
@@ -2112,7 +2134,7 @@ module Aws::GameLift
|
|
2112
2134
|
#
|
2113
2135
|
# @!attribute [rw] locations
|
2114
2136
|
# The list of fleet locations to delete. Specify locations in the form
|
2115
|
-
# of an
|
2137
|
+
# of an Amazon Web Services Region code, such as `us-west-2`.
|
2116
2138
|
# @return [Array<String>]
|
2117
2139
|
#
|
2118
2140
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteFleetLocationsInput AWS API Documentation
|
@@ -2173,16 +2195,16 @@ module Aws::GameLift
|
|
2173
2195
|
# @!attribute [rw] delete_option
|
2174
2196
|
# The type of delete to perform. Options include the following:
|
2175
2197
|
#
|
2176
|
-
# * `SAFE_DELETE` – (default) Terminates the game server group and
|
2177
|
-
# Auto Scaling group only when it has no game servers
|
2178
|
-
# `UTILIZED` status.
|
2198
|
+
# * `SAFE_DELETE` – (default) Terminates the game server group and
|
2199
|
+
# Amazon EC2 Auto Scaling group only when it has no game servers
|
2200
|
+
# that are in `UTILIZED` status.
|
2179
2201
|
#
|
2180
2202
|
# * `FORCE_DELETE` – Terminates the game server group, including all
|
2181
2203
|
# active game servers regardless of their utilization status, and
|
2182
|
-
# the EC2 Auto Scaling group.
|
2204
|
+
# the Amazon EC2 Auto Scaling group.
|
2183
2205
|
#
|
2184
2206
|
# * `RETAIN` – Does a safe delete of the game server group but retains
|
2185
|
-
# the EC2 Auto Scaling group as is.
|
2207
|
+
# the Amazon EC2 Auto Scaling group as is.
|
2186
2208
|
# @return [String]
|
2187
2209
|
#
|
2188
2210
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteGameServerGroupInput AWS API Documentation
|
@@ -2350,17 +2372,17 @@ module Aws::GameLift
|
|
2350
2372
|
# }
|
2351
2373
|
#
|
2352
2374
|
# @!attribute [rw] game_lift_aws_account_id
|
2353
|
-
# A unique identifier for the
|
2354
|
-
# GameLift fleet. You can find your Account ID in the
|
2355
|
-
# Console under account settings.
|
2375
|
+
# A unique identifier for the Amazon Web Services account that you use
|
2376
|
+
# to manage your GameLift fleet. You can find your Account ID in the
|
2377
|
+
# Amazon Web Services Management Console under account settings.
|
2356
2378
|
# @return [String]
|
2357
2379
|
#
|
2358
2380
|
# @!attribute [rw] peer_vpc_id
|
2359
2381
|
# A unique identifier for a VPC with resources to be accessed by your
|
2360
2382
|
# GameLift fleet. The VPC must be in the same Region as your fleet. To
|
2361
|
-
# look up a VPC ID, use the [VPC Dashboard][1] in the
|
2362
|
-
# Console. Learn more about VPC peering in [VPC
|
2363
|
-
# Fleets][2].
|
2383
|
+
# look up a VPC ID, use the [VPC Dashboard][1] in the Amazon Web
|
2384
|
+
# Services Management Console. Learn more about VPC peering in [VPC
|
2385
|
+
# Peering with GameLift Fleets][2].
|
2364
2386
|
#
|
2365
2387
|
#
|
2366
2388
|
#
|
@@ -2526,16 +2548,16 @@ module Aws::GameLift
|
|
2526
2548
|
# }
|
2527
2549
|
#
|
2528
2550
|
# @!attribute [rw] ec2_instance_type
|
2529
|
-
# Name of an EC2 instance type that is supported in GameLift. A
|
2530
|
-
# instance type determines the computing resources of each
|
2531
|
-
# the fleet, including CPU, memory, storage, and
|
2532
|
-
# Do not specify a value for this parameter to
|
2533
|
-
# instance types.
|
2551
|
+
# Name of an Amazon EC2 instance type that is supported in GameLift. A
|
2552
|
+
# fleet instance type determines the computing resources of each
|
2553
|
+
# instance in the fleet, including CPU, memory, storage, and
|
2554
|
+
# networking capacity. Do not specify a value for this parameter to
|
2555
|
+
# retrieve limits for all instance types.
|
2534
2556
|
# @return [String]
|
2535
2557
|
#
|
2536
2558
|
# @!attribute [rw] location
|
2537
2559
|
# The name of a remote location to request instance limits for, in the
|
2538
|
-
# form of an
|
2560
|
+
# form of an Amazon Web Services Region code such as `us-west-2`.
|
2539
2561
|
# @return [String]
|
2540
2562
|
#
|
2541
2563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeEC2InstanceLimitsInput AWS API Documentation
|
@@ -2789,7 +2811,8 @@ module Aws::GameLift
|
|
2789
2811
|
#
|
2790
2812
|
# @!attribute [rw] locations
|
2791
2813
|
# A list of fleet locations to retrieve information for. Specify
|
2792
|
-
# locations in the form of an
|
2814
|
+
# locations in the form of an Amazon Web Services Region code, such as
|
2815
|
+
# `us-west-2`.
|
2793
2816
|
# @return [Array<String>]
|
2794
2817
|
#
|
2795
2818
|
# @!attribute [rw] limit
|
@@ -2873,7 +2896,8 @@ module Aws::GameLift
|
|
2873
2896
|
#
|
2874
2897
|
# @!attribute [rw] location
|
2875
2898
|
# The fleet location to retrieve capacity information for. Specify a
|
2876
|
-
# location in the form of an
|
2899
|
+
# location in the form of an Amazon Web Services Region code, such as
|
2900
|
+
# `us-west-2`.
|
2877
2901
|
# @return [String]
|
2878
2902
|
#
|
2879
2903
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetLocationCapacityInput AWS API Documentation
|
@@ -2918,7 +2942,8 @@ module Aws::GameLift
|
|
2918
2942
|
#
|
2919
2943
|
# @!attribute [rw] location
|
2920
2944
|
# The fleet location to retrieve utilization information for. Specify
|
2921
|
-
# a location in the form of an
|
2945
|
+
# a location in the form of an Amazon Web Services Region code, such
|
2946
|
+
# as `us-west-2`.
|
2922
2947
|
# @return [String]
|
2923
2948
|
#
|
2924
2949
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetLocationUtilizationInput AWS API Documentation
|
@@ -2963,7 +2988,7 @@ module Aws::GameLift
|
|
2963
2988
|
#
|
2964
2989
|
# @!attribute [rw] location
|
2965
2990
|
# A remote location to check for status of port setting updates. Use
|
2966
|
-
# the
|
2991
|
+
# the Amazon Web Services Region code format, such as `us-west-2`.
|
2967
2992
|
# @return [String]
|
2968
2993
|
#
|
2969
2994
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetPortSettingsInput AWS API Documentation
|
@@ -3004,8 +3029,8 @@ module Aws::GameLift
|
|
3004
3029
|
# @return [String]
|
3005
3030
|
#
|
3006
3031
|
# @!attribute [rw] location
|
3007
|
-
# The requested fleet location, expressed as an
|
3008
|
-
# as `us-west-2`.
|
3032
|
+
# The requested fleet location, expressed as an Amazon Web Services
|
3033
|
+
# Region code, such as `us-west-2`.
|
3009
3034
|
# @return [String]
|
3010
3035
|
#
|
3011
3036
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetPortSettingsOutput AWS API Documentation
|
@@ -3161,8 +3186,8 @@ module Aws::GameLift
|
|
3161
3186
|
# @return [String]
|
3162
3187
|
#
|
3163
3188
|
# @!attribute [rw] instance_ids
|
3164
|
-
# The EC2 instance IDs that you want to retrieve status on.
|
3165
|
-
# instance IDs use a 17-character format, for example:
|
3189
|
+
# The Amazon EC2 instance IDs that you want to retrieve status on.
|
3190
|
+
# Amazon EC2 instance IDs use a 17-character format, for example:
|
3166
3191
|
# `i-1234567890abcdef0`. To retrieve all instances in the game server
|
3167
3192
|
# group, leave this parameter empty.
|
3168
3193
|
# @return [Array<String>]
|
@@ -3253,8 +3278,8 @@ module Aws::GameLift
|
|
3253
3278
|
#
|
3254
3279
|
# @!attribute [rw] location
|
3255
3280
|
# A fleet location to get game sessions for. You can specify a
|
3256
|
-
# fleet's home Region or a remote location. Use the
|
3257
|
-
# format, such as `us-west-2`.
|
3281
|
+
# fleet's home Region or a remote location. Use the Amazon Web
|
3282
|
+
# Services Region code format, such as `us-west-2`.
|
3258
3283
|
# @return [String]
|
3259
3284
|
#
|
3260
3285
|
# @!attribute [rw] status_filter
|
@@ -3440,8 +3465,8 @@ module Aws::GameLift
|
|
3440
3465
|
#
|
3441
3466
|
# @!attribute [rw] location
|
3442
3467
|
# A fleet location to get game session details for. You can specify a
|
3443
|
-
# fleet's home Region or a remote location. Use the
|
3444
|
-
# format, such as `us-west-2`.
|
3468
|
+
# fleet's home Region or a remote location. Use the Amazon Web
|
3469
|
+
# Services Region code format, such as `us-west-2`.
|
3445
3470
|
# @return [String]
|
3446
3471
|
#
|
3447
3472
|
# @!attribute [rw] status_filter
|
@@ -3536,7 +3561,7 @@ module Aws::GameLift
|
|
3536
3561
|
#
|
3537
3562
|
# @!attribute [rw] location
|
3538
3563
|
# The name of a location to retrieve instance information for, in the
|
3539
|
-
# form of an
|
3564
|
+
# form of an Amazon Web Services Region code such as `us-west-2`.
|
3540
3565
|
# @return [String]
|
3541
3566
|
#
|
3542
3567
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeInstancesInput AWS API Documentation
|
@@ -3886,8 +3911,8 @@ module Aws::GameLift
|
|
3886
3911
|
# }
|
3887
3912
|
#
|
3888
3913
|
# @!attribute [rw] fleet_id
|
3889
|
-
# A unique identifier for the fleet to retrieve scaling
|
3890
|
-
# You can use either the fleet ID or ARN value.
|
3914
|
+
# A unique identifier for the fleet for which to retrieve scaling
|
3915
|
+
# policies. You can use either the fleet ID or ARN value.
|
3891
3916
|
# @return [String]
|
3892
3917
|
#
|
3893
3918
|
# @!attribute [rw] status_filter
|
@@ -3925,7 +3950,8 @@ module Aws::GameLift
|
|
3925
3950
|
# @return [String]
|
3926
3951
|
#
|
3927
3952
|
# @!attribute [rw] location
|
3928
|
-
#
|
3953
|
+
# The fleet location. If you don't specify this value, the response
|
3954
|
+
# contains the scaling policies of every location in the fleet.
|
3929
3955
|
# @return [String]
|
3930
3956
|
#
|
3931
3957
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeScalingPoliciesInput AWS API Documentation
|
@@ -4002,7 +4028,7 @@ module Aws::GameLift
|
|
4002
4028
|
|
4003
4029
|
# @!attribute [rw] vpc_peering_authorizations
|
4004
4030
|
# A collection of objects that describe all valid VPC peering
|
4005
|
-
# operations for the current
|
4031
|
+
# operations for the current Amazon Web Services account.
|
4006
4032
|
# @return [Array<Types::VpcPeeringAuthorization>]
|
4007
4033
|
#
|
4008
4034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeVpcPeeringAuthorizationsOutput AWS API Documentation
|
@@ -4080,7 +4106,7 @@ module Aws::GameLift
|
|
4080
4106
|
include Aws::Structure
|
4081
4107
|
end
|
4082
4108
|
|
4083
|
-
# Resource capacity settings. Fleet capacity is measured in EC2
|
4109
|
+
# Resource capacity settings. Fleet capacity is measured in Amazon EC2
|
4084
4110
|
# instances. Pending and terminating counts are non-zero when the fleet
|
4085
4111
|
# capacity is adjusting to a scaling event or if access to resources is
|
4086
4112
|
# temporarily affected.
|
@@ -4133,19 +4159,20 @@ module Aws::GameLift
|
|
4133
4159
|
include Aws::Structure
|
4134
4160
|
end
|
4135
4161
|
|
4136
|
-
# The GameLift service limits for an EC2 instance type and
|
4137
|
-
# utilization. GameLift allows
|
4138
|
-
# instances, per instance type, per
|
4139
|
-
#
|
4140
|
-
# the **Service limits** page
|
4162
|
+
# The GameLift service limits for an Amazon EC2 instance type and
|
4163
|
+
# current utilization. GameLift allows Amazon Web Services accounts a
|
4164
|
+
# maximum number of instances, per instance type, per Amazon Web
|
4165
|
+
# Services Region or location, for use with GameLift. You can request an
|
4166
|
+
# limit increase for your account by using the **Service limits** page
|
4167
|
+
# in the GameLift console.
|
4141
4168
|
#
|
4142
4169
|
# **Related actions**
|
4143
4170
|
#
|
4144
4171
|
# DescribeEC2InstanceLimits
|
4145
4172
|
#
|
4146
4173
|
# @!attribute [rw] ec2_instance_type
|
4147
|
-
# The name of an EC2 instance type. See [Amazon
|
4148
|
-
# for detailed descriptions.
|
4174
|
+
# The name of an Amazon EC2 instance type. See [Amazon Elastic Compute
|
4175
|
+
# Cloud Instance Types][1] for detailed descriptions.
|
4149
4176
|
#
|
4150
4177
|
#
|
4151
4178
|
#
|
@@ -4154,7 +4181,7 @@ module Aws::GameLift
|
|
4154
4181
|
#
|
4155
4182
|
# @!attribute [rw] current_instances
|
4156
4183
|
# The number of instances for the specified type and location that are
|
4157
|
-
# currently being used by the
|
4184
|
+
# currently being used by the Amazon Web Services account.
|
4158
4185
|
# @return [Integer]
|
4159
4186
|
#
|
4160
4187
|
# @!attribute [rw] instance_limit
|
@@ -4163,7 +4190,7 @@ module Aws::GameLift
|
|
4163
4190
|
# @return [Integer]
|
4164
4191
|
#
|
4165
4192
|
# @!attribute [rw] location
|
4166
|
-
# An
|
4193
|
+
# An Amazon Web Services Region code, such as `us-west-2`.
|
4167
4194
|
# @return [String]
|
4168
4195
|
#
|
4169
4196
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/EC2InstanceLimit AWS API Documentation
|
@@ -4197,7 +4224,7 @@ module Aws::GameLift
|
|
4197
4224
|
# @!attribute [rw] event_code
|
4198
4225
|
# The type of event being logged.
|
4199
4226
|
#
|
4200
|
-
# **Fleet
|
4227
|
+
# **Fleet state transition events:**
|
4201
4228
|
#
|
4202
4229
|
# * FLEET\_CREATED -- A fleet resource was successfully created with a
|
4203
4230
|
# status of `NEW`. Event messaging includes the fleet ID.
|
@@ -4206,24 +4233,46 @@ module Aws::GameLift
|
|
4206
4233
|
# `DOWNLOADING`. The compressed build has started downloading to a
|
4207
4234
|
# fleet instance for installation.
|
4208
4235
|
#
|
4236
|
+
# * FLEET\_STATE\_VALIDATING -- Fleet status changed from
|
4237
|
+
# `DOWNLOADING` to `VALIDATING`. GameLift has successfully
|
4238
|
+
# downloaded the build and is now validating the build files.
|
4239
|
+
#
|
4240
|
+
# * FLEET\_STATE\_BUILDING -- Fleet status changed from `VALIDATING`
|
4241
|
+
# to `BUILDING`. GameLift has successfully verified the build files
|
4242
|
+
# and is now running the installation scripts.
|
4243
|
+
#
|
4244
|
+
# * FLEET\_STATE\_ACTIVATING -- Fleet status changed from `BUILDING`
|
4245
|
+
# to `ACTIVATING`. GameLift is trying to launch an instance and test
|
4246
|
+
# the connectivity between the build and the GameLift Service via
|
4247
|
+
# the Server SDK.
|
4248
|
+
#
|
4249
|
+
# * FLEET\_STATE\_ACTIVE -- The fleet's status changed from
|
4250
|
+
# `ACTIVATING` to `ACTIVE`. The fleet is now ready to host game
|
4251
|
+
# sessions.
|
4252
|
+
#
|
4253
|
+
# * FLEET\_STATE\_ERROR -- The Fleet's status changed to `ERROR`.
|
4254
|
+
# Describe the fleet event message for more details.
|
4255
|
+
#
|
4256
|
+
# **Fleet creation events (ordered by fleet creation activity):**
|
4257
|
+
#
|
4209
4258
|
# * FLEET\_BINARY\_DOWNLOAD\_FAILED -- The build failed to download to
|
4210
4259
|
# the fleet instance.
|
4211
4260
|
#
|
4212
|
-
# * FLEET\_CREATION\_EXTRACTING\_BUILD
|
4261
|
+
# * FLEET\_CREATION\_EXTRACTING\_BUILD -- The game server build was
|
4213
4262
|
# successfully downloaded to an instance, and the build files are
|
4214
4263
|
# now being extracted from the uploaded build and saved to an
|
4215
4264
|
# instance. Failure at this stage prevents a fleet from moving to
|
4216
|
-
#
|
4265
|
+
# ACTIVE status. Logs for this stage display a list of the files
|
4217
4266
|
# that are extracted and saved on the instance. Access the logs by
|
4218
4267
|
# using the URL in *PreSignedLogUrl*.
|
4219
4268
|
#
|
4220
|
-
# * FLEET\_CREATION\_RUNNING\_INSTALLER
|
4269
|
+
# * FLEET\_CREATION\_RUNNING\_INSTALLER -- The game server build files
|
4221
4270
|
# were successfully extracted, and the GameLift is now running the
|
4222
4271
|
# build's install script (if one is included). Failure in this
|
4223
|
-
# stage prevents a fleet from moving to
|
4224
|
-
#
|
4225
|
-
#
|
4226
|
-
#
|
4272
|
+
# stage prevents a fleet from moving to ACTIVE status. Logs for this
|
4273
|
+
# stage list the installation steps and whether or not the install
|
4274
|
+
# completed successfully. Access the logs by using the URL in
|
4275
|
+
# *PreSignedLogUrl*.
|
4227
4276
|
#
|
4228
4277
|
# * FLEET\_CREATION\_VALIDATING\_RUNTIME\_CONFIG -- The build process
|
4229
4278
|
# was successful, and the GameLift is now verifying that the game
|
@@ -4235,47 +4284,46 @@ module Aws::GameLift
|
|
4235
4284
|
# the runtime configuration and indicate whether each is found.
|
4236
4285
|
# Access the logs by using the URL in *PreSignedLogUrl*.
|
4237
4286
|
#
|
4238
|
-
# * FLEET\_STATE\_VALIDATING -- Fleet status changed from
|
4239
|
-
# `DOWNLOADING` to `VALIDATING`.
|
4240
|
-
#
|
4241
4287
|
# * FLEET\_VALIDATION\_LAUNCH\_PATH\_NOT\_FOUND -- Validation of the
|
4242
4288
|
# runtime configuration failed because the executable specified in a
|
4243
4289
|
# launch path does not exist on the instance.
|
4244
4290
|
#
|
4245
|
-
# * FLEET\_STATE\_BUILDING -- Fleet status changed from `VALIDATING`
|
4246
|
-
# to `BUILDING`.
|
4247
|
-
#
|
4248
4291
|
# * FLEET\_VALIDATION\_EXECUTABLE\_RUNTIME\_FAILURE -- Validation of
|
4249
4292
|
# the runtime configuration failed because the executable specified
|
4250
4293
|
# in a launch path failed to run on the fleet instance.
|
4251
4294
|
#
|
4252
|
-
# * FLEET\
|
4253
|
-
#
|
4295
|
+
# * FLEET\_VALIDATION\_TIMED\_OUT -- Validation of the fleet at the
|
4296
|
+
# end of creation timed out. Try fleet creation again.
|
4254
4297
|
#
|
4255
|
-
# * FLEET\_ACTIVATION\_FAILED
|
4298
|
+
# * FLEET\_ACTIVATION\_FAILED -- The fleet failed to successfully
|
4256
4299
|
# complete one of the steps in the fleet activation process. This
|
4257
4300
|
# event code indicates that the game build was successfully
|
4258
4301
|
# downloaded to a fleet instance, built, and validated, but was not
|
4259
|
-
# able to start a server process.
|
4260
|
-
# Creation Issues][1]
|
4302
|
+
# able to start a server process. For more information, see [Debug
|
4303
|
+
# Fleet Creation Issues][1].
|
4261
4304
|
#
|
4262
|
-
# * FLEET\
|
4263
|
-
#
|
4264
|
-
#
|
4305
|
+
# * FLEET\_ACTIVATION\_FAILED\_NO\_INSTANCES -- Fleet creation was not
|
4306
|
+
# able to obtain any instances based on the input fleet attributes.
|
4307
|
+
# Try again at a different time or choose a different combination of
|
4308
|
+
# fleet attributes such as fleet type, instance type, etc.
|
4309
|
+
#
|
4310
|
+
# * FLEET\_INITIALIZATION\_FAILED -- A generic exception occurred
|
4311
|
+
# during fleet creation. Describe the fleet event message for more
|
4312
|
+
# details.
|
4265
4313
|
#
|
4266
4314
|
# **VPC peering events:**
|
4267
4315
|
#
|
4268
4316
|
# * FLEET\_VPC\_PEERING\_SUCCEEDED -- A VPC peering connection has
|
4269
4317
|
# been established between the VPC for an GameLift fleet and a VPC
|
4270
|
-
# in your
|
4318
|
+
# in your Amazon Web Services account.
|
4271
4319
|
#
|
4272
4320
|
# * FLEET\_VPC\_PEERING\_FAILED -- A requested VPC peering connection
|
4273
4321
|
# has failed. Event details and status information (see
|
4274
4322
|
# DescribeVpcPeeringConnections) provide additional detail. A common
|
4275
4323
|
# reason for peering failure is that the two VPCs have overlapping
|
4276
4324
|
# CIDR blocks of IPv4 addresses. To resolve this, change the CIDR
|
4277
|
-
# block for the VPC in your
|
4278
|
-
# peering failures, see
|
4325
|
+
# block for the VPC in your Amazon Web Services account. For more
|
4326
|
+
# information on VPC peering failures, see
|
4279
4327
|
# [https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html][2]
|
4280
4328
|
#
|
4281
4329
|
# * FLEET\_VPC\_PEERING\_DELETED -- A VPC peering connection has been
|
@@ -4288,6 +4336,50 @@ module Aws::GameLift
|
|
4288
4336
|
#
|
4289
4337
|
# ^
|
4290
4338
|
#
|
4339
|
+
# **Spot process events:**
|
4340
|
+
#
|
4341
|
+
# * SERVER\_PROCESS\_INVALID\_PATH -- The game server executable or
|
4342
|
+
# script could not be found based on the Fleet runtime
|
4343
|
+
# configuration. Check that the launch path is correct based on the
|
4344
|
+
# operating system of the Fleet.
|
4345
|
+
#
|
4346
|
+
# * SERVER\_PROCESS\_SDK\_INITIALIZATION\_TIMEOUT -- The server
|
4347
|
+
# process did not call InitSDK() within the time expected. Check
|
4348
|
+
# your game session log to see why InitSDK() was not called in time.
|
4349
|
+
#
|
4350
|
+
# * SERVER\_PROCESS\_PROCESS\_READY\_TIMEOUT -- The server process did
|
4351
|
+
# not call ProcessReady() within the time expected after calling
|
4352
|
+
# InitSDK(). Check your game session log to see why ProcessReady()
|
4353
|
+
# was not called in time.
|
4354
|
+
#
|
4355
|
+
# * SERVER\_PROCESS\_CRASHED -- The server process exited without
|
4356
|
+
# calling ProcessEnding(). Check your game session log to see why
|
4357
|
+
# ProcessEnding() was not called.
|
4358
|
+
#
|
4359
|
+
# * SERVER\_PROCESS\_TERMINATED\_UNHEALTHY -- The server process did
|
4360
|
+
# not report a valid health check for too long and was therefore
|
4361
|
+
# terminated by GameLift. Check your game session log to see if the
|
4362
|
+
# thread became stuck processing a synchronous task for too long.
|
4363
|
+
#
|
4364
|
+
# * SERVER\_PROCESS\_FORCE\_TERMINATED -- The server process did not
|
4365
|
+
# exit cleanly after OnProcessTerminate() was sent within the time
|
4366
|
+
# expected. Check your game session log to see why termination took
|
4367
|
+
# longer than expected.
|
4368
|
+
#
|
4369
|
+
# * SERVER\_PROCESS\_PROCESS\_EXIT\_TIMEOUT -- The server process did
|
4370
|
+
# not exit cleanly within the time expected after calling
|
4371
|
+
# ProcessEnding(). Check your game session log to see why
|
4372
|
+
# termination took longer than expected.
|
4373
|
+
#
|
4374
|
+
# **Game session events:**
|
4375
|
+
#
|
4376
|
+
# * GAME\_SESSION\_ACTIVATION\_TIMEOUT -- GameSession failed to
|
4377
|
+
# activate within the expected time. Check your game session log to
|
4378
|
+
# see why ActivateGameSession() took longer to complete than
|
4379
|
+
# expected.
|
4380
|
+
#
|
4381
|
+
# ^
|
4382
|
+
#
|
4291
4383
|
# **Other fleet events:**
|
4292
4384
|
#
|
4293
4385
|
# * FLEET\_SCALING\_EVENT -- A change was made to the fleet's
|
@@ -4355,7 +4447,7 @@ module Aws::GameLift
|
|
4355
4447
|
#
|
4356
4448
|
# @!attribute [rw] allowed_locations
|
4357
4449
|
# A list of locations to allow game session placement in, in the form
|
4358
|
-
# of
|
4450
|
+
# of Amazon Web Services Region codes such as `us-west-2`.
|
4359
4451
|
# @return [Array<String>]
|
4360
4452
|
#
|
4361
4453
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/FilterConfiguration AWS API Documentation
|
@@ -4394,10 +4486,10 @@ module Aws::GameLift
|
|
4394
4486
|
# @return [String]
|
4395
4487
|
#
|
4396
4488
|
# @!attribute [rw] instance_type
|
4397
|
-
# The EC2 instance type that determines the computing resources
|
4398
|
-
# each instance in the fleet. Instance type defines the CPU,
|
4399
|
-
# storage, and networking capacity. See [Amazon
|
4400
|
-
# for detailed descriptions.
|
4489
|
+
# The Amazon EC2 instance type that determines the computing resources
|
4490
|
+
# of each instance in the fleet. Instance type defines the CPU,
|
4491
|
+
# memory, storage, and networking capacity. See [Amazon Elastic
|
4492
|
+
# Compute Cloud Instance Types][1] for detailed descriptions.
|
4401
4493
|
#
|
4402
4494
|
#
|
4403
4495
|
#
|
@@ -4534,14 +4626,14 @@ module Aws::GameLift
|
|
4534
4626
|
# @return [Array<String>]
|
4535
4627
|
#
|
4536
4628
|
# @!attribute [rw] instance_role_arn
|
4537
|
-
# A unique identifier for an
|
4538
|
-
#
|
4539
|
-
# runs on an instance in this fleet can assume the
|
4540
|
-
# install scripts, server processes, and daemons
|
4541
|
-
# processes). Create a role or look up a role's ARN by
|
4542
|
-
# dashboard][1] in the
|
4543
|
-
# on-box credentials for your game
|
4544
|
-
# resources from a game server][2].
|
4629
|
+
# A unique identifier for an IAM role that manages access to your
|
4630
|
+
# Amazon Web Services services. With an instance role ARN set, any
|
4631
|
+
# application that runs on an instance in this fleet can assume the
|
4632
|
+
# role, including install scripts, server processes, and daemons
|
4633
|
+
# (background processes). Create a role or look up a role's ARN by
|
4634
|
+
# using the [IAM dashboard][1] in the Amazon Web Services Management
|
4635
|
+
# Console. Learn more about using on-box credentials for your game
|
4636
|
+
# servers at [ Access external resources from a game server][2].
|
4545
4637
|
#
|
4546
4638
|
#
|
4547
4639
|
#
|
@@ -4589,8 +4681,14 @@ module Aws::GameLift
|
|
4589
4681
|
#
|
4590
4682
|
# **Related actions**
|
4591
4683
|
#
|
4592
|
-
# DescribeFleetCapacity \| DescribeFleetLocationCapacity \|
|
4593
|
-
# UpdateFleetCapacity
|
4684
|
+
# [DescribeFleetCapacity][1] \| [DescribeFleetLocationCapacity][2] \|
|
4685
|
+
# [UpdateFleetCapacity][3]
|
4686
|
+
#
|
4687
|
+
#
|
4688
|
+
#
|
4689
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html
|
4690
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html
|
4691
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html
|
4594
4692
|
#
|
4595
4693
|
# @!attribute [rw] fleet_id
|
4596
4694
|
# A unique identifier for the fleet associated with the location.
|
@@ -4608,10 +4706,10 @@ module Aws::GameLift
|
|
4608
4706
|
# @return [String]
|
4609
4707
|
#
|
4610
4708
|
# @!attribute [rw] instance_type
|
4611
|
-
# The EC2 instance type that is used for all instances in a
|
4612
|
-
# instance type determines the computing resources in use,
|
4613
|
-
# CPU, memory, storage, and networking capacity. See [Amazon
|
4614
|
-
# Instance Types][1] for detailed descriptions.
|
4709
|
+
# The Amazon EC2 instance type that is used for all instances in a
|
4710
|
+
# fleet. The instance type determines the computing resources in use,
|
4711
|
+
# including CPU, memory, storage, and networking capacity. See [Amazon
|
4712
|
+
# Elastic Compute Cloud Instance Types][1] for detailed descriptions.
|
4615
4713
|
#
|
4616
4714
|
#
|
4617
4715
|
#
|
@@ -4625,7 +4723,7 @@ module Aws::GameLift
|
|
4625
4723
|
#
|
4626
4724
|
# @!attribute [rw] location
|
4627
4725
|
# The fleet location for the instance count information, expressed as
|
4628
|
-
# an
|
4726
|
+
# an Amazon Web Services Region code, such as `us-west-2`.
|
4629
4727
|
# @return [String]
|
4630
4728
|
#
|
4631
4729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/FleetCapacity AWS API Documentation
|
@@ -4701,7 +4799,7 @@ module Aws::GameLift
|
|
4701
4799
|
#
|
4702
4800
|
# @!attribute [rw] location
|
4703
4801
|
# The fleet location for the fleet utilization information, expressed
|
4704
|
-
# as an
|
4802
|
+
# as an Amazon Web Services Region code, such as `us-west-2`.
|
4705
4803
|
# @return [String]
|
4706
4804
|
#
|
4707
4805
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/FleetUtilization AWS API Documentation
|
@@ -4788,7 +4886,7 @@ module Aws::GameLift
|
|
4788
4886
|
# @!attribute [rw] game_server_id
|
4789
4887
|
# A custom string that uniquely identifies the game server. Game
|
4790
4888
|
# server IDs are developer-defined and are unique across all game
|
4791
|
-
# server groups in an
|
4889
|
+
# server groups in an Amazon Web Services account.
|
4792
4890
|
# @return [String]
|
4793
4891
|
#
|
4794
4892
|
# @!attribute [rw] instance_id
|
@@ -4876,8 +4974,8 @@ module Aws::GameLift
|
|
4876
4974
|
# groups.**
|
4877
4975
|
#
|
4878
4976
|
# Properties that describe a game server group resource. A game server
|
4879
|
-
# group manages certain properties related to a corresponding EC2
|
4880
|
-
# Scaling group.
|
4977
|
+
# group manages certain properties related to a corresponding Amazon EC2
|
4978
|
+
# Auto Scaling group.
|
4881
4979
|
#
|
4882
4980
|
# A game server group is created by a successful call to
|
4883
4981
|
# `CreateGameServerGroup` and deleted by calling
|
@@ -4899,7 +4997,7 @@ module Aws::GameLift
|
|
4899
4997
|
#
|
4900
4998
|
# @!attribute [rw] game_server_group_name
|
4901
4999
|
# A developer-defined identifier for the game server group. The name
|
4902
|
-
# is unique for each Region in each
|
5000
|
+
# is unique for each Region in each Amazon Web Services account.
|
4903
5001
|
# @return [String]
|
4904
5002
|
#
|
4905
5003
|
# @!attribute [rw] game_server_group_arn
|
@@ -4908,7 +5006,7 @@ module Aws::GameLift
|
|
4908
5006
|
#
|
4909
5007
|
# @!attribute [rw] role_arn
|
4910
5008
|
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows
|
4911
|
-
# Amazon
|
5009
|
+
# Amazon Web Services to access your Amazon EC2 Auto Scaling groups.
|
4912
5010
|
#
|
4913
5011
|
#
|
4914
5012
|
#
|
@@ -4916,9 +5014,9 @@ module Aws::GameLift
|
|
4916
5014
|
# @return [String]
|
4917
5015
|
#
|
4918
5016
|
# @!attribute [rw] instance_definitions
|
4919
|
-
# The set of EC2 instance types that GameLift FleetIQ can use
|
4920
|
-
# balancing and automatically scaling instances in the
|
4921
|
-
# Auto Scaling group.
|
5017
|
+
# The set of Amazon EC2 instance types that GameLift FleetIQ can use
|
5018
|
+
# when balancing and automatically scaling instances in the
|
5019
|
+
# corresponding Auto Scaling group.
|
4922
5020
|
# @return [Array<Types::InstanceDefinition>]
|
4923
5021
|
#
|
4924
5022
|
# @!attribute [rw] balancing_strategy
|
@@ -4953,11 +5051,11 @@ module Aws::GameLift
|
|
4953
5051
|
# instances cannot be terminated while there are active game servers
|
4954
5052
|
# running except in the event of a forced game server group deletion
|
4955
5053
|
# (see ). An exception to this is with Spot Instances, which can be
|
4956
|
-
# terminated by
|
5054
|
+
# terminated by Amazon Web Services regardless of protection status.
|
4957
5055
|
# @return [String]
|
4958
5056
|
#
|
4959
5057
|
# @!attribute [rw] auto_scaling_group_arn
|
4960
|
-
# A generated unique ID for the EC2 Auto Scaling group that is
|
5058
|
+
# A generated unique ID for the Amazon EC2 Auto Scaling group that is
|
4961
5059
|
# associated with this game server group.
|
4962
5060
|
# @return [String]
|
4963
5061
|
#
|
@@ -4969,7 +5067,8 @@ module Aws::GameLift
|
|
4969
5067
|
# `CreateGameServerGroup()` request.
|
4970
5068
|
#
|
4971
5069
|
# * `ACTIVATING` - GameLift FleetIQ is setting up a game server group,
|
4972
|
-
# which includes creating an Auto Scaling group in your
|
5070
|
+
# which includes creating an Auto Scaling group in your Amazon Web
|
5071
|
+
# Services account.
|
4973
5072
|
#
|
4974
5073
|
# * `ACTIVE` - The game server group has been successfully created.
|
4975
5074
|
#
|
@@ -5102,7 +5201,7 @@ module Aws::GameLift
|
|
5102
5201
|
# @!attribute [rw] game_server_group_name
|
5103
5202
|
# A developer-defined identifier for the game server group that
|
5104
5203
|
# includes the game server instance. The name is unique for each
|
5105
|
-
# Region in each
|
5204
|
+
# Region in each Amazon Web Services account.
|
5106
5205
|
# @return [String]
|
5107
5206
|
#
|
5108
5207
|
# @!attribute [rw] game_server_group_arn
|
@@ -5228,8 +5327,12 @@ module Aws::GameLift
|
|
5228
5327
|
# A set of custom properties for a game session, formatted as
|
5229
5328
|
# key:value pairs. These properties are passed to a game server
|
5230
5329
|
# process in the GameSession object with a request to start a new game
|
5231
|
-
# session. You can search for active
|
5232
|
-
# custom data with SearchGameSessions.
|
5330
|
+
# session (see [Start a Game Session][1]). You can search for active
|
5331
|
+
# game sessions based on this custom data with SearchGameSessions.
|
5332
|
+
#
|
5333
|
+
#
|
5334
|
+
#
|
5335
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
5233
5336
|
# @return [Array<Types::GameProperty>]
|
5234
5337
|
#
|
5235
5338
|
# @!attribute [rw] ip_address
|
@@ -5274,7 +5377,12 @@ module Aws::GameLift
|
|
5274
5377
|
# @!attribute [rw] game_session_data
|
5275
5378
|
# A set of custom game session properties, formatted as a single
|
5276
5379
|
# string value. This data is passed to a game server process in the
|
5277
|
-
# GameSession object with a request to start a new game session
|
5380
|
+
# GameSession object with a request to start a new game session (see
|
5381
|
+
# [Start a Game Session][1]).
|
5382
|
+
#
|
5383
|
+
#
|
5384
|
+
#
|
5385
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
5278
5386
|
# @return [String]
|
5279
5387
|
#
|
5280
5388
|
# @!attribute [rw] matchmaker_data
|
@@ -5285,17 +5393,19 @@ module Aws::GameLift
|
|
5285
5393
|
# assignments. For more details on matchmaker data, see [Match
|
5286
5394
|
# Data][1]. Matchmaker data is useful when requesting match backfills,
|
5287
5395
|
# and is updated whenever new players are added during a successful
|
5288
|
-
# backfill (see StartMatchBackfill).
|
5396
|
+
# backfill (see [StartMatchBackfill][2]).
|
5289
5397
|
#
|
5290
5398
|
#
|
5291
5399
|
#
|
5292
5400
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data
|
5401
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchBackfill.html
|
5293
5402
|
# @return [String]
|
5294
5403
|
#
|
5295
5404
|
# @!attribute [rw] location
|
5296
5405
|
# The fleet location where the game session is running. This value
|
5297
5406
|
# might specify the fleet's home Region or a remote location.
|
5298
|
-
# Location is expressed as an
|
5407
|
+
# Location is expressed as an Amazon Web Services Region code such as
|
5408
|
+
# `us-west-2`.
|
5299
5409
|
# @return [String]
|
5300
5410
|
#
|
5301
5411
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameSession AWS API Documentation
|
@@ -5509,7 +5619,7 @@ module Aws::GameLift
|
|
5509
5619
|
#
|
5510
5620
|
# @!attribute [rw] player_latencies
|
5511
5621
|
# A set of values, expressed in milliseconds, that indicates the
|
5512
|
-
# amount of latency that a player experiences when connected to
|
5622
|
+
# amount of latency that a player experiences when connected to @aws;
|
5513
5623
|
# Regions.
|
5514
5624
|
# @return [Array<Types::PlayerLatency>]
|
5515
5625
|
#
|
@@ -5622,8 +5732,14 @@ module Aws::GameLift
|
|
5622
5732
|
#
|
5623
5733
|
# **Related actions**
|
5624
5734
|
#
|
5625
|
-
# CreateGameSessionQueue \| DescribeGameSessionQueues \|
|
5626
|
-
# UpdateGameSessionQueue
|
5735
|
+
# [CreateGameSessionQueue][1] \| [DescribeGameSessionQueues][2] \|
|
5736
|
+
# [UpdateGameSessionQueue][3]
|
5737
|
+
#
|
5738
|
+
#
|
5739
|
+
#
|
5740
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html
|
5741
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html
|
5742
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html
|
5627
5743
|
#
|
5628
5744
|
# @!attribute [rw] name
|
5629
5745
|
# A descriptive label that is associated with game session queue.
|
@@ -5668,9 +5784,9 @@ module Aws::GameLift
|
|
5668
5784
|
#
|
5669
5785
|
# @!attribute [rw] filter_configuration
|
5670
5786
|
# A list of locations where a queue is allowed to place new game
|
5671
|
-
# sessions. Locations are specified in the form of
|
5672
|
-
# such as `us-west-2`. If this parameter is not set,
|
5673
|
-
# be placed in any queue location.
|
5787
|
+
# sessions. Locations are specified in the form of Amazon Web Services
|
5788
|
+
# Region codes, such as `us-west-2`. If this parameter is not set,
|
5789
|
+
# game sessions can be placed in any queue location.
|
5674
5790
|
# @return [Types::FilterConfiguration]
|
5675
5791
|
#
|
5676
5792
|
# @!attribute [rw] priority_configuration
|
@@ -5893,8 +6009,8 @@ module Aws::GameLift
|
|
5893
6009
|
# @return [String]
|
5894
6010
|
#
|
5895
6011
|
# @!attribute [rw] type
|
5896
|
-
# EC2 instance type that defines the computing resources of
|
5897
|
-
# instance.
|
6012
|
+
# Amazon EC2 instance type that defines the computing resources of
|
6013
|
+
# this instance.
|
5898
6014
|
# @return [String]
|
5899
6015
|
#
|
5900
6016
|
# @!attribute [rw] status
|
@@ -5922,8 +6038,8 @@ module Aws::GameLift
|
|
5922
6038
|
# @return [Time]
|
5923
6039
|
#
|
5924
6040
|
# @!attribute [rw] location
|
5925
|
-
# The fleet location of the instance, expressed as an
|
5926
|
-
# such as `us-west-2`.
|
6041
|
+
# The fleet location of the instance, expressed as an Amazon Web
|
6042
|
+
# Services Region code, such as `us-west-2`.
|
5927
6043
|
# @return [String]
|
5928
6044
|
#
|
5929
6045
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/Instance AWS API Documentation
|
@@ -6020,7 +6136,7 @@ module Aws::GameLift
|
|
6020
6136
|
# }
|
6021
6137
|
#
|
6022
6138
|
# @!attribute [rw] instance_type
|
6023
|
-
# An EC2 instance type designation.
|
6139
|
+
# An Amazon EC2 instance type designation.
|
6024
6140
|
# @return [String]
|
6025
6141
|
#
|
6026
6142
|
# @!attribute [rw] weighted_capacity
|
@@ -6029,8 +6145,9 @@ module Aws::GameLift
|
|
6029
6145
|
# weights are used by GameLift FleetIQ to calculate the instance
|
6030
6146
|
# type's cost per unit hour and better identify the most
|
6031
6147
|
# cost-effective options. For detailed information on weighting
|
6032
|
-
# instance capacity, see [Instance Weighting][1] in the *Amazon
|
6033
|
-
# Auto Scaling User Guide*. Default value is
|
6148
|
+
# instance capacity, see [Instance Weighting][1] in the *Amazon
|
6149
|
+
# Elastic Compute Cloud Auto Scaling User Guide*. Default value is
|
6150
|
+
# "1".
|
6034
6151
|
#
|
6035
6152
|
#
|
6036
6153
|
#
|
@@ -6129,11 +6246,19 @@ module Aws::GameLift
|
|
6129
6246
|
#
|
6130
6247
|
# @!attribute [rw] from_port
|
6131
6248
|
# A starting value for a range of allowed port numbers.
|
6249
|
+
#
|
6250
|
+
# For fleets using Linux builds, only port 22, 443, 1026-60000 are
|
6251
|
+
# valid. For fleets using Windows builds, only port 443, 1026-60000
|
6252
|
+
# are valid.
|
6132
6253
|
# @return [Integer]
|
6133
6254
|
#
|
6134
6255
|
# @!attribute [rw] to_port
|
6135
6256
|
# An ending value for a range of allowed port numbers. Port numbers
|
6136
6257
|
# are end-inclusive. This value must be higher than `FromPort`.
|
6258
|
+
#
|
6259
|
+
# For fleets using Linux builds, only port 22, 443, 1026-60000 are
|
6260
|
+
# valid. For fleets using Windows builds, only port 443, 1026-60000
|
6261
|
+
# are valid.
|
6137
6262
|
# @return [Integer]
|
6138
6263
|
#
|
6139
6264
|
# @!attribute [rw] ip_range
|
@@ -6160,10 +6285,10 @@ module Aws::GameLift
|
|
6160
6285
|
# **This data type is used with the GameLift FleetIQ and game server
|
6161
6286
|
# groups.**
|
6162
6287
|
#
|
6163
|
-
# An EC2 launch template that contains configuration settings and
|
6164
|
-
# server code to be deployed to all instances in a game server
|
6165
|
-
# The launch template is specified when creating a new game
|
6166
|
-
# with CreateGameServerGroup.
|
6288
|
+
# An Amazon EC2 launch template that contains configuration settings and
|
6289
|
+
# game server code to be deployed to all instances in a game server
|
6290
|
+
# group. The launch template is specified when creating a new game
|
6291
|
+
# server group with CreateGameServerGroup.
|
6167
6292
|
#
|
6168
6293
|
# @note When making an API call, you may pass LaunchTemplateSpecification
|
6169
6294
|
# data as a hash:
|
@@ -6175,18 +6300,18 @@ module Aws::GameLift
|
|
6175
6300
|
# }
|
6176
6301
|
#
|
6177
6302
|
# @!attribute [rw] launch_template_id
|
6178
|
-
# A unique identifier for an existing EC2 launch template.
|
6303
|
+
# A unique identifier for an existing Amazon EC2 launch template.
|
6179
6304
|
# @return [String]
|
6180
6305
|
#
|
6181
6306
|
# @!attribute [rw] launch_template_name
|
6182
|
-
# A readable identifier for an existing EC2 launch template.
|
6307
|
+
# A readable identifier for an existing Amazon EC2 launch template.
|
6183
6308
|
# @return [String]
|
6184
6309
|
#
|
6185
6310
|
# @!attribute [rw] version
|
6186
|
-
# The version of the EC2 launch template to use. If no version
|
6187
|
-
# specified, the default version will be used. With Amazon
|
6188
|
-
# can specify a default version for a launch
|
6189
|
-
# the default is the first version created.
|
6311
|
+
# The version of the Amazon EC2 launch template to use. If no version
|
6312
|
+
# is specified, the default version will be used. With Amazon Elastic
|
6313
|
+
# Compute Cloud, you can specify a default version for a launch
|
6314
|
+
# template. If none is set, the default is the first version created.
|
6190
6315
|
# @return [String]
|
6191
6316
|
#
|
6192
6317
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/LaunchTemplateSpecification AWS API Documentation
|
@@ -6671,7 +6796,11 @@ module Aws::GameLift
|
|
6671
6796
|
#
|
6672
6797
|
# **Related actions**
|
6673
6798
|
#
|
6674
|
-
# CreateFleet
|
6799
|
+
# [CreateFleet][1]
|
6800
|
+
#
|
6801
|
+
#
|
6802
|
+
#
|
6803
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html
|
6675
6804
|
#
|
6676
6805
|
# @note When making an API call, you may pass LocationConfiguration
|
6677
6806
|
# data as a hash:
|
@@ -6681,7 +6810,7 @@ module Aws::GameLift
|
|
6681
6810
|
# }
|
6682
6811
|
#
|
6683
6812
|
# @!attribute [rw] location
|
6684
|
-
# An
|
6813
|
+
# An Amazon Web Services Region code, such as `us-west-2`.
|
6685
6814
|
# @return [String]
|
6686
6815
|
#
|
6687
6816
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/LocationConfiguration AWS API Documentation
|
@@ -6703,8 +6832,8 @@ module Aws::GameLift
|
|
6703
6832
|
# CreateFleet \| CreateFleetLocations \| DeleteFleetLocations
|
6704
6833
|
#
|
6705
6834
|
# @!attribute [rw] location
|
6706
|
-
# The fleet location, expressed as an
|
6707
|
-
# `us-west-2`.
|
6835
|
+
# The fleet location, expressed as an Amazon Web Services Region code
|
6836
|
+
# such as `us-west-2`.
|
6708
6837
|
# @return [String]
|
6709
6838
|
#
|
6710
6839
|
# @!attribute [rw] status
|
@@ -7235,7 +7364,7 @@ module Aws::GameLift
|
|
7235
7364
|
#
|
7236
7365
|
# @!attribute [rw] latency_in_ms
|
7237
7366
|
# A set of values, expressed in milliseconds, that indicates the
|
7238
|
-
# amount of latency that a player experiences when connected to
|
7367
|
+
# amount of latency that a player experiences when connected to @aws;
|
7239
7368
|
# Regions. If this property is present, FlexMatch considers placing
|
7240
7369
|
# the match only in Regions for which latency is reported.
|
7241
7370
|
#
|
@@ -7436,8 +7565,9 @@ module Aws::GameLift
|
|
7436
7565
|
# @return [String]
|
7437
7566
|
#
|
7438
7567
|
# @!attribute [rw] port
|
7439
|
-
# Port number for the game session. To connect to a Amazon
|
7440
|
-
# server process, an app needs both the IP address and port
|
7568
|
+
# Port number for the game session. To connect to a Amazon Web
|
7569
|
+
# Services server process, an app needs both the IP address and port
|
7570
|
+
# number.
|
7441
7571
|
# @return [Integer]
|
7442
7572
|
#
|
7443
7573
|
# @!attribute [rw] player_data
|
@@ -7518,8 +7648,8 @@ module Aws::GameLift
|
|
7518
7648
|
# @!attribute [rw] location_order
|
7519
7649
|
# The prioritization order to use for fleet locations, when the
|
7520
7650
|
# `PriorityOrder` property includes `LOCATION`. Locations are
|
7521
|
-
# identified by
|
7522
|
-
# can only be listed once.
|
7651
|
+
# identified by Amazon Web Services Region codes such as `us-west-2`.
|
7652
|
+
# Each location can only be listed once.
|
7523
7653
|
# @return [Array<String>]
|
7524
7654
|
#
|
7525
7655
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PriorityConfiguration AWS API Documentation
|
@@ -7599,9 +7729,10 @@ module Aws::GameLift
|
|
7599
7729
|
# @return [Integer]
|
7600
7730
|
#
|
7601
7731
|
# @!attribute [rw] metric_name
|
7602
|
-
# Name of the Amazon
|
7603
|
-
# scaling adjustment. For detailed descriptions of fleet
|
7604
|
-
# [Monitor Amazon
|
7732
|
+
# Name of the Amazon Web Services-defined metric that is used to
|
7733
|
+
# trigger a scaling adjustment. For detailed descriptions of fleet
|
7734
|
+
# metrics, see [Monitor Amazon Web Services with Amazon
|
7735
|
+
# CloudWatch][1].
|
7605
7736
|
#
|
7606
7737
|
# * **ActivatingGameSessions** -- Game sessions in the process of
|
7607
7738
|
# being created.
|
@@ -7710,7 +7841,7 @@ module Aws::GameLift
|
|
7710
7841
|
# @!attribute [rw] game_server_id
|
7711
7842
|
# A custom string that uniquely identifies the game server to
|
7712
7843
|
# register. Game server IDs are developer-defined and must be unique
|
7713
|
-
# across all game server groups in your
|
7844
|
+
# across all game server groups in your Amazon Web Services account.
|
7714
7845
|
# @return [String]
|
7715
7846
|
#
|
7716
7847
|
# @!attribute [rw] instance_id
|
@@ -7781,9 +7912,9 @@ module Aws::GameLift
|
|
7781
7912
|
# Represents the returned data in response to a request operation.
|
7782
7913
|
#
|
7783
7914
|
# @!attribute [rw] upload_credentials
|
7784
|
-
#
|
7785
|
-
# location. These credentials have a limited lifespan
|
7786
|
-
# only for the build they were issued for.
|
7915
|
+
# Amazon Web Services credentials required when uploading a game build
|
7916
|
+
# to the storage location. These credentials have a limited lifespan
|
7917
|
+
# and are valid only for the build they were issued for.
|
7787
7918
|
# @return [Types::AwsCredentials]
|
7788
7919
|
#
|
7789
7920
|
# @!attribute [rw] storage_location
|
@@ -8041,8 +8172,8 @@ module Aws::GameLift
|
|
8041
8172
|
end
|
8042
8173
|
|
8043
8174
|
# The location in Amazon S3 where build or script files are stored for
|
8044
|
-
# access by Amazon
|
8045
|
-
# CreateScript, and UpdateScript requests.
|
8175
|
+
# access by Amazon Web Services. This location is specified in
|
8176
|
+
# CreateBuild, CreateScript, and UpdateScript requests.
|
8046
8177
|
#
|
8047
8178
|
# @note When making an API call, you may pass S3Location
|
8048
8179
|
# data as a hash:
|
@@ -8070,7 +8201,7 @@ module Aws::GameLift
|
|
8070
8201
|
#
|
8071
8202
|
# @!attribute [rw] role_arn
|
8072
8203
|
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows
|
8073
|
-
# Amazon
|
8204
|
+
# Amazon Web Services to access the S3 bucket.
|
8074
8205
|
#
|
8075
8206
|
#
|
8076
8207
|
#
|
@@ -8079,10 +8210,10 @@ module Aws::GameLift
|
|
8079
8210
|
#
|
8080
8211
|
# @!attribute [rw] object_version
|
8081
8212
|
# The version of the file, if object versioning is turned on for the
|
8082
|
-
# bucket. Amazon
|
8083
|
-
# from an S3 bucket that you own. Use this parameter to specify
|
8084
|
-
# specific version of the file. If not set, the latest version of
|
8085
|
-
# file is retrieved.
|
8213
|
+
# bucket. Amazon Web Services uses this information when retrieving
|
8214
|
+
# files from an S3 bucket that you own. Use this parameter to specify
|
8215
|
+
# a specific version of the file. If not set, the latest version of
|
8216
|
+
# the file is retrieved.
|
8086
8217
|
# @return [String]
|
8087
8218
|
#
|
8088
8219
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/S3Location AWS API Documentation
|
@@ -8192,9 +8323,10 @@ module Aws::GameLift
|
|
8192
8323
|
# @return [Integer]
|
8193
8324
|
#
|
8194
8325
|
# @!attribute [rw] metric_name
|
8195
|
-
# Name of the Amazon
|
8196
|
-
# scaling adjustment. For detailed descriptions of fleet
|
8197
|
-
# [Monitor Amazon
|
8326
|
+
# Name of the Amazon Web Services-defined metric that is used to
|
8327
|
+
# trigger a scaling adjustment. For detailed descriptions of fleet
|
8328
|
+
# metrics, see [Monitor Amazon Web Services with Amazon
|
8329
|
+
# CloudWatch][1].
|
8198
8330
|
#
|
8199
8331
|
# * **ActivatingGameSessions** -- Game sessions in the process of
|
8200
8332
|
# being created.
|
@@ -8260,6 +8392,7 @@ module Aws::GameLift
|
|
8260
8392
|
# @return [String]
|
8261
8393
|
#
|
8262
8394
|
# @!attribute [rw] location
|
8395
|
+
# The fleet location.
|
8263
8396
|
# @return [String]
|
8264
8397
|
#
|
8265
8398
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ScalingPolicy AWS API Documentation
|
@@ -8333,7 +8466,7 @@ module Aws::GameLift
|
|
8333
8466
|
#
|
8334
8467
|
# @!attribute [rw] storage_location
|
8335
8468
|
# The location in Amazon S3 where build or script files are stored for
|
8336
|
-
# access by Amazon
|
8469
|
+
# access by Amazon Web Services. This location is specified in
|
8337
8470
|
# CreateBuild, CreateScript, and UpdateScript requests.
|
8338
8471
|
# @return [Types::S3Location]
|
8339
8472
|
#
|
@@ -8381,8 +8514,8 @@ module Aws::GameLift
|
|
8381
8514
|
#
|
8382
8515
|
# @!attribute [rw] location
|
8383
8516
|
# A fleet location to search for game sessions. You can specify a
|
8384
|
-
# fleet's home Region or a remote location. Use the
|
8385
|
-
# format, such as `us-west-2`.
|
8517
|
+
# fleet's home Region or a remote location. Use the Amazon Web
|
8518
|
+
# Services Region code format, such as `us-west-2`.
|
8386
8519
|
# @return [String]
|
8387
8520
|
#
|
8388
8521
|
# @!attribute [rw] filter_expression
|
@@ -8569,7 +8702,8 @@ module Aws::GameLift
|
|
8569
8702
|
#
|
8570
8703
|
# @!attribute [rw] location
|
8571
8704
|
# The fleet location to restart fleet actions for. Specify a location
|
8572
|
-
# in the form of an
|
8705
|
+
# in the form of an Amazon Web Services Region code, such as
|
8706
|
+
# `us-west-2`.
|
8573
8707
|
# @return [String]
|
8574
8708
|
#
|
8575
8709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartFleetActionsInput AWS API Documentation
|
@@ -8675,7 +8809,7 @@ module Aws::GameLift
|
|
8675
8809
|
#
|
8676
8810
|
# @!attribute [rw] player_latencies
|
8677
8811
|
# A set of values, expressed in milliseconds, that indicates the
|
8678
|
-
# amount of latency that a player experiences when connected to
|
8812
|
+
# amount of latency that a player experiences when connected to @aws;
|
8679
8813
|
# Regions. This information is used to try to place the new game
|
8680
8814
|
# session where it can offer the best possible gameplay experience for
|
8681
8815
|
# the players.
|
@@ -8752,9 +8886,9 @@ module Aws::GameLift
|
|
8752
8886
|
#
|
8753
8887
|
# @!attribute [rw] ticket_id
|
8754
8888
|
# A unique identifier for a matchmaking ticket. If no ticket ID is
|
8755
|
-
# specified here, Amazon
|
8756
|
-
# UUID. Use this identifier to track the match backfill ticket
|
8757
|
-
# and retrieve match results.
|
8889
|
+
# specified here, Amazon Web Services will generate one in the form of
|
8890
|
+
# a UUID. Use this identifier to track the match backfill ticket
|
8891
|
+
# status and retrieve match results.
|
8758
8892
|
# @return [String]
|
8759
8893
|
#
|
8760
8894
|
# @!attribute [rw] configuration_name
|
@@ -8781,6 +8915,9 @@ module Aws::GameLift
|
|
8781
8915
|
# matchmaker data is in JSON syntax, formatted as a string. For more
|
8782
8916
|
# details, see [ Match Data][1].
|
8783
8917
|
#
|
8918
|
+
# The backfill request must specify the team membership for every
|
8919
|
+
# player. Do not specify team if you are not using backfill.
|
8920
|
+
#
|
8784
8921
|
# * LatencyInMs -- If the matchmaker uses player latency, include a
|
8785
8922
|
# latency value, in milliseconds, for the Region that the game
|
8786
8923
|
# session is currently in. Do not include latency values for any
|
@@ -8842,9 +8979,9 @@ module Aws::GameLift
|
|
8842
8979
|
#
|
8843
8980
|
# @!attribute [rw] ticket_id
|
8844
8981
|
# A unique identifier for a matchmaking ticket. If no ticket ID is
|
8845
|
-
# specified here, Amazon
|
8846
|
-
# UUID. Use this identifier to track the matchmaking ticket status
|
8847
|
-
# retrieve match results.
|
8982
|
+
# specified here, Amazon Web Services will generate one in the form of
|
8983
|
+
# a UUID. Use this identifier to track the matchmaking ticket status
|
8984
|
+
# and retrieve match results.
|
8848
8985
|
# @return [String]
|
8849
8986
|
#
|
8850
8987
|
# @!attribute [rw] configuration_name
|
@@ -8909,7 +9046,7 @@ module Aws::GameLift
|
|
8909
9046
|
#
|
8910
9047
|
# @!attribute [rw] location
|
8911
9048
|
# The fleet location to stop fleet actions for. Specify a location in
|
8912
|
-
# the form of an
|
9049
|
+
# the form of an Amazon Web Services Region code, such as `us-west-2`.
|
8913
9050
|
# @return [String]
|
8914
9051
|
#
|
8915
9052
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopFleetActionsInput AWS API Documentation
|
@@ -9053,9 +9190,10 @@ module Aws::GameLift
|
|
9053
9190
|
#
|
9054
9191
|
# **Learn more**
|
9055
9192
|
#
|
9056
|
-
# [Tagging
|
9193
|
+
# [Tagging Amazon Web Services Resources][1] in the *Amazon Web Services
|
9194
|
+
# General Reference*
|
9057
9195
|
#
|
9058
|
-
# [
|
9196
|
+
# [ Amazon Web Services Tagging Strategies][2]
|
9059
9197
|
#
|
9060
9198
|
# **Related actions**
|
9061
9199
|
#
|
@@ -9077,13 +9215,13 @@ module Aws::GameLift
|
|
9077
9215
|
# }
|
9078
9216
|
#
|
9079
9217
|
# @!attribute [rw] key
|
9080
|
-
# The key for a developer-defined key:value pair for tagging an
|
9081
|
-
# resource.
|
9218
|
+
# The key for a developer-defined key:value pair for tagging an Amazon
|
9219
|
+
# Web Services resource.
|
9082
9220
|
# @return [String]
|
9083
9221
|
#
|
9084
9222
|
# @!attribute [rw] value
|
9085
|
-
# The value for a developer-defined key:value pair for tagging an
|
9086
|
-
# resource.
|
9223
|
+
# The value for a developer-defined key:value pair for tagging an
|
9224
|
+
# Amazon Web Services resource.
|
9087
9225
|
# @return [String]
|
9088
9226
|
#
|
9089
9227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/Tag AWS API Documentation
|
@@ -9124,7 +9262,7 @@ module Aws::GameLift
|
|
9124
9262
|
# A list of one or more tags to assign to the specified GameLift
|
9125
9263
|
# resource. Tags are developer-defined and structured as key-value
|
9126
9264
|
# pairs. The maximum tag limit may be lower than stated. See [ Tagging
|
9127
|
-
#
|
9265
|
+
# Amazon Web Services Resources][1] for actual tagging limits.
|
9128
9266
|
#
|
9129
9267
|
#
|
9130
9268
|
#
|
@@ -9162,9 +9300,10 @@ module Aws::GameLift
|
|
9162
9300
|
# Settings for a target-based scaling policy (see ScalingPolicy. A
|
9163
9301
|
# target-based policy tracks a particular fleet metric specifies a
|
9164
9302
|
# target value for the metric. As player usage changes, the policy
|
9165
|
-
# triggers Amazon
|
9166
|
-
# to the target value. The target configuration specifies
|
9167
|
-
# needed for the target based policy, including the target
|
9303
|
+
# triggers Amazon Web Services to adjust capacity so that the metric
|
9304
|
+
# returns to the target value. The target configuration specifies
|
9305
|
+
# settings as needed for the target based policy, including the target
|
9306
|
+
# value.
|
9168
9307
|
#
|
9169
9308
|
# **Related actions**
|
9170
9309
|
#
|
@@ -9298,8 +9437,9 @@ module Aws::GameLift
|
|
9298
9437
|
#
|
9299
9438
|
# @!attribute [rw] tag_keys
|
9300
9439
|
# A list of one or more tag keys to remove from the specified GameLift
|
9301
|
-
# resource. An
|
9302
|
-
# key, so specifying the tag key identifies which tag
|
9440
|
+
# resource. An Amazon Web Services resource can have only one tag with
|
9441
|
+
# a specific tag key, so specifying the tag key identifies which tag
|
9442
|
+
# to remove.
|
9303
9443
|
# @return [Array<String>]
|
9304
9444
|
#
|
9305
9445
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UntagResourceRequest AWS API Documentation
|
@@ -9528,9 +9668,9 @@ module Aws::GameLift
|
|
9528
9668
|
# @return [String]
|
9529
9669
|
#
|
9530
9670
|
# @!attribute [rw] desired_instances
|
9531
|
-
# The number of EC2 instances you want to maintain in the
|
9532
|
-
# fleet location. This value must fall between the minimum
|
9533
|
-
# size limits.
|
9671
|
+
# The number of Amazon EC2 instances you want to maintain in the
|
9672
|
+
# specified fleet location. This value must fall between the minimum
|
9673
|
+
# and maximum size limits.
|
9534
9674
|
# @return [Integer]
|
9535
9675
|
#
|
9536
9676
|
# @!attribute [rw] min_size
|
@@ -9545,7 +9685,8 @@ module Aws::GameLift
|
|
9545
9685
|
#
|
9546
9686
|
# @!attribute [rw] location
|
9547
9687
|
# The name of a remote location to update fleet capacity settings for,
|
9548
|
-
# in the form of an
|
9688
|
+
# in the form of an Amazon Web Services Region code such as
|
9689
|
+
# `us-west-2`.
|
9549
9690
|
# @return [String]
|
9550
9691
|
#
|
9551
9692
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetCapacityInput AWS API Documentation
|
@@ -9578,8 +9719,8 @@ module Aws::GameLift
|
|
9578
9719
|
# @return [String]
|
9579
9720
|
#
|
9580
9721
|
# @!attribute [rw] location
|
9581
|
-
# The remote location being updated, expressed as an
|
9582
|
-
# such as `us-west-2`.
|
9722
|
+
# The remote location being updated, expressed as an Amazon Web
|
9723
|
+
# Services Region code, such as `us-west-2`.
|
9583
9724
|
# @return [String]
|
9584
9725
|
#
|
9585
9726
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetCapacityOutput AWS API Documentation
|
@@ -9677,7 +9818,7 @@ module Aws::GameLift
|
|
9677
9818
|
#
|
9678
9819
|
# @!attribute [rw] role_arn
|
9679
9820
|
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows
|
9680
|
-
# Amazon
|
9821
|
+
# Amazon Web Services to access your Amazon EC2 Auto Scaling groups.
|
9681
9822
|
#
|
9682
9823
|
#
|
9683
9824
|
#
|
@@ -9685,17 +9826,17 @@ module Aws::GameLift
|
|
9685
9826
|
# @return [String]
|
9686
9827
|
#
|
9687
9828
|
# @!attribute [rw] instance_definitions
|
9688
|
-
# An updated list of EC2 instance types to use in the Auto
|
9689
|
-
# group. The instance definitions must specify at least two
|
9690
|
-
# instance types that are supported by GameLift FleetIQ.
|
9691
|
-
# list replaces the entire current list of instance
|
9692
|
-
# the game server group. For more information on
|
9693
|
-
# [EC2 Instance Types][1] in the *Amazon EC2 User
|
9694
|
-
# optionally specify capacity weighting for each
|
9695
|
-
# weight value is specified for an instance type,
|
9696
|
-
# default value "1". For more information about
|
9697
|
-
# see [ Instance Weighting for Amazon EC2 Auto
|
9698
|
-
# Amazon EC2 Auto Scaling User Guide.
|
9829
|
+
# An updated list of Amazon EC2 instance types to use in the Auto
|
9830
|
+
# Scaling group. The instance definitions must specify at least two
|
9831
|
+
# different instance types that are supported by GameLift FleetIQ.
|
9832
|
+
# This updated list replaces the entire current list of instance
|
9833
|
+
# definitions for the game server group. For more information on
|
9834
|
+
# instance types, see [EC2 Instance Types][1] in the *Amazon EC2 User
|
9835
|
+
# Guide*. You can optionally specify capacity weighting for each
|
9836
|
+
# instance type. If no weight value is specified for an instance type,
|
9837
|
+
# it is set to the default value "1". For more information about
|
9838
|
+
# capacity weighting, see [ Instance Weighting for Amazon EC2 Auto
|
9839
|
+
# Scaling][2] in the Amazon EC2 Auto Scaling User Guide.
|
9699
9840
|
#
|
9700
9841
|
#
|
9701
9842
|
#
|
@@ -9711,8 +9852,8 @@ module Aws::GameLift
|
|
9711
9852
|
# instances cannot be terminated while there are active game servers
|
9712
9853
|
# running except in the event of a forced game server group deletion
|
9713
9854
|
# (see ). An exception to this is with Spot Instances, which can be
|
9714
|
-
# terminated by
|
9715
|
-
# set to `NO_PROTECTION` by default.
|
9855
|
+
# terminated by Amazon Web Services regardless of protection status.
|
9856
|
+
# This property is set to `NO_PROTECTION` by default.
|
9716
9857
|
# @return [String]
|
9717
9858
|
#
|
9718
9859
|
# @!attribute [rw] balancing_strategy
|
@@ -9957,10 +10098,10 @@ module Aws::GameLift
|
|
9957
10098
|
#
|
9958
10099
|
# @!attribute [rw] filter_configuration
|
9959
10100
|
# A list of locations where a queue is allowed to place new game
|
9960
|
-
# sessions. Locations are specified in the form of
|
9961
|
-
# such as `us-west-2`. If this parameter is not set,
|
9962
|
-
# be placed in any queue location. To remove an
|
9963
|
-
# configuration, pass in an empty set.
|
10101
|
+
# sessions. Locations are specified in the form of Amazon Web Services
|
10102
|
+
# Region codes, such as `us-west-2`. If this parameter is not set,
|
10103
|
+
# game sessions can be placed in any queue location. To remove an
|
10104
|
+
# existing filter configuration, pass in an empty set.
|
9964
10105
|
# @return [Types::FilterConfiguration]
|
9965
10106
|
#
|
9966
10107
|
# @!attribute [rw] priority_configuration
|
@@ -10302,12 +10443,12 @@ module Aws::GameLift
|
|
10302
10443
|
# The location of the Amazon S3 bucket where a zipped file containing
|
10303
10444
|
# your Realtime scripts is stored. The storage location must specify
|
10304
10445
|
# the Amazon S3 bucket name, the zip file name (the "key"), and a
|
10305
|
-
# role ARN that allows Amazon
|
10306
|
-
# location. The S3 bucket must be in the same Region where you
|
10307
|
-
# create a new script. By default, Amazon
|
10308
|
-
# version of the zip file; if you have S3 object versioning
|
10309
|
-
# you can use the `ObjectVersion` parameter to specify an
|
10310
|
-
# version.
|
10446
|
+
# role ARN that allows Amazon Web Services to access the Amazon S3
|
10447
|
+
# storage location. The S3 bucket must be in the same Region where you
|
10448
|
+
# want to create a new script. By default, Amazon Web Services uploads
|
10449
|
+
# the latest version of the zip file; if you have S3 object versioning
|
10450
|
+
# turned on, you can use the `ObjectVersion` parameter to specify an
|
10451
|
+
# earlier version.
|
10311
10452
|
# @return [Types::S3Location]
|
10312
10453
|
#
|
10313
10454
|
# @!attribute [rw] zip_file
|
@@ -10315,10 +10456,10 @@ module Aws::GameLift
|
|
10315
10456
|
# zip file. The zip file can have one or multiple files. Maximum size
|
10316
10457
|
# of a zip file is 5 MB.
|
10317
10458
|
#
|
10318
|
-
# When using the
|
10319
|
-
# set to the zip file name. It must be prepended with the
|
10320
|
-
# "fileb://" to indicate that the file data is a binary
|
10321
|
-
# example: `--zip-file fileb://myRealtimeScript.zip`.
|
10459
|
+
# When using the Amazon Web Services CLI tool to create a script, this
|
10460
|
+
# parameter is set to the zip file name. It must be prepended with the
|
10461
|
+
# string "fileb://" to indicate that the file data is a binary
|
10462
|
+
# object. For example: `--zip-file fileb://myRealtimeScript.zip`.
|
10322
10463
|
# @return [String]
|
10323
10464
|
#
|
10324
10465
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateScriptInput AWS API Documentation
|
@@ -10340,7 +10481,7 @@ module Aws::GameLift
|
|
10340
10481
|
# storage location reflects the information that was provided in the
|
10341
10482
|
# *CreateScript* request; (2) If the script file was uploaded from a
|
10342
10483
|
# local zip file, the storage location reflects an S3 location
|
10343
|
-
# controls by the Amazon
|
10484
|
+
# controls by the Amazon Web Services service.
|
10344
10485
|
# @return [Types::Script]
|
10345
10486
|
#
|
10346
10487
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateScriptOutput AWS API Documentation
|
@@ -10388,7 +10529,7 @@ module Aws::GameLift
|
|
10388
10529
|
end
|
10389
10530
|
|
10390
10531
|
# Represents an authorization for a VPC peering connection between the
|
10391
|
-
# VPC for an Amazon
|
10532
|
+
# VPC for an Amazon Web Services fleet and another VPC on an account you
|
10392
10533
|
# have access to. This authorization must exist and be valid for the
|
10393
10534
|
# peering connection to be established. Authorizations are valid for 24
|
10394
10535
|
# hours after they are issued.
|
@@ -10405,9 +10546,9 @@ module Aws::GameLift
|
|
10405
10546
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
10406
10547
|
#
|
10407
10548
|
# @!attribute [rw] game_lift_aws_account_id
|
10408
|
-
# A unique identifier for the
|
10409
|
-
# GameLift fleet. You can find your Account ID in the
|
10410
|
-
# Console under account settings.
|
10549
|
+
# A unique identifier for the Amazon Web Services account that you use
|
10550
|
+
# to manage your GameLift fleet. You can find your Account ID in the
|
10551
|
+
# Amazon Web Services Management Console under account settings.
|
10411
10552
|
# @return [String]
|
10412
10553
|
#
|
10413
10554
|
# @!attribute [rw] peer_vpc_aws_account_id
|
@@ -10416,9 +10557,9 @@ module Aws::GameLift
|
|
10416
10557
|
# @!attribute [rw] peer_vpc_id
|
10417
10558
|
# A unique identifier for a VPC with resources to be accessed by your
|
10418
10559
|
# GameLift fleet. The VPC must be in the same Region as your fleet. To
|
10419
|
-
# look up a VPC ID, use the [VPC Dashboard][1] in the
|
10420
|
-
# Console. Learn more about VPC peering in [VPC
|
10421
|
-
# Fleets][2].
|
10560
|
+
# look up a VPC ID, use the [VPC Dashboard][1] in the Amazon Web
|
10561
|
+
# Services Management Console. Learn more about VPC peering in [VPC
|
10562
|
+
# Peering with GameLift Fleets][2].
|
10422
10563
|
#
|
10423
10564
|
#
|
10424
10565
|
#
|
@@ -10450,10 +10591,10 @@ module Aws::GameLift
|
|
10450
10591
|
include Aws::Structure
|
10451
10592
|
end
|
10452
10593
|
|
10453
|
-
# Represents a peering connection between a VPC on one of your
|
10454
|
-
# accounts and the VPC for your Amazon
|
10455
|
-
# be for an active peering connection or a pending
|
10456
|
-
# not yet been established.
|
10594
|
+
# Represents a peering connection between a VPC on one of your Amazon
|
10595
|
+
# Web Services accounts and the VPC for your Amazon Web Services fleets.
|
10596
|
+
# This record may be for an active peering connection or a pending
|
10597
|
+
# connection that has not yet been established.
|
10457
10598
|
#
|
10458
10599
|
# **Related actions**
|
10459
10600
|
#
|
@@ -10468,7 +10609,7 @@ module Aws::GameLift
|
|
10468
10609
|
#
|
10469
10610
|
# @!attribute [rw] fleet_id
|
10470
10611
|
# A unique identifier for the fleet. This ID determines the ID of the
|
10471
|
-
# Amazon
|
10612
|
+
# Amazon Web Services VPC for your fleet.
|
10472
10613
|
# @return [String]
|
10473
10614
|
#
|
10474
10615
|
# @!attribute [rw] fleet_arn
|
@@ -10501,9 +10642,9 @@ module Aws::GameLift
|
|
10501
10642
|
# @!attribute [rw] peer_vpc_id
|
10502
10643
|
# A unique identifier for a VPC with resources to be accessed by your
|
10503
10644
|
# GameLift fleet. The VPC must be in the same Region as your fleet. To
|
10504
|
-
# look up a VPC ID, use the [VPC Dashboard][1] in the
|
10505
|
-
# Console. Learn more about VPC peering in [VPC
|
10506
|
-
# Fleets][2].
|
10645
|
+
# look up a VPC ID, use the [VPC Dashboard][1] in the Amazon Web
|
10646
|
+
# Services Management Console. Learn more about VPC peering in [VPC
|
10647
|
+
# Peering with GameLift Fleets][2].
|
10507
10648
|
#
|
10508
10649
|
#
|
10509
10650
|
#
|
@@ -10512,9 +10653,10 @@ module Aws::GameLift
|
|
10512
10653
|
# @return [String]
|
10513
10654
|
#
|
10514
10655
|
# @!attribute [rw] game_lift_vpc_id
|
10515
|
-
# A unique identifier for the VPC that contains the Amazon
|
10516
|
-
# fleet for this connection. This VPC is managed by Amazon
|
10517
|
-
# and does not appear in your
|
10656
|
+
# A unique identifier for the VPC that contains the Amazon Web
|
10657
|
+
# Services fleet for this connection. This VPC is managed by Amazon
|
10658
|
+
# Web Services and does not appear in your Amazon Web Services
|
10659
|
+
# account.
|
10518
10660
|
# @return [String]
|
10519
10661
|
#
|
10520
10662
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/VpcPeeringConnection AWS API Documentation
|