aws-sdk-gamelift 1.94.0 → 1.96.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-gamelift/client.rb +2039 -637
- data/lib/aws-sdk-gamelift/client_api.rb +495 -122
- data/lib/aws-sdk-gamelift/types.rb +2076 -1019
- data/lib/aws-sdk-gamelift.rb +1 -1
- data/sig/client.rbs +346 -48
- data/sig/types.rbs +311 -97
- metadata +2 -2
@@ -718,37 +718,41 @@ module Aws::GameLift
|
|
718
718
|
req.send_request(options)
|
719
719
|
end
|
720
720
|
|
721
|
-
# Creates
|
722
|
-
#
|
723
|
-
#
|
721
|
+
# Creates an Amazon GameLift build resource for your game server
|
722
|
+
# software and stores the software for deployment to hosting resources.
|
723
|
+
# Combine game server binaries and dependencies into a single .zip file
|
724
724
|
#
|
725
|
-
#
|
726
|
-
# using the CLI command <b> <a
|
725
|
+
# Use the CLI command <b> <a
|
727
726
|
# href="https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html">upload-build</a>
|
728
|
-
# </b
|
729
|
-
# build
|
730
|
-
#
|
731
|
-
#
|
732
|
-
#
|
733
|
-
#
|
734
|
-
#
|
735
|
-
#
|
736
|
-
#
|
737
|
-
#
|
738
|
-
#
|
739
|
-
#
|
740
|
-
#
|
741
|
-
#
|
742
|
-
#
|
743
|
-
#
|
744
|
-
#
|
745
|
-
#
|
746
|
-
#
|
747
|
-
#
|
748
|
-
#
|
749
|
-
#
|
750
|
-
#
|
751
|
-
#
|
727
|
+
# </b> to quickly and simply create a new build and upload your game
|
728
|
+
# build .zip file to Amazon GameLift Amazon S3. This helper command
|
729
|
+
# eliminates the need to explicitly manage access permissions.
|
730
|
+
#
|
731
|
+
# Alternatively, use the `CreateBuild` action for the following
|
732
|
+
# scenarios:
|
733
|
+
#
|
734
|
+
# * You want to create a build and upload a game build zip file from in
|
735
|
+
# an Amazon S3 location that you control. In this scenario, you need
|
736
|
+
# to give Amazon GameLift permission to access to the Amazon S3
|
737
|
+
# bucket. With permission in place, call `CreateBuild` and specify a
|
738
|
+
# build name, the build's runtime operating system, and the Amazon S3
|
739
|
+
# storage location where the build file is stored.
|
740
|
+
#
|
741
|
+
# * You want to create a build and upload a local game build zip file to
|
742
|
+
# an Amazon S3 location that's controlled by Amazon GameLift. (See
|
743
|
+
# the `upload-build` CLI command for this scenario.) In this scenario,
|
744
|
+
# you need to request temporary access credentials to the Amazon
|
745
|
+
# GameLift Amazon S3 location. Specify a build name and the build's
|
746
|
+
# runtime operating system. The response provides an Amazon S3
|
747
|
+
# location and a set of temporary access credentials. Use the
|
748
|
+
# credentials to upload your build files to the specified Amazon S3
|
749
|
+
# location (see [Uploading Objects][1] in the *Amazon S3 Developer
|
750
|
+
# Guide*). You can't update build files after uploading them to
|
751
|
+
# Amazon GameLift Amazon S3.
|
752
|
+
#
|
753
|
+
# If successful, this action creates a new build resource with a unique
|
754
|
+
# build ID and places it in `INITIALIZED` status. When the build reaches
|
755
|
+
# `READY` status, you can create fleets with it.
|
752
756
|
#
|
753
757
|
# **Learn more**
|
754
758
|
#
|
@@ -766,12 +770,12 @@ module Aws::GameLift
|
|
766
770
|
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
767
771
|
#
|
768
772
|
# @option params [String] :name
|
769
|
-
# A descriptive label associated with a build. Build names
|
770
|
-
# to be unique. You can change this value later.
|
773
|
+
# A descriptive label that is associated with a build. Build names do
|
774
|
+
# not need to be unique. You can change this value later.
|
771
775
|
#
|
772
776
|
# @option params [String] :version
|
773
|
-
# Version information associated with a build or script. Version
|
774
|
-
#
|
777
|
+
# Version information that is associated with a build or script. Version
|
778
|
+
# strings do not need to be unique. You can change this value later.
|
775
779
|
#
|
776
780
|
# @option params [Types::S3Location] :storage_location
|
777
781
|
# Information indicating where your game build files are stored. Use
|
@@ -786,12 +790,11 @@ module Aws::GameLift
|
|
786
790
|
# `SizeOnDisk` of 0.
|
787
791
|
#
|
788
792
|
# @option params [String] :operating_system
|
789
|
-
# The
|
793
|
+
# The environment that your game server binaries run on. This value
|
790
794
|
# determines the type of fleet resources that you use for this build. If
|
791
795
|
# your game build contains multiple executables, they all must run on
|
792
|
-
# the same operating system.
|
793
|
-
#
|
794
|
-
# build's operating system later.
|
796
|
+
# the same operating system. This parameter is required, and there's no
|
797
|
+
# default value. You can't change a build's operating system later.
|
795
798
|
#
|
796
799
|
# <note markdown="1"> Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more
|
797
800
|
# details in the [Amazon Linux 2 FAQs][1]. For game servers that are
|
@@ -889,39 +892,429 @@ module Aws::GameLift
|
|
889
892
|
req.send_request(options)
|
890
893
|
end
|
891
894
|
|
892
|
-
#
|
893
|
-
#
|
895
|
+
# Creates a managed fleet of Amazon Elastic Compute Cloud (Amazon EC2)
|
896
|
+
# instances to host your containerized game servers. Use this operation
|
897
|
+
# to define how to deploy a container architecture onto each fleet
|
898
|
+
# instance and configure fleet settings. You can create a container
|
899
|
+
# fleet in any Amazon Web Services Regions that Amazon GameLift supports
|
900
|
+
# for multi-location fleets. A container fleet can be deployed to a
|
901
|
+
# single location or multiple locations. Container fleets are deployed
|
902
|
+
# with Amazon Linux 2023 as the instance operating system.
|
894
903
|
#
|
895
|
-
#
|
904
|
+
# Define the fleet's container architecture using container group
|
905
|
+
# definitions. Each fleet can have one of the following container group
|
906
|
+
# types:
|
907
|
+
#
|
908
|
+
# * The game server container group runs your game server build and
|
909
|
+
# dependent software. Amazon GameLift deploys one or more replicas of
|
910
|
+
# this container group to each fleet instance. The number of replicas
|
911
|
+
# depends on the computing capabilities of the fleet instance in use.
|
912
|
+
#
|
913
|
+
# * An optional per-instance container group might be used to run other
|
914
|
+
# software that only needs to run once per instance, such as
|
915
|
+
# background services, logging, or test processes. One per-instance
|
916
|
+
# container group is deployed to each fleet instance.
|
917
|
+
#
|
918
|
+
# Each container group can include the definition for one or more
|
919
|
+
# containers. A container definition specifies a container image that is
|
920
|
+
# stored in an Amazon Elastic Container Registry (Amazon ECR) public or
|
921
|
+
# private repository.
|
922
|
+
#
|
923
|
+
# **Request options**
|
924
|
+
#
|
925
|
+
# Use this operation to make the following types of requests. Most fleet
|
926
|
+
# settings have default values, so you can create a working fleet with a
|
927
|
+
# minimal configuration and default values, which you can customize
|
928
|
+
# later.
|
929
|
+
#
|
930
|
+
# * Create a fleet with no container groups. You can configure a
|
931
|
+
# container fleet and then add container group definitions later. In
|
932
|
+
# this scenario, no fleet instances are deployed, and the fleet can't
|
933
|
+
# host game sessions until you add a game server container group
|
934
|
+
# definition. Provide the following required parameter values:
|
935
|
+
#
|
936
|
+
# * `FleetRoleArn`
|
937
|
+
#
|
938
|
+
# ^
|
939
|
+
# * Create a fleet with a game server container group. Provide the
|
940
|
+
# following required parameter values:
|
941
|
+
#
|
942
|
+
# * `FleetRoleArn`
|
943
|
+
#
|
944
|
+
# * `GameServerContainerGroupDefinitionName`
|
945
|
+
# * Create a fleet with a game server container group and a per-instance
|
946
|
+
# container group. Provide the following required parameter values:
|
947
|
+
#
|
948
|
+
# * `FleetRoleArn`
|
949
|
+
#
|
950
|
+
# * `GameServerContainerGroupDefinitionName`
|
951
|
+
#
|
952
|
+
# * `PerInstanceContainerGroupDefinitionName`
|
953
|
+
#
|
954
|
+
# **Results**
|
955
|
+
#
|
956
|
+
# If successful, this operation creates a new container fleet resource,
|
957
|
+
# places it in `PENDING` status, and initiates the [fleet creation
|
958
|
+
# workflow][1]. For fleets with container groups, this workflow starts a
|
959
|
+
# fleet deployment and transitions the status to `ACTIVE`. Fleets
|
960
|
+
# without a container group are placed in `CREATED` status.
|
961
|
+
#
|
962
|
+
# You can update most of the properties of a fleet, including container
|
963
|
+
# group definitions, and deploy the update across all fleet instances.
|
964
|
+
# Use a fleet update to deploy a new game server version update across
|
965
|
+
# the container fleet.
|
966
|
+
#
|
967
|
+
#
|
968
|
+
#
|
969
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow
|
970
|
+
#
|
971
|
+
# @option params [required, String] :fleet_role_arn
|
972
|
+
# The unique identifier for an Identity and Access Management (IAM) role
|
973
|
+
# with permissions to run your containers on resources that are managed
|
974
|
+
# by Amazon GameLift. Use an IAM service role with the
|
975
|
+
# `GameLiftContainerFleetPolicy` managed policy attached. For more
|
976
|
+
# information, see [Set up an IAM service role][1]. You can't change
|
977
|
+
# this fleet property after the fleet is created.
|
978
|
+
#
|
979
|
+
# IAM role ARN values use the following pattern: `arn:aws:iam::[Amazon
|
980
|
+
# Web Services account]:role/[role name]`.
|
981
|
+
#
|
982
|
+
#
|
983
|
+
#
|
984
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html
|
985
|
+
#
|
986
|
+
# @option params [String] :description
|
987
|
+
# A meaningful description of the container fleet.
|
988
|
+
#
|
989
|
+
# @option params [String] :game_server_container_group_definition_name
|
990
|
+
# A container group definition resource that describes how to deploy
|
991
|
+
# containers with your game server build and support software onto each
|
992
|
+
# fleet instance. You can specify the container group definition's name
|
993
|
+
# to use the latest version. Alternatively, provide an ARN value with a
|
994
|
+
# specific version number.
|
995
|
+
#
|
996
|
+
# Create a container group definition by calling
|
997
|
+
# CreateContainerGroupDefinition. This operation creates a
|
998
|
+
# ContainerGroupDefinition resource.
|
999
|
+
#
|
1000
|
+
# @option params [String] :per_instance_container_group_definition_name
|
1001
|
+
# The name of a container group definition resource that describes a set
|
1002
|
+
# of axillary software. A fleet instance has one process for executables
|
1003
|
+
# in this container group. A per-instance container group is optional.
|
1004
|
+
# You can update the fleet to add or remove a per-instance container
|
1005
|
+
# group at any time. You can specify the container group definition's
|
1006
|
+
# name to use the latest version. Alternatively, provide an ARN value
|
1007
|
+
# with a specific version number.
|
1008
|
+
#
|
1009
|
+
# Create a container group definition by calling
|
1010
|
+
# CreateContainerGroupDefinition. This operation creates a
|
1011
|
+
# ContainerGroupDefinition resource.
|
1012
|
+
#
|
1013
|
+
# @option params [Types::ConnectionPortRange] :instance_connection_port_range
|
1014
|
+
# The set of port numbers to open on each fleet instance. A fleet's
|
1015
|
+
# connection ports map to container ports that are configured in the
|
1016
|
+
# fleet's container group definitions.
|
1017
|
+
#
|
1018
|
+
# By default, Amazon GameLift calculates an optimal port range based on
|
1019
|
+
# your fleet configuration. To use the calculated range, don't set this
|
1020
|
+
# parameter. The values are:
|
1021
|
+
#
|
1022
|
+
# * Port range: 4192 to a number calculated based on your fleet
|
1023
|
+
# configuration. Amazon GameLift uses the following formula: `4192 +
|
1024
|
+
# [# of game server container groups per fleet instance] * [# of
|
1025
|
+
# container ports in the game server container group definition] + [#
|
1026
|
+
# of container ports in the game server container group definition]`
|
1027
|
+
#
|
1028
|
+
# ^
|
1029
|
+
#
|
1030
|
+
# You can also choose to manually set this parameter. When manually
|
1031
|
+
# setting this parameter, you must use port numbers that match the
|
1032
|
+
# fleet's inbound permissions port range.
|
1033
|
+
#
|
1034
|
+
# <note markdown="1"> If you set values manually, Amazon GameLift no longer calculates a
|
1035
|
+
# port range for you, even if you later remove the manual settings.
|
1036
|
+
#
|
1037
|
+
# </note>
|
1038
|
+
#
|
1039
|
+
# @option params [Array<Types::IpPermission>] :instance_inbound_permissions
|
1040
|
+
# The IP address ranges and port settings that allow inbound traffic to
|
1041
|
+
# access game server processes and other processes on this fleet. As a
|
1042
|
+
# best practice, when remotely accessing a fleet instance, we recommend
|
1043
|
+
# opening ports only when you need them and closing them when you're
|
1044
|
+
# finished.
|
1045
|
+
#
|
1046
|
+
# By default, Amazon GameLift calculates an optimal port range based on
|
1047
|
+
# your fleet configuration. To use the calculated range, don't set this
|
1048
|
+
# parameter. The values are:
|
1049
|
+
#
|
1050
|
+
# * Protocol: UDP
|
1051
|
+
#
|
1052
|
+
# * Port range: 4192 to a number calculated based on your fleet
|
1053
|
+
# configuration. Amazon GameLift uses the following formula: `4192 +
|
1054
|
+
# [# of game server container groups per fleet instance] * [# of
|
1055
|
+
# container ports in the game server container group definition] + [#
|
1056
|
+
# of container ports in the game server container group definition]`
|
1057
|
+
#
|
1058
|
+
# You can also choose to manually set this parameter. When manually
|
1059
|
+
# setting this parameter, you must use port numbers that match the
|
1060
|
+
# fleet's connection port range.
|
1061
|
+
#
|
1062
|
+
# <note markdown="1"> If you set values manually, Amazon GameLift no longer calculates a
|
1063
|
+
# port range for you, even if you later remove the manual settings.
|
1064
|
+
#
|
1065
|
+
# </note>
|
1066
|
+
#
|
1067
|
+
# @option params [Integer] :game_server_container_groups_per_instance
|
1068
|
+
# The number of times to replicate the game server container group on
|
1069
|
+
# each fleet instance.
|
1070
|
+
#
|
1071
|
+
# By default, Amazon GameLift calculates the maximum number of game
|
1072
|
+
# server container groups that can fit on each instance. This
|
1073
|
+
# calculation is based on the CPU and memory resources of the fleet's
|
1074
|
+
# instance type). To use the calculated maximum, don't set this
|
1075
|
+
# parameter. If you set this number manually, Amazon GameLift uses your
|
1076
|
+
# value as long as it's less than the calculated maximum.
|
1077
|
+
#
|
1078
|
+
# @option params [String] :instance_type
|
1079
|
+
# The Amazon EC2 instance type to use for all instances in the fleet.
|
1080
|
+
# For multi-location fleets, the instance type must be available in the
|
1081
|
+
# home region and all remote locations. Instance type determines the
|
1082
|
+
# computing resources and processing power that's available to host
|
1083
|
+
# your game servers. This includes including CPU, memory, storage, and
|
1084
|
+
# networking capacity.
|
1085
|
+
#
|
1086
|
+
# By default, Amazon GameLift selects an instance type that fits the
|
1087
|
+
# needs of your container groups and is available in all selected fleet
|
1088
|
+
# locations. You can also choose to manually set this parameter. See
|
1089
|
+
# [Amazon Elastic Compute Cloud Instance Types][1] for detailed
|
1090
|
+
# descriptions of Amazon EC2 instance types.
|
1091
|
+
#
|
1092
|
+
# You can't update this fleet property later.
|
1093
|
+
#
|
1094
|
+
#
|
1095
|
+
#
|
1096
|
+
# [1]: http://aws.amazon.com/ec2/instance-types/
|
1097
|
+
#
|
1098
|
+
# @option params [String] :billing_type
|
1099
|
+
# Indicates whether to use On-Demand or Spot instances for this fleet.
|
1100
|
+
# Learn more about when to use [ On-Demand versus Spot Instances][1].
|
1101
|
+
# This fleet property can't be changed after the fleet is created.
|
1102
|
+
#
|
1103
|
+
# By default, this property is set to `ON_DEMAND`.
|
1104
|
+
#
|
1105
|
+
# You can't update this fleet property later.
|
1106
|
+
#
|
1107
|
+
#
|
1108
|
+
#
|
1109
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot
|
1110
|
+
#
|
1111
|
+
# @option params [Array<Types::LocationConfiguration>] :locations
|
1112
|
+
# A set of locations to deploy container fleet instances to. You can add
|
1113
|
+
# any Amazon Web Services Region or Local Zone that's supported by
|
1114
|
+
# Amazon GameLift. Provide a list of one or more Amazon Web Services
|
1115
|
+
# Region codes, such as `us-west-2`, or Local Zone names. Also include
|
1116
|
+
# the fleet's home Region, which is the Amazon Web Services Region
|
1117
|
+
# where the fleet is created. For a list of supported Regions and Local
|
1118
|
+
# Zones, see [ Amazon GameLift service locations][1] for managed
|
1119
|
+
# hosting.
|
1120
|
+
#
|
1121
|
+
#
|
1122
|
+
#
|
1123
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html
|
1124
|
+
#
|
1125
|
+
# @option params [Array<String>] :metric_groups
|
1126
|
+
# The name of an Amazon Web Services CloudWatch metric group to add this
|
1127
|
+
# fleet to. You can use a metric group to aggregate metrics for multiple
|
1128
|
+
# fleets. You can specify an existing metric group name or use a new
|
1129
|
+
# name to create a new metric group. Each fleet can have only one metric
|
1130
|
+
# group, but you can change this value at any time.
|
1131
|
+
#
|
1132
|
+
# @option params [String] :new_game_session_protection_policy
|
1133
|
+
# Determines whether Amazon GameLift can shut down game sessions on the
|
1134
|
+
# fleet that are actively running and hosting players. Amazon GameLift
|
1135
|
+
# might prompt an instance shutdown when scaling down fleet capacity or
|
1136
|
+
# when retiring unhealthy instances. You can also set game session
|
1137
|
+
# protection for individual game sessions using
|
1138
|
+
# [UpdateGameSession](gamelift/latest/apireference/API_UpdateGameSession.html).
|
1139
|
+
#
|
1140
|
+
# * **NoProtection** -- Game sessions can be shut down during active
|
1141
|
+
# gameplay.
|
1142
|
+
#
|
1143
|
+
# * **FullProtection** -- Game sessions in `ACTIVE` status can't be
|
1144
|
+
# shut down.
|
1145
|
+
#
|
1146
|
+
# By default, this property is set to `NoProtection`.
|
1147
|
+
#
|
1148
|
+
# @option params [Types::GameSessionCreationLimitPolicy] :game_session_creation_limit_policy
|
1149
|
+
# A policy that limits the number of game sessions that each individual
|
1150
|
+
# player can create on instances in this fleet. The limit applies for a
|
1151
|
+
# specified span of time.
|
1152
|
+
#
|
1153
|
+
# @option params [Types::LogConfiguration] :log_configuration
|
1154
|
+
# A method for collecting container logs for the fleet. Amazon GameLift
|
1155
|
+
# saves all standard output for each container in logs, including game
|
1156
|
+
# session logs. You can select from the following methods:
|
1157
|
+
#
|
1158
|
+
# * `CLOUDWATCH` -- Send logs to an Amazon CloudWatch log group that you
|
1159
|
+
# define. Each container emits a log stream, which is organized in the
|
1160
|
+
# log group.
|
1161
|
+
#
|
1162
|
+
# * `S3` -- Store logs in an Amazon S3 bucket that you define.
|
1163
|
+
#
|
1164
|
+
# * `NONE` -- Don't collect container logs.
|
1165
|
+
#
|
1166
|
+
# By default, this property is set to `CLOUDWATCH`.
|
1167
|
+
#
|
1168
|
+
# Amazon GameLift requires permissions to send logs other Amazon Web
|
1169
|
+
# Services services in your account. These permissions are included in
|
1170
|
+
# the IAM fleet role for this container fleet (see `FleetRoleArn)`.
|
1171
|
+
#
|
1172
|
+
# @option params [Array<Types::Tag>] :tags
|
1173
|
+
# A list of labels to assign to the new fleet resource. Tags are
|
1174
|
+
# developer-defined key-value pairs. Tagging Amazon Web Services
|
1175
|
+
# resources are useful for resource management, access management and
|
1176
|
+
# cost allocation. For more information, see [ Tagging Amazon Web
|
1177
|
+
# Services Resources][1] in the *Amazon Web Services General Reference*.
|
1178
|
+
#
|
1179
|
+
#
|
1180
|
+
#
|
1181
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1182
|
+
#
|
1183
|
+
# @return [Types::CreateContainerFleetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1184
|
+
#
|
1185
|
+
# * {Types::CreateContainerFleetOutput#container_fleet #container_fleet} => Types::ContainerFleet
|
1186
|
+
#
|
1187
|
+
# @example Request syntax with placeholder values
|
1188
|
+
#
|
1189
|
+
# resp = client.create_container_fleet({
|
1190
|
+
# fleet_role_arn: "ArnStringModel", # required
|
1191
|
+
# description: "NonZeroAndMaxString",
|
1192
|
+
# game_server_container_group_definition_name: "ContainerGroupDefinitionNameOrArn",
|
1193
|
+
# per_instance_container_group_definition_name: "ContainerGroupDefinitionNameOrArn",
|
1194
|
+
# instance_connection_port_range: {
|
1195
|
+
# from_port: 1, # required
|
1196
|
+
# to_port: 1, # required
|
1197
|
+
# },
|
1198
|
+
# instance_inbound_permissions: [
|
1199
|
+
# {
|
1200
|
+
# from_port: 1, # required
|
1201
|
+
# to_port: 1, # required
|
1202
|
+
# ip_range: "IpRange", # required
|
1203
|
+
# protocol: "TCP", # required, accepts TCP, UDP
|
1204
|
+
# },
|
1205
|
+
# ],
|
1206
|
+
# game_server_container_groups_per_instance: 1,
|
1207
|
+
# instance_type: "NonZeroAndMaxString",
|
1208
|
+
# billing_type: "ON_DEMAND", # accepts ON_DEMAND, SPOT
|
1209
|
+
# locations: [
|
1210
|
+
# {
|
1211
|
+
# location: "LocationStringModel", # required
|
1212
|
+
# },
|
1213
|
+
# ],
|
1214
|
+
# metric_groups: ["MetricGroup"],
|
1215
|
+
# new_game_session_protection_policy: "NoProtection", # accepts NoProtection, FullProtection
|
1216
|
+
# game_session_creation_limit_policy: {
|
1217
|
+
# new_game_sessions_per_creator: 1,
|
1218
|
+
# policy_period_in_minutes: 1,
|
1219
|
+
# },
|
1220
|
+
# log_configuration: {
|
1221
|
+
# log_destination: "NONE", # accepts NONE, CLOUDWATCH, S3
|
1222
|
+
# s3_bucket_name: "NonEmptyString",
|
1223
|
+
# log_group_arn: "LogGroupArnStringModel",
|
1224
|
+
# },
|
1225
|
+
# tags: [
|
1226
|
+
# {
|
1227
|
+
# key: "TagKey", # required
|
1228
|
+
# value: "TagValue", # required
|
1229
|
+
# },
|
1230
|
+
# ],
|
1231
|
+
# })
|
1232
|
+
#
|
1233
|
+
# @example Response structure
|
1234
|
+
#
|
1235
|
+
# resp.container_fleet.fleet_id #=> String
|
1236
|
+
# resp.container_fleet.fleet_arn #=> String
|
1237
|
+
# resp.container_fleet.fleet_role_arn #=> String
|
1238
|
+
# resp.container_fleet.game_server_container_group_definition_name #=> String
|
1239
|
+
# resp.container_fleet.game_server_container_group_definition_arn #=> String
|
1240
|
+
# resp.container_fleet.per_instance_container_group_definition_name #=> String
|
1241
|
+
# resp.container_fleet.per_instance_container_group_definition_arn #=> String
|
1242
|
+
# resp.container_fleet.instance_connection_port_range.from_port #=> Integer
|
1243
|
+
# resp.container_fleet.instance_connection_port_range.to_port #=> Integer
|
1244
|
+
# resp.container_fleet.instance_inbound_permissions #=> Array
|
1245
|
+
# resp.container_fleet.instance_inbound_permissions[0].from_port #=> Integer
|
1246
|
+
# resp.container_fleet.instance_inbound_permissions[0].to_port #=> Integer
|
1247
|
+
# resp.container_fleet.instance_inbound_permissions[0].ip_range #=> String
|
1248
|
+
# resp.container_fleet.instance_inbound_permissions[0].protocol #=> String, one of "TCP", "UDP"
|
1249
|
+
# resp.container_fleet.game_server_container_groups_per_instance #=> Integer
|
1250
|
+
# resp.container_fleet.maximum_game_server_container_groups_per_instance #=> Integer
|
1251
|
+
# resp.container_fleet.instance_type #=> String
|
1252
|
+
# resp.container_fleet.billing_type #=> String, one of "ON_DEMAND", "SPOT"
|
1253
|
+
# resp.container_fleet.description #=> String
|
1254
|
+
# resp.container_fleet.creation_time #=> Time
|
1255
|
+
# resp.container_fleet.metric_groups #=> Array
|
1256
|
+
# resp.container_fleet.metric_groups[0] #=> String
|
1257
|
+
# resp.container_fleet.new_game_session_protection_policy #=> String, one of "NoProtection", "FullProtection"
|
1258
|
+
# resp.container_fleet.game_session_creation_limit_policy.new_game_sessions_per_creator #=> Integer
|
1259
|
+
# resp.container_fleet.game_session_creation_limit_policy.policy_period_in_minutes #=> Integer
|
1260
|
+
# resp.container_fleet.status #=> String, one of "PENDING", "CREATING", "CREATED", "ACTIVATING", "ACTIVE", "UPDATING", "DELETING"
|
1261
|
+
# resp.container_fleet.deployment_details.latest_deployment_id #=> String
|
1262
|
+
# resp.container_fleet.log_configuration.log_destination #=> String, one of "NONE", "CLOUDWATCH", "S3"
|
1263
|
+
# resp.container_fleet.log_configuration.s3_bucket_name #=> String
|
1264
|
+
# resp.container_fleet.log_configuration.log_group_arn #=> String
|
1265
|
+
# resp.container_fleet.location_attributes #=> Array
|
1266
|
+
# resp.container_fleet.location_attributes[0].location #=> String
|
1267
|
+
# resp.container_fleet.location_attributes[0].status #=> String, one of "PENDING", "CREATING", "CREATED", "ACTIVATING", "ACTIVE", "UPDATING", "DELETING"
|
1268
|
+
#
|
1269
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateContainerFleet AWS API Documentation
|
1270
|
+
#
|
1271
|
+
# @overload create_container_fleet(params = {})
|
1272
|
+
# @param [Hash] params ({})
|
1273
|
+
def create_container_fleet(params = {}, options = {})
|
1274
|
+
req = build_request(:create_container_fleet, params)
|
1275
|
+
req.send_request(options)
|
1276
|
+
end
|
1277
|
+
|
1278
|
+
# Creates a `ContainerGroupDefinition` that describes a set of
|
896
1279
|
# containers for hosting your game server with Amazon GameLift managed
|
897
|
-
#
|
898
|
-
# container
|
899
|
-
#
|
900
|
-
#
|
901
|
-
#
|
902
|
-
#
|
903
|
-
#
|
904
|
-
#
|
905
|
-
#
|
906
|
-
#
|
907
|
-
#
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
913
|
-
#
|
914
|
-
#
|
915
|
-
#
|
916
|
-
#
|
917
|
-
#
|
918
|
-
#
|
919
|
-
#
|
920
|
-
#
|
921
|
-
#
|
922
|
-
#
|
923
|
-
#
|
924
|
-
#
|
1280
|
+
# containers hosting. An Amazon GameLift container group is similar to a
|
1281
|
+
# container task or pod. Use container group definitions when you create
|
1282
|
+
# a container fleet with CreateContainerFleet.
|
1283
|
+
#
|
1284
|
+
# A container group definition determines how Amazon GameLift deploys
|
1285
|
+
# your containers to each instance in a container fleet. You can
|
1286
|
+
# maintain multiple versions of a container group definition.
|
1287
|
+
#
|
1288
|
+
# There are two types of container groups:
|
1289
|
+
#
|
1290
|
+
# * A **game server container group** has the containers that run your
|
1291
|
+
# game server application and supporting software. A game server
|
1292
|
+
# container group can have these container types:
|
1293
|
+
#
|
1294
|
+
# * Game server container. This container runs your game server. You
|
1295
|
+
# can define one game server container in a game server container
|
1296
|
+
# group.
|
1297
|
+
#
|
1298
|
+
# * Support container. This container runs software in parallel with
|
1299
|
+
# your game server. You can define up to 8 support containers in a
|
1300
|
+
# game server group.
|
1301
|
+
# When building a game server container group definition, you can
|
1302
|
+
# choose to bundle your game server executable and all dependent
|
1303
|
+
# software into a single game server container. Alternatively, you can
|
1304
|
+
# separate the software into one game server container and one or more
|
1305
|
+
# support containers.
|
1306
|
+
#
|
1307
|
+
# On a container fleet instance, a game server container group can be
|
1308
|
+
# deployed multiple times (depending on the compute resources of the
|
1309
|
+
# instance). This means that all containers in the container group are
|
1310
|
+
# replicated together.
|
1311
|
+
#
|
1312
|
+
# * A **per-instance container group** has containers for processes that
|
1313
|
+
# aren't replicated on a container fleet instance. This might include
|
1314
|
+
# background services, logging, test processes, or processes that need
|
1315
|
+
# to persist independently of the game server container group. When
|
1316
|
+
# building a per-instance container group, you can define up to 10
|
1317
|
+
# support containers.
|
925
1318
|
#
|
926
1319
|
# <note markdown="1"> This operation requires Identity and Access Management (IAM)
|
927
1320
|
# permissions to access container images in Amazon ECR repositories. See
|
@@ -930,71 +1323,115 @@ module Aws::GameLift
|
|
930
1323
|
#
|
931
1324
|
# </note>
|
932
1325
|
#
|
933
|
-
#
|
934
|
-
# resource with an ARN value assigned. You can't change the properties
|
935
|
-
# of a container group definition. Instead, create a new one.
|
1326
|
+
# **Request options**
|
936
1327
|
#
|
937
|
-
#
|
1328
|
+
# Use this operation to make the following types of requests. You can
|
1329
|
+
# specify values for the minimum required parameters and customize
|
1330
|
+
# optional values later.
|
1331
|
+
#
|
1332
|
+
# * Create a game server container group definition. Provide the
|
1333
|
+
# following required parameter values:
|
1334
|
+
#
|
1335
|
+
# * `Name`
|
1336
|
+
#
|
1337
|
+
# * `ContainerGroupType` (`GAME_SERVER`)
|
1338
|
+
#
|
1339
|
+
# * `OperatingSystem` (omit to use default value)
|
1340
|
+
#
|
1341
|
+
# * `TotalMemoryLimitMebibytes` (omit to use default value)
|
1342
|
+
#
|
1343
|
+
# * `TotalVcpuLimit `(omit to use default value)
|
1344
|
+
#
|
1345
|
+
# * At least one `GameServerContainerDefinition`
|
1346
|
+
#
|
1347
|
+
# * `ContainerName`
|
1348
|
+
#
|
1349
|
+
# * `ImageUrl`
|
1350
|
+
#
|
1351
|
+
# * `PortConfiguration`
|
1352
|
+
#
|
1353
|
+
# * `ServerSdkVersion` (omit to use default value)
|
1354
|
+
# * Create a per-instance container group definition. Provide the
|
1355
|
+
# following required parameter values:
|
1356
|
+
#
|
1357
|
+
# * `Name`
|
1358
|
+
#
|
1359
|
+
# * `ContainerGroupType` (`PER_INSTANCE`)
|
1360
|
+
#
|
1361
|
+
# * `OperatingSystem` (omit to use default value)
|
1362
|
+
#
|
1363
|
+
# * `TotalMemoryLimitMebibytes` (omit to use default value)
|
1364
|
+
#
|
1365
|
+
# * `TotalVcpuLimit `(omit to use default value)
|
1366
|
+
#
|
1367
|
+
# * At least one `SupportContainerDefinition`
|
1368
|
+
#
|
1369
|
+
# * `ContainerName`
|
938
1370
|
#
|
939
|
-
#
|
1371
|
+
# * `ImageUrl`
|
940
1372
|
#
|
941
|
-
#
|
1373
|
+
# **Results**
|
942
1374
|
#
|
943
|
-
#
|
1375
|
+
# If successful, this request creates a `ContainerGroupDefinition`
|
1376
|
+
# resource and assigns a unique ARN value. You can update most
|
1377
|
+
# properties of a container group definition by calling
|
1378
|
+
# UpdateContainerGroupDefinition, and optionally save the update as a
|
1379
|
+
# new version.
|
944
1380
|
#
|
945
1381
|
#
|
946
1382
|
#
|
947
1383
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html
|
948
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html
|
949
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet.html
|
950
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-definitions.html#containers-definitions-create
|
951
1384
|
#
|
952
1385
|
# @option params [required, String] :name
|
953
1386
|
# A descriptive identifier for the container group definition. The name
|
954
1387
|
# value must be unique in an Amazon Web Services Region.
|
955
1388
|
#
|
956
|
-
# @option params [String] :
|
957
|
-
# The
|
958
|
-
#
|
959
|
-
#
|
960
|
-
# Default value is `REPLICA`.
|
1389
|
+
# @option params [String] :container_group_type
|
1390
|
+
# The type of container group being defined. Container group type
|
1391
|
+
# determines how Amazon GameLift deploys the container group on each
|
1392
|
+
# fleet instance.
|
961
1393
|
#
|
962
|
-
#
|
1394
|
+
# Default value: `GAME_SERVER`
|
1395
|
+
#
|
1396
|
+
# @option params [required, Integer] :total_memory_limit_mebibytes
|
963
1397
|
# The maximum amount of memory (in MiB) to allocate to the container
|
964
1398
|
# group. All containers in the group share this memory. If you specify
|
965
|
-
# memory limits for individual
|
966
|
-
#
|
967
|
-
# of the soft memory limits for all containers in the group, and (2)
|
968
|
-
# greater than any individual container's hard memory limit.
|
1399
|
+
# memory limits for an individual container, the total value must be
|
1400
|
+
# greater than any individual container's memory limit.
|
969
1401
|
#
|
970
|
-
#
|
971
|
-
# The maximum amount of CPU units to allocate to the container group.
|
972
|
-
# Set this parameter to an integer value in CPU units (1 vCPU is equal
|
973
|
-
# to 1024 CPU units). All containers in the group share this memory. If
|
974
|
-
# you specify CPU limits for individual containers, set this parameter
|
975
|
-
# based on the following guidelines. The value must be equal to or
|
976
|
-
# greater than the sum of the CPU limits for all containers in the
|
977
|
-
# group.
|
1402
|
+
# Default value: 1024
|
978
1403
|
#
|
979
|
-
# @option params [required,
|
980
|
-
#
|
981
|
-
#
|
982
|
-
#
|
983
|
-
#
|
1404
|
+
# @option params [required, Float] :total_vcpu_limit
|
1405
|
+
# The maximum amount of vCPU units to allocate to the container group (1
|
1406
|
+
# vCPU is equal to 1024 CPU units). All containers in the group share
|
1407
|
+
# this memory. If you specify vCPU limits for individual containers, the
|
1408
|
+
# total value must be equal to or greater than the sum of the CPU limits
|
1409
|
+
# for all containers in the group.
|
984
1410
|
#
|
1411
|
+
# Default value: 1
|
985
1412
|
#
|
1413
|
+
# @option params [Types::GameServerContainerDefinitionInput] :game_server_container_definition
|
1414
|
+
# The definition for the game server container in this group. Define a
|
1415
|
+
# game server container only when the container group type is
|
1416
|
+
# `GAME_SERVER`. Game server containers specify a container image with
|
1417
|
+
# your game server build. You can pass in your container definitions as
|
1418
|
+
# a JSON file.
|
986
1419
|
#
|
987
|
-
#
|
1420
|
+
# @option params [Array<Types::SupportContainerDefinitionInput>] :support_container_definitions
|
1421
|
+
# One or more definition for support containers in this group. You can
|
1422
|
+
# define a support container in any type of container group. You can
|
1423
|
+
# pass in your container definitions as a JSON file.
|
988
1424
|
#
|
989
1425
|
# @option params [required, String] :operating_system
|
990
|
-
# The platform that
|
991
|
-
#
|
992
|
-
#
|
1426
|
+
# The platform that all containers in the group use. Containers in a
|
1427
|
+
# group must run on the same operating system.
|
1428
|
+
#
|
1429
|
+
# Default value: `AMAZON_LINUX_2023`
|
993
1430
|
#
|
994
1431
|
# <note markdown="1"> Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more
|
995
1432
|
# details in the [Amazon Linux 2 FAQs][1]. For game servers that are
|
996
|
-
# hosted on AL2 and use Amazon GameLift server SDK 4.x
|
997
|
-
#
|
1433
|
+
# hosted on AL2 and use Amazon GameLift server SDK 4.x, first update the
|
1434
|
+
# game server build to server SDK 5.x, and then deploy to AL2023
|
998
1435
|
# instances. See [ Migrate to Amazon GameLift server SDK version 5.][2]
|
999
1436
|
#
|
1000
1437
|
# </note>
|
@@ -1004,6 +1441,10 @@ module Aws::GameLift
|
|
1004
1441
|
# [1]: https://aws.amazon.com/amazon-linux-2/faqs/
|
1005
1442
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html
|
1006
1443
|
#
|
1444
|
+
# @option params [String] :version_description
|
1445
|
+
# A description for the initial version of this container group
|
1446
|
+
# definition.
|
1447
|
+
#
|
1007
1448
|
# @option params [Array<Types::Tag>] :tags
|
1008
1449
|
# A list of labels to assign to the container group definition resource.
|
1009
1450
|
# Tags are developer-defined key-value pairs. Tagging Amazon Web
|
@@ -1024,53 +1465,88 @@ module Aws::GameLift
|
|
1024
1465
|
#
|
1025
1466
|
# resp = client.create_container_group_definition({
|
1026
1467
|
# name: "ContainerGroupDefinitionName", # required
|
1027
|
-
#
|
1028
|
-
#
|
1029
|
-
#
|
1030
|
-
#
|
1031
|
-
#
|
1032
|
-
#
|
1033
|
-
#
|
1034
|
-
#
|
1035
|
-
#
|
1036
|
-
# hard_limit: 1,
|
1468
|
+
# container_group_type: "GAME_SERVER", # accepts GAME_SERVER, PER_INSTANCE
|
1469
|
+
# total_memory_limit_mebibytes: 1, # required
|
1470
|
+
# total_vcpu_limit: 1.0, # required
|
1471
|
+
# game_server_container_definition: {
|
1472
|
+
# container_name: "NonZeroAnd128MaxAsciiString", # required
|
1473
|
+
# depends_on: [
|
1474
|
+
# {
|
1475
|
+
# container_name: "NonZeroAnd128MaxAsciiString", # required
|
1476
|
+
# condition: "START", # required, accepts START, COMPLETE, SUCCESS, HEALTHY
|
1037
1477
|
# },
|
1038
|
-
#
|
1039
|
-
#
|
1040
|
-
#
|
1041
|
-
#
|
1042
|
-
#
|
1043
|
-
#
|
1044
|
-
# },
|
1045
|
-
# ],
|
1478
|
+
# ],
|
1479
|
+
# mount_points: [
|
1480
|
+
# {
|
1481
|
+
# instance_path: "InstancePathString", # required
|
1482
|
+
# container_path: "ContainerPathString",
|
1483
|
+
# access_level: "READ_ONLY", # accepts READ_ONLY, READ_AND_WRITE
|
1046
1484
|
# },
|
1047
|
-
#
|
1048
|
-
#
|
1049
|
-
#
|
1050
|
-
#
|
1051
|
-
#
|
1052
|
-
# retries: 1,
|
1053
|
-
# start_period: 1,
|
1485
|
+
# ],
|
1486
|
+
# environment_override: [
|
1487
|
+
# {
|
1488
|
+
# name: "NonZeroAnd255MaxString", # required
|
1489
|
+
# value: "NonZeroAnd255MaxString", # required
|
1054
1490
|
# },
|
1055
|
-
#
|
1056
|
-
#
|
1057
|
-
#
|
1058
|
-
#
|
1059
|
-
# environment: [
|
1491
|
+
# ],
|
1492
|
+
# image_uri: "ImageUriString", # required
|
1493
|
+
# port_configuration: { # required
|
1494
|
+
# container_port_ranges: [ # required
|
1060
1495
|
# {
|
1061
|
-
#
|
1062
|
-
#
|
1496
|
+
# from_port: 1, # required
|
1497
|
+
# to_port: 1, # required
|
1498
|
+
# protocol: "TCP", # required, accepts TCP, UDP
|
1063
1499
|
# },
|
1064
1500
|
# ],
|
1501
|
+
# },
|
1502
|
+
# server_sdk_version: "ServerSdkVersion", # required
|
1503
|
+
# },
|
1504
|
+
# support_container_definitions: [
|
1505
|
+
# {
|
1506
|
+
# container_name: "NonZeroAnd128MaxAsciiString", # required
|
1065
1507
|
# depends_on: [
|
1066
1508
|
# {
|
1067
1509
|
# container_name: "NonZeroAnd128MaxAsciiString", # required
|
1068
1510
|
# condition: "START", # required, accepts START, COMPLETE, SUCCESS, HEALTHY
|
1069
1511
|
# },
|
1070
1512
|
# ],
|
1513
|
+
# mount_points: [
|
1514
|
+
# {
|
1515
|
+
# instance_path: "InstancePathString", # required
|
1516
|
+
# container_path: "ContainerPathString",
|
1517
|
+
# access_level: "READ_ONLY", # accepts READ_ONLY, READ_AND_WRITE
|
1518
|
+
# },
|
1519
|
+
# ],
|
1520
|
+
# environment_override: [
|
1521
|
+
# {
|
1522
|
+
# name: "NonZeroAnd255MaxString", # required
|
1523
|
+
# value: "NonZeroAnd255MaxString", # required
|
1524
|
+
# },
|
1525
|
+
# ],
|
1526
|
+
# essential: false,
|
1527
|
+
# health_check: {
|
1528
|
+
# command: ["NonZeroAnd255MaxString"], # required
|
1529
|
+
# interval: 1,
|
1530
|
+
# retries: 1,
|
1531
|
+
# start_period: 1,
|
1532
|
+
# timeout: 1,
|
1533
|
+
# },
|
1534
|
+
# image_uri: "ImageUriString", # required
|
1535
|
+
# memory_hard_limit_mebibytes: 1,
|
1536
|
+
# port_configuration: {
|
1537
|
+
# container_port_ranges: [ # required
|
1538
|
+
# {
|
1539
|
+
# from_port: 1, # required
|
1540
|
+
# to_port: 1, # required
|
1541
|
+
# protocol: "TCP", # required, accepts TCP, UDP
|
1542
|
+
# },
|
1543
|
+
# ],
|
1544
|
+
# },
|
1545
|
+
# vcpu: 1.0,
|
1071
1546
|
# },
|
1072
1547
|
# ],
|
1073
1548
|
# operating_system: "AMAZON_LINUX_2023", # required, accepts AMAZON_LINUX_2023
|
1549
|
+
# version_description: "NonZeroAndMaxString",
|
1074
1550
|
# tags: [
|
1075
1551
|
# {
|
1076
1552
|
# key: "TagKey", # required
|
@@ -1085,38 +1561,56 @@ module Aws::GameLift
|
|
1085
1561
|
# resp.container_group_definition.creation_time #=> Time
|
1086
1562
|
# resp.container_group_definition.operating_system #=> String, one of "AMAZON_LINUX_2023"
|
1087
1563
|
# resp.container_group_definition.name #=> String
|
1088
|
-
# resp.container_group_definition.
|
1089
|
-
# resp.container_group_definition.
|
1090
|
-
# resp.container_group_definition.
|
1091
|
-
# resp.container_group_definition.
|
1092
|
-
# resp.container_group_definition.
|
1093
|
-
# resp.container_group_definition.
|
1094
|
-
# resp.container_group_definition.
|
1095
|
-
# resp.container_group_definition.
|
1096
|
-
# resp.container_group_definition.
|
1097
|
-
# resp.container_group_definition.
|
1098
|
-
# resp.container_group_definition.
|
1099
|
-
# resp.container_group_definition.
|
1100
|
-
# resp.container_group_definition.
|
1101
|
-
# resp.container_group_definition.
|
1102
|
-
# resp.container_group_definition.
|
1103
|
-
# resp.container_group_definition.
|
1104
|
-
# resp.container_group_definition.
|
1105
|
-
# resp.container_group_definition.
|
1106
|
-
# resp.container_group_definition.
|
1107
|
-
# resp.container_group_definition.
|
1108
|
-
# resp.container_group_definition.
|
1109
|
-
# resp.container_group_definition.
|
1110
|
-
# resp.container_group_definition.
|
1111
|
-
# resp.container_group_definition.
|
1112
|
-
# resp.container_group_definition.
|
1113
|
-
# resp.container_group_definition.
|
1114
|
-
# resp.container_group_definition.
|
1115
|
-
# resp.container_group_definition.
|
1116
|
-
# resp.container_group_definition.
|
1117
|
-
# resp.container_group_definition.
|
1118
|
-
# resp.container_group_definition.
|
1119
|
-
# resp.container_group_definition.
|
1564
|
+
# resp.container_group_definition.container_group_type #=> String, one of "GAME_SERVER", "PER_INSTANCE"
|
1565
|
+
# resp.container_group_definition.total_memory_limit_mebibytes #=> Integer
|
1566
|
+
# resp.container_group_definition.total_vcpu_limit #=> Float
|
1567
|
+
# resp.container_group_definition.game_server_container_definition.container_name #=> String
|
1568
|
+
# resp.container_group_definition.game_server_container_definition.depends_on #=> Array
|
1569
|
+
# resp.container_group_definition.game_server_container_definition.depends_on[0].container_name #=> String
|
1570
|
+
# resp.container_group_definition.game_server_container_definition.depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
1571
|
+
# resp.container_group_definition.game_server_container_definition.mount_points #=> Array
|
1572
|
+
# resp.container_group_definition.game_server_container_definition.mount_points[0].instance_path #=> String
|
1573
|
+
# resp.container_group_definition.game_server_container_definition.mount_points[0].container_path #=> String
|
1574
|
+
# resp.container_group_definition.game_server_container_definition.mount_points[0].access_level #=> String, one of "READ_ONLY", "READ_AND_WRITE"
|
1575
|
+
# resp.container_group_definition.game_server_container_definition.environment_override #=> Array
|
1576
|
+
# resp.container_group_definition.game_server_container_definition.environment_override[0].name #=> String
|
1577
|
+
# resp.container_group_definition.game_server_container_definition.environment_override[0].value #=> String
|
1578
|
+
# resp.container_group_definition.game_server_container_definition.image_uri #=> String
|
1579
|
+
# resp.container_group_definition.game_server_container_definition.port_configuration.container_port_ranges #=> Array
|
1580
|
+
# resp.container_group_definition.game_server_container_definition.port_configuration.container_port_ranges[0].from_port #=> Integer
|
1581
|
+
# resp.container_group_definition.game_server_container_definition.port_configuration.container_port_ranges[0].to_port #=> Integer
|
1582
|
+
# resp.container_group_definition.game_server_container_definition.port_configuration.container_port_ranges[0].protocol #=> String, one of "TCP", "UDP"
|
1583
|
+
# resp.container_group_definition.game_server_container_definition.resolved_image_digest #=> String
|
1584
|
+
# resp.container_group_definition.game_server_container_definition.server_sdk_version #=> String
|
1585
|
+
# resp.container_group_definition.support_container_definitions #=> Array
|
1586
|
+
# resp.container_group_definition.support_container_definitions[0].container_name #=> String
|
1587
|
+
# resp.container_group_definition.support_container_definitions[0].depends_on #=> Array
|
1588
|
+
# resp.container_group_definition.support_container_definitions[0].depends_on[0].container_name #=> String
|
1589
|
+
# resp.container_group_definition.support_container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
1590
|
+
# resp.container_group_definition.support_container_definitions[0].mount_points #=> Array
|
1591
|
+
# resp.container_group_definition.support_container_definitions[0].mount_points[0].instance_path #=> String
|
1592
|
+
# resp.container_group_definition.support_container_definitions[0].mount_points[0].container_path #=> String
|
1593
|
+
# resp.container_group_definition.support_container_definitions[0].mount_points[0].access_level #=> String, one of "READ_ONLY", "READ_AND_WRITE"
|
1594
|
+
# resp.container_group_definition.support_container_definitions[0].environment_override #=> Array
|
1595
|
+
# resp.container_group_definition.support_container_definitions[0].environment_override[0].name #=> String
|
1596
|
+
# resp.container_group_definition.support_container_definitions[0].environment_override[0].value #=> String
|
1597
|
+
# resp.container_group_definition.support_container_definitions[0].essential #=> Boolean
|
1598
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.command #=> Array
|
1599
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.command[0] #=> String
|
1600
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.interval #=> Integer
|
1601
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.retries #=> Integer
|
1602
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.start_period #=> Integer
|
1603
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.timeout #=> Integer
|
1604
|
+
# resp.container_group_definition.support_container_definitions[0].image_uri #=> String
|
1605
|
+
# resp.container_group_definition.support_container_definitions[0].memory_hard_limit_mebibytes #=> Integer
|
1606
|
+
# resp.container_group_definition.support_container_definitions[0].port_configuration.container_port_ranges #=> Array
|
1607
|
+
# resp.container_group_definition.support_container_definitions[0].port_configuration.container_port_ranges[0].from_port #=> Integer
|
1608
|
+
# resp.container_group_definition.support_container_definitions[0].port_configuration.container_port_ranges[0].to_port #=> Integer
|
1609
|
+
# resp.container_group_definition.support_container_definitions[0].port_configuration.container_port_ranges[0].protocol #=> String, one of "TCP", "UDP"
|
1610
|
+
# resp.container_group_definition.support_container_definitions[0].resolved_image_digest #=> String
|
1611
|
+
# resp.container_group_definition.support_container_definitions[0].vcpu #=> Float
|
1612
|
+
# resp.container_group_definition.version_number #=> Integer
|
1613
|
+
# resp.container_group_definition.version_description #=> String
|
1120
1614
|
# resp.container_group_definition.status #=> String, one of "READY", "COPYING", "FAILED"
|
1121
1615
|
# resp.container_group_definition.status_reason #=> String
|
1122
1616
|
#
|
@@ -1129,9 +1623,6 @@ module Aws::GameLift
|
|
1129
1623
|
req.send_request(options)
|
1130
1624
|
end
|
1131
1625
|
|
1132
|
-
# **This operation has been expanded to use with the Amazon GameLift
|
1133
|
-
# containers feature, which is currently in public preview.**
|
1134
|
-
#
|
1135
1626
|
# Creates a fleet of compute resources to host your game servers. Use
|
1136
1627
|
# this operation to set up the following types of fleets based on
|
1137
1628
|
# compute type:
|
@@ -1173,40 +1664,6 @@ module Aws::GameLift
|
|
1173
1664
|
# When the fleet status is ACTIVE, you can adjust capacity settings and
|
1174
1665
|
# turn autoscaling on/off for each location.
|
1175
1666
|
#
|
1176
|
-
# **Managed container fleet**
|
1177
|
-
#
|
1178
|
-
# A container fleet is a set of Amazon Elastic Compute Cloud (Amazon
|
1179
|
-
# EC2) instances. Your container architecture is deployed to each fleet
|
1180
|
-
# instance based on the fleet configuration. Amazon GameLift manages the
|
1181
|
-
# containers on each fleet instance and controls the lifecycle of game
|
1182
|
-
# server processes, which host game sessions for players. Container
|
1183
|
-
# fleets can have instances in multiple locations. Each container on an
|
1184
|
-
# instance that runs game server processes is registered as a `Compute`.
|
1185
|
-
#
|
1186
|
-
# To create a container fleet, provide these required parameters:
|
1187
|
-
#
|
1188
|
-
# * `ComputeType` set to `CONTAINER`
|
1189
|
-
#
|
1190
|
-
# * `ContainerGroupsConfiguration`
|
1191
|
-
#
|
1192
|
-
# * `EC2InboundPermissions`
|
1193
|
-
#
|
1194
|
-
# * `EC2InstanceType`
|
1195
|
-
#
|
1196
|
-
# * `FleetType` set to `ON_DEMAND`
|
1197
|
-
#
|
1198
|
-
# * `Name`
|
1199
|
-
#
|
1200
|
-
# * `RuntimeConfiguration` with at least one `ServerProcesses`
|
1201
|
-
# configuration
|
1202
|
-
#
|
1203
|
-
# If successful, this operation creates a new fleet resource and places
|
1204
|
-
# it in `NEW` status while Amazon GameLift initiates the [fleet creation
|
1205
|
-
# workflow][1].
|
1206
|
-
#
|
1207
|
-
# When the fleet status is ACTIVE, you can adjust capacity settings and
|
1208
|
-
# turn autoscaling on/off for each location.
|
1209
|
-
#
|
1210
1667
|
# **Anywhere fleet**
|
1211
1668
|
#
|
1212
1669
|
# An Anywhere fleet represents compute resources that are not owned or
|
@@ -1230,9 +1687,7 @@ module Aws::GameLift
|
|
1230
1687
|
#
|
1231
1688
|
# [Setting up fleets][2]
|
1232
1689
|
#
|
1233
|
-
# [
|
1234
|
-
#
|
1235
|
-
# [Debug fleet creation issues][4]
|
1690
|
+
# [Debug fleet creation issues][3]
|
1236
1691
|
#
|
1237
1692
|
# [Multi-location fleets][2]
|
1238
1693
|
#
|
@@ -1240,8 +1695,7 @@ module Aws::GameLift
|
|
1240
1695
|
#
|
1241
1696
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow
|
1242
1697
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
1243
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/
|
1244
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation
|
1698
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation
|
1245
1699
|
#
|
1246
1700
|
# @option params [required, String] :name
|
1247
1701
|
# A descriptive label that is associated with a fleet. Fleet names do
|
@@ -1287,8 +1741,8 @@ module Aws::GameLift
|
|
1287
1741
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize
|
1288
1742
|
#
|
1289
1743
|
# @option params [String] :ec2_instance_type
|
1290
|
-
# The Amazon GameLift-supported Amazon EC2 instance type to use with
|
1291
|
-
#
|
1744
|
+
# The Amazon GameLift-supported Amazon EC2 instance type to use with
|
1745
|
+
# managed EC2 fleets. Instance type determines the computing resources
|
1292
1746
|
# that will be used to host your game servers, including CPU, memory,
|
1293
1747
|
# storage, and networking capacity. See [Amazon Elastic Compute Cloud
|
1294
1748
|
# Instance Types][1] for detailed descriptions of Amazon EC2 instance
|
@@ -1301,19 +1755,14 @@ module Aws::GameLift
|
|
1301
1755
|
# @option params [Array<Types::IpPermission>] :ec2_inbound_permissions
|
1302
1756
|
# The IP address ranges and port settings that allow inbound traffic to
|
1303
1757
|
# access game server processes and other processes on this fleet. Set
|
1304
|
-
# this parameter for EC2
|
1305
|
-
#
|
1758
|
+
# this parameter for managed EC2 fleets. You can leave this parameter
|
1759
|
+
# empty when creating the fleet, but you must call
|
1306
1760
|
# UpdateFleetPortSettings to set it before players can connect to game
|
1307
1761
|
# sessions. As a best practice, we recommend opening ports for remote
|
1308
1762
|
# access only when you need them and closing them when you're finished.
|
1309
1763
|
# For Realtime Servers fleets, Amazon GameLift automatically sets TCP
|
1310
1764
|
# and UDP ranges.
|
1311
1765
|
#
|
1312
|
-
# To manage inbound access for a container fleet, set this parameter to
|
1313
|
-
# the same port numbers that you set for the fleet's connection port
|
1314
|
-
# range. During the life of the fleet, update this parameter to control
|
1315
|
-
# which connection ports are open to inbound traffic.
|
1316
|
-
#
|
1317
1766
|
# @option params [String] :new_game_session_protection_policy
|
1318
1767
|
# The status of termination protection for active game sessions on the
|
1319
1768
|
# fleet. By default, this property is set to `NoProtection`. You can
|
@@ -1329,10 +1778,10 @@ module Aws::GameLift
|
|
1329
1778
|
#
|
1330
1779
|
# @option params [Types::RuntimeConfiguration] :runtime_configuration
|
1331
1780
|
# Instructions for how to launch and run server processes on the fleet.
|
1332
|
-
# Set runtime configuration for EC2 fleets
|
1333
|
-
#
|
1334
|
-
#
|
1335
|
-
#
|
1781
|
+
# Set runtime configuration for managed EC2 fleets. For an Anywhere
|
1782
|
+
# fleets, set this parameter only if the fleet is running the Amazon
|
1783
|
+
# GameLift Agent. The runtime configuration defines one or more server
|
1784
|
+
# process configurations. Each server process identifies a game
|
1336
1785
|
# executable or Realtime script file and the number of processes to run
|
1337
1786
|
# concurrently.
|
1338
1787
|
#
|
@@ -1383,19 +1832,20 @@ module Aws::GameLift
|
|
1383
1832
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot
|
1384
1833
|
#
|
1385
1834
|
# @option params [String] :instance_role_arn
|
1386
|
-
# A unique identifier for an IAM role
|
1387
|
-
#
|
1388
|
-
# in
|
1389
|
-
#
|
1390
|
-
#
|
1391
|
-
#
|
1392
|
-
#
|
1393
|
-
#
|
1394
|
-
# created.
|
1835
|
+
# A unique identifier for an IAM role that manages access to your Amazon
|
1836
|
+
# Web Services services. With an instance role ARN set, any application
|
1837
|
+
# that runs on an instance in this fleet can assume the role, including
|
1838
|
+
# install scripts, server processes, and daemons (background processes).
|
1839
|
+
# Create a role or look up a role's ARN by using the [IAM dashboard][1]
|
1840
|
+
# in the Amazon Web Services Management Console. Learn more about using
|
1841
|
+
# on-box credentials for your game servers at [ Access external
|
1842
|
+
# resources from a game server][2]. This fleet property can't be
|
1843
|
+
# changed after the fleet is created.
|
1395
1844
|
#
|
1396
1845
|
#
|
1397
1846
|
#
|
1398
|
-
# [1]: https://
|
1847
|
+
# [1]: https://console.aws.amazon.com/iam/
|
1848
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html
|
1399
1849
|
#
|
1400
1850
|
# @option params [Types::CertificateConfiguration] :certificate_configuration
|
1401
1851
|
# Prompts Amazon GameLift to generate a TLS/SSL certificate for the
|
@@ -1455,15 +1905,10 @@ module Aws::GameLift
|
|
1455
1905
|
# * `EC2` – The game server build is deployed to Amazon EC2 instances
|
1456
1906
|
# for cloud hosting. This is the default setting.
|
1457
1907
|
#
|
1458
|
-
# * `
|
1459
|
-
#
|
1460
|
-
#
|
1461
|
-
#
|
1462
|
-
#
|
1463
|
-
# * `ANYWHERE` – Game servers or container images with your game server
|
1464
|
-
# and supporting software are deployed to compute resources that are
|
1465
|
-
# provided and managed by you. With this compute type, you can also
|
1466
|
-
# set the `AnywhereConfiguration` parameter.
|
1908
|
+
# * `ANYWHERE` – Your game server and supporting software is deployed to
|
1909
|
+
# compute resources that are provided and managed by you. With this
|
1910
|
+
# compute type, you can also set the `AnywhereConfiguration`
|
1911
|
+
# parameter.
|
1467
1912
|
#
|
1468
1913
|
# @option params [Types::AnywhereConfiguration] :anywhere_configuration
|
1469
1914
|
# Amazon GameLift Anywhere configuration options.
|
@@ -1482,14 +1927,6 @@ module Aws::GameLift
|
|
1482
1927
|
#
|
1483
1928
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html
|
1484
1929
|
#
|
1485
|
-
# @option params [Types::ContainerGroupsConfiguration] :container_groups_configuration
|
1486
|
-
# The container groups to deploy to instances in the container fleet and
|
1487
|
-
# other fleet-level configuration settings. Use the
|
1488
|
-
# CreateContainerGroupDefinition action to create container groups. A
|
1489
|
-
# container fleet must have exactly one replica container group, and can
|
1490
|
-
# optionally have one daemon container group. You can't change this
|
1491
|
-
# property after you create the fleet.
|
1492
|
-
#
|
1493
1930
|
# @return [Types::CreateFleetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1494
1931
|
#
|
1495
1932
|
# * {Types::CreateFleetOutput#fleet_attributes #fleet_attributes} => Types::FleetAttributes
|
@@ -1549,19 +1986,11 @@ module Aws::GameLift
|
|
1549
1986
|
# value: "TagValue", # required
|
1550
1987
|
# },
|
1551
1988
|
# ],
|
1552
|
-
# compute_type: "EC2", # accepts EC2, ANYWHERE
|
1989
|
+
# compute_type: "EC2", # accepts EC2, ANYWHERE
|
1553
1990
|
# anywhere_configuration: {
|
1554
1991
|
# cost: "NonNegativeLimitedLengthDouble", # required
|
1555
1992
|
# },
|
1556
1993
|
# instance_role_credentials_provider: "SHARED_CREDENTIAL_FILE", # accepts SHARED_CREDENTIAL_FILE
|
1557
|
-
# container_groups_configuration: {
|
1558
|
-
# container_group_definition_names: ["ContainerGroupDefinitionNameOrArn"], # required
|
1559
|
-
# connection_port_range: { # required
|
1560
|
-
# from_port: 1, # required
|
1561
|
-
# to_port: 1, # required
|
1562
|
-
# },
|
1563
|
-
# desired_replica_container_groups_per_instance: 1,
|
1564
|
-
# },
|
1565
1994
|
# })
|
1566
1995
|
#
|
1567
1996
|
# @example Response structure
|
@@ -1593,16 +2022,9 @@ module Aws::GameLift
|
|
1593
2022
|
# resp.fleet_attributes.stopped_actions[0] #=> String, one of "AUTO_SCALING"
|
1594
2023
|
# resp.fleet_attributes.instance_role_arn #=> String
|
1595
2024
|
# resp.fleet_attributes.certificate_configuration.certificate_type #=> String, one of "DISABLED", "GENERATED"
|
1596
|
-
# resp.fleet_attributes.compute_type #=> String, one of "EC2", "ANYWHERE"
|
2025
|
+
# resp.fleet_attributes.compute_type #=> String, one of "EC2", "ANYWHERE"
|
1597
2026
|
# resp.fleet_attributes.anywhere_configuration.cost #=> String
|
1598
2027
|
# resp.fleet_attributes.instance_role_credentials_provider #=> String, one of "SHARED_CREDENTIAL_FILE"
|
1599
|
-
# resp.fleet_attributes.container_groups_attributes.container_group_definition_properties #=> Array
|
1600
|
-
# resp.fleet_attributes.container_groups_attributes.container_group_definition_properties[0].scheduling_strategy #=> String, one of "REPLICA", "DAEMON"
|
1601
|
-
# resp.fleet_attributes.container_groups_attributes.container_group_definition_properties[0].container_group_definition_name #=> String
|
1602
|
-
# resp.fleet_attributes.container_groups_attributes.connection_port_range.from_port #=> Integer
|
1603
|
-
# resp.fleet_attributes.container_groups_attributes.connection_port_range.to_port #=> Integer
|
1604
|
-
# resp.fleet_attributes.container_groups_attributes.container_groups_per_instance.desired_replica_container_groups_per_instance #=> Integer
|
1605
|
-
# resp.fleet_attributes.container_groups_attributes.container_groups_per_instance.max_replica_container_groups_per_instance #=> Integer
|
1606
2028
|
# resp.location_states #=> Array
|
1607
2029
|
# resp.location_states[0].location #=> String
|
1608
2030
|
# resp.location_states[0].status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED", "NOT_FOUND"
|
@@ -1616,13 +2038,10 @@ module Aws::GameLift
|
|
1616
2038
|
req.send_request(options)
|
1617
2039
|
end
|
1618
2040
|
|
1619
|
-
#
|
1620
|
-
#
|
1621
|
-
#
|
1622
|
-
#
|
1623
|
-
# populating the new locations with instances. The new instances conform
|
1624
|
-
# to the fleet's instance type, auto-scaling, and other configuration
|
1625
|
-
# settings.
|
2041
|
+
# Adds remote locations to a managed EC2 fleet or managed container
|
2042
|
+
# fleet and begins populating the new locations with instances. The new
|
2043
|
+
# instances conform to the fleet's instance type, auto-scaling, and
|
2044
|
+
# other configuration settings.
|
1626
2045
|
#
|
1627
2046
|
# <note markdown="1"> You can't add remote locations to a fleet that resides in an Amazon
|
1628
2047
|
# Web Services Region that doesn't support multiple locations. Fleets
|
@@ -2062,7 +2481,8 @@ module Aws::GameLift
|
|
2062
2481
|
# @option params [String] :game_session_data
|
2063
2482
|
# A set of custom game session properties, formatted as a single string
|
2064
2483
|
# value. This data is passed to a game server process with a request to
|
2065
|
-
# start a new game session
|
2484
|
+
# start a new game session. For more information, see [Start a game
|
2485
|
+
# session][1].
|
2066
2486
|
#
|
2067
2487
|
#
|
2068
2488
|
#
|
@@ -2197,17 +2617,14 @@ module Aws::GameLift
|
|
2197
2617
|
# @option params [Integer] :timeout_in_seconds
|
2198
2618
|
# The maximum time, in seconds, that a new game session placement
|
2199
2619
|
# request remains in the queue. When a request exceeds this time, the
|
2200
|
-
# game session placement changes to a `TIMED_OUT` status.
|
2201
|
-
# this property is set to `600`.
|
2620
|
+
# game session placement changes to a `TIMED_OUT` status.
|
2202
2621
|
#
|
2203
2622
|
# @option params [Array<Types::PlayerLatencyPolicy>] :player_latency_policies
|
2204
|
-
# A set of policies that
|
2205
|
-
#
|
2206
|
-
#
|
2207
|
-
#
|
2208
|
-
#
|
2209
|
-
# applied based on their maximum allowed latency, starting with the
|
2210
|
-
# lowest value.
|
2623
|
+
# A set of policies that enforce a sliding cap on player latency when
|
2624
|
+
# processing game sessions placement requests. Use multiple policies to
|
2625
|
+
# gradually relax the cap over time if Amazon GameLift can't make a
|
2626
|
+
# placement. Policies are evaluated in order starting with the lowest
|
2627
|
+
# maximum latency value.
|
2211
2628
|
#
|
2212
2629
|
# @option params [Array<Types::GameSessionQueueDestination>] :destinations
|
2213
2630
|
# A list of fleets and/or fleet aliases that can be used to fulfill game
|
@@ -2454,10 +2871,9 @@ module Aws::GameLift
|
|
2454
2871
|
# @option params [Integer] :additional_player_count
|
2455
2872
|
# The number of player slots in a match to keep open for future players.
|
2456
2873
|
# For example, if the configuration's rule set specifies a match for a
|
2457
|
-
# single
|
2458
|
-
# players
|
2459
|
-
#
|
2460
|
-
# is set to `STANDALONE`.
|
2874
|
+
# single 12-person team, and the additional player count is set to 2,
|
2875
|
+
# only 10 players are selected for the match. This parameter is not used
|
2876
|
+
# if `FlexMatchMode` is set to `STANDALONE`.
|
2461
2877
|
#
|
2462
2878
|
# @option params [String] :custom_event_data
|
2463
2879
|
# Information to be added to all events related to this matchmaking
|
@@ -2473,10 +2889,10 @@ module Aws::GameLift
|
|
2473
2889
|
# @option params [String] :game_session_data
|
2474
2890
|
# A set of custom game session properties, formatted as a single string
|
2475
2891
|
# value. This data is passed to a game server process with a request to
|
2476
|
-
# start a new game session
|
2477
|
-
# information is added to the new `GameSession` object
|
2478
|
-
# for a successful match. This parameter is not used if
|
2479
|
-
# is set to `STANDALONE`.
|
2892
|
+
# start a new game session. For more information, see [Start a game
|
2893
|
+
# session][1]. This information is added to the new `GameSession` object
|
2894
|
+
# that is created for a successful match. This parameter is not used if
|
2895
|
+
# `FlexMatchMode` is set to `STANDALONE`.
|
2480
2896
|
#
|
2481
2897
|
#
|
2482
2898
|
#
|
@@ -2829,16 +3245,16 @@ module Aws::GameLift
|
|
2829
3245
|
req.send_request(options)
|
2830
3246
|
end
|
2831
3247
|
|
2832
|
-
# Creates a
|
2833
|
-
# scripts are JavaScript that provide configuration settings and
|
2834
|
-
# optional custom game logic for your game.
|
2835
|
-
#
|
2836
|
-
#
|
3248
|
+
# Creates a script resource for your Realtime Servers script. Realtime
|
3249
|
+
# scripts are JavaScript files that provide configuration settings and
|
3250
|
+
# optional custom game logic for your game. Script logic is executed
|
3251
|
+
# during an active game session. To deploy Realtime Servers for hosting,
|
3252
|
+
# create an Amazon GameLift managed fleet with the script.
|
2837
3253
|
#
|
2838
|
-
# To create a
|
2839
|
-
# script file(s). The script files and all dependencies must be
|
2840
|
-
# into a single file. You can
|
2841
|
-
# locations:
|
3254
|
+
# To create a script resource, specify a script name and provide the
|
3255
|
+
# script file(s). The script files and all dependencies must be combined
|
3256
|
+
# into a single .zip file. You can upload the .zip file from either of
|
3257
|
+
# these locations:
|
2842
3258
|
#
|
2843
3259
|
# * A locally available directory. Use the *ZipFile* parameter for this
|
2844
3260
|
# option.
|
@@ -2849,12 +3265,9 @@ module Aws::GameLift
|
|
2849
3265
|
# (IAM) role that allows the Amazon GameLift service to access your S3
|
2850
3266
|
# bucket.
|
2851
3267
|
#
|
2852
|
-
# If the call is successful, a new script
|
2853
|
-
# unique script ID.
|
2854
|
-
#
|
2855
|
-
# record's storage location reflects this location. If the script file
|
2856
|
-
# is provided as an S3 bucket, Amazon GameLift accesses the file at this
|
2857
|
-
# storage location as needed for deployment.
|
3268
|
+
# If the call is successful, Amazon GameLift creates a new script
|
3269
|
+
# resource with a unique script ID. The script is uploaded to an Amazon
|
3270
|
+
# S3 bucket that is owned by Amazon GameLift.
|
2858
3271
|
#
|
2859
3272
|
# **Learn more**
|
2860
3273
|
#
|
@@ -2873,8 +3286,8 @@ module Aws::GameLift
|
|
2873
3286
|
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
2874
3287
|
#
|
2875
3288
|
# @option params [String] :name
|
2876
|
-
# A descriptive label that is associated with a script. Script names
|
2877
|
-
#
|
3289
|
+
# A descriptive label that is associated with a script. Script names do
|
3290
|
+
# not need to be unique. You can use [UpdateScript][1] to change this
|
2878
3291
|
# value later.
|
2879
3292
|
#
|
2880
3293
|
#
|
@@ -2882,9 +3295,9 @@ module Aws::GameLift
|
|
2882
3295
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html
|
2883
3296
|
#
|
2884
3297
|
# @option params [String] :version
|
2885
|
-
# Version information associated with a build or script. Version
|
2886
|
-
#
|
2887
|
-
# value later.
|
3298
|
+
# Version information that is associated with a build or script. Version
|
3299
|
+
# strings do not need to be unique. You can use [UpdateScript][1] to
|
3300
|
+
# change this value later.
|
2888
3301
|
#
|
2889
3302
|
#
|
2890
3303
|
#
|
@@ -3215,15 +3628,60 @@ module Aws::GameLift
|
|
3215
3628
|
req.send_request(options)
|
3216
3629
|
end
|
3217
3630
|
|
3218
|
-
#
|
3219
|
-
#
|
3631
|
+
# Deletes all resources and information related to a container fleet and
|
3632
|
+
# shuts down currently running fleet instances, including those in
|
3633
|
+
# remote locations. The container fleet must be in `ACTIVE` status to be
|
3634
|
+
# deleted.
|
3635
|
+
#
|
3636
|
+
# To delete a fleet, specify the fleet ID to be terminated. During the
|
3637
|
+
# deletion process, the fleet status is changed to `DELETING`.
|
3638
|
+
#
|
3639
|
+
# **Learn more**
|
3640
|
+
#
|
3641
|
+
# [Setting up Amazon GameLift Fleets][1]
|
3642
|
+
#
|
3643
|
+
#
|
3644
|
+
#
|
3645
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3646
|
+
#
|
3647
|
+
# @option params [required, String] :fleet_id
|
3648
|
+
# A unique identifier for the container fleet to delete. You can use
|
3649
|
+
# either the fleet ID or ARN value.
|
3650
|
+
#
|
3651
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3652
|
+
#
|
3653
|
+
# @example Request syntax with placeholder values
|
3654
|
+
#
|
3655
|
+
# resp = client.delete_container_fleet({
|
3656
|
+
# fleet_id: "FleetIdOrArn", # required
|
3657
|
+
# })
|
3658
|
+
#
|
3659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteContainerFleet AWS API Documentation
|
3660
|
+
#
|
3661
|
+
# @overload delete_container_fleet(params = {})
|
3662
|
+
# @param [Hash] params ({})
|
3663
|
+
def delete_container_fleet(params = {}, options = {})
|
3664
|
+
req = build_request(:delete_container_fleet, params)
|
3665
|
+
req.send_request(options)
|
3666
|
+
end
|
3667
|
+
|
3668
|
+
# Deletes a container group definition. You can delete a container group
|
3669
|
+
# definition if there are no fleets using the definition.
|
3670
|
+
#
|
3671
|
+
# **Request options:**
|
3220
3672
|
#
|
3221
|
-
#
|
3222
|
-
# container group definition
|
3223
|
-
#
|
3673
|
+
# * Delete an entire container group definition, including all versions.
|
3674
|
+
# Specify the container group definition name, or use an ARN value
|
3675
|
+
# without the version number.
|
3224
3676
|
#
|
3225
|
-
#
|
3226
|
-
#
|
3677
|
+
# * Delete a particular version. Specify the container group definition
|
3678
|
+
# name and a version number, or use an ARN value that includes the
|
3679
|
+
# version number.
|
3680
|
+
#
|
3681
|
+
# * Keep the newest versions and delete all older versions. Specify the
|
3682
|
+
# container group definition name and the number of versions to
|
3683
|
+
# retain. For example, set `VersionCountToRetain` to 5 to delete all
|
3684
|
+
# but the five most recent versions.
|
3227
3685
|
#
|
3228
3686
|
# **Learn more**
|
3229
3687
|
#
|
@@ -3239,12 +3697,21 @@ module Aws::GameLift
|
|
3239
3697
|
# The unique identifier for the container group definition to delete.
|
3240
3698
|
# You can use either the `Name` or `ARN` value.
|
3241
3699
|
#
|
3700
|
+
# @option params [Integer] :version_number
|
3701
|
+
# The specific version to delete.
|
3702
|
+
#
|
3703
|
+
# @option params [Integer] :version_count_to_retain
|
3704
|
+
# The number of most recent versions to keep while deleting all older
|
3705
|
+
# versions.
|
3706
|
+
#
|
3242
3707
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3243
3708
|
#
|
3244
3709
|
# @example Request syntax with placeholder values
|
3245
3710
|
#
|
3246
3711
|
# resp = client.delete_container_group_definition({
|
3247
3712
|
# name: "ContainerGroupDefinitionNameOrArn", # required
|
3713
|
+
# version_number: 1,
|
3714
|
+
# version_count_to_retain: 1,
|
3248
3715
|
# })
|
3249
3716
|
#
|
3250
3717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteContainerGroupDefinition AWS API Documentation
|
@@ -3748,17 +4215,14 @@ module Aws::GameLift
|
|
3748
4215
|
req.send_request(options)
|
3749
4216
|
end
|
3750
4217
|
|
3751
|
-
#
|
3752
|
-
#
|
3753
|
-
#
|
3754
|
-
# Removes a compute resource from an Amazon GameLift Anywhere fleet or
|
3755
|
-
# container fleet. Deregistered computes can no longer host game
|
3756
|
-
# sessions through Amazon GameLift.
|
4218
|
+
# Removes a compute resource from an Amazon GameLift Anywhere fleet.
|
4219
|
+
# Deregistered computes can no longer host game sessions through Amazon
|
4220
|
+
# GameLift.
|
3757
4221
|
#
|
3758
|
-
# For an Anywhere fleet
|
3759
|
-
#
|
3760
|
-
#
|
3761
|
-
#
|
4222
|
+
# For an Anywhere fleet that's running the Amazon GameLift Agent, the
|
4223
|
+
# Agent handles all compute registry tasks for you. For an Anywhere
|
4224
|
+
# fleet that doesn't use the Agent, call this operation to deregister
|
4225
|
+
# fleet computes.
|
3762
4226
|
#
|
3763
4227
|
# To deregister a compute, call this operation from the compute that's
|
3764
4228
|
# being deregistered and specify the compute name and the fleet ID.
|
@@ -3769,10 +4233,7 @@ module Aws::GameLift
|
|
3769
4233
|
#
|
3770
4234
|
# @option params [required, String] :compute_name
|
3771
4235
|
# The unique identifier of the compute resource to deregister. For an
|
3772
|
-
# Anywhere fleet compute, use the registered compute name.
|
3773
|
-
# container fleet, use the compute name (for example,
|
3774
|
-
# `a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9`)
|
3775
|
-
# or the compute ARN.
|
4236
|
+
# Anywhere fleet compute, use the registered compute name.
|
3776
4237
|
#
|
3777
4238
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3778
4239
|
#
|
@@ -3937,9 +4398,6 @@ module Aws::GameLift
|
|
3937
4398
|
req.send_request(options)
|
3938
4399
|
end
|
3939
4400
|
|
3940
|
-
# **This operation has been expanded to use with the Amazon GameLift
|
3941
|
-
# containers feature, which is currently in public preview.**
|
3942
|
-
#
|
3943
4401
|
# Retrieves properties for a compute resource in an Amazon GameLift
|
3944
4402
|
# fleet. To get a list of all computes in a fleet, call ListCompute.
|
3945
4403
|
#
|
@@ -3950,16 +4408,12 @@ module Aws::GameLift
|
|
3950
4408
|
# compute resource. Depending on the fleet's compute type, the result
|
3951
4409
|
# includes the following information:
|
3952
4410
|
#
|
3953
|
-
# * For
|
3954
|
-
# instance.
|
4411
|
+
# * For managed EC2 fleets, this operation returns information about the
|
4412
|
+
# EC2 instance.
|
3955
4413
|
#
|
3956
|
-
# * For
|
4414
|
+
# * For Anywhere fleets, this operation returns information about the
|
3957
4415
|
# registered compute.
|
3958
4416
|
#
|
3959
|
-
# * For `CONTAINER` fleets, this operation returns information about the
|
3960
|
-
# container that's registered as a compute, and the instance it's
|
3961
|
-
# running on. The compute name is the container name.
|
3962
|
-
#
|
3963
4417
|
# @option params [required, String] :fleet_id
|
3964
4418
|
# A unique identifier for the fleet that the compute belongs to. You can
|
3965
4419
|
# use either the fleet ID or ARN value.
|
@@ -3967,10 +4421,7 @@ module Aws::GameLift
|
|
3967
4421
|
# @option params [required, String] :compute_name
|
3968
4422
|
# The unique identifier of the compute resource to retrieve properties
|
3969
4423
|
# for. For an Anywhere fleet compute, use the registered compute name.
|
3970
|
-
# For an EC2 fleet instance, use the instance ID.
|
3971
|
-
# use the compute name (for example,
|
3972
|
-
# `a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9`)
|
3973
|
-
# or the compute ARN.
|
4424
|
+
# For an EC2 fleet instance, use the instance ID.
|
3974
4425
|
#
|
3975
4426
|
# @return [Types::DescribeComputeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3976
4427
|
#
|
@@ -3991,7 +4442,7 @@ module Aws::GameLift
|
|
3991
4442
|
# resp.compute.compute_arn #=> String
|
3992
4443
|
# resp.compute.ip_address #=> String
|
3993
4444
|
# resp.compute.dns_name #=> String
|
3994
|
-
# resp.compute.compute_status #=> String, one of "PENDING", "ACTIVE", "TERMINATING"
|
4445
|
+
# resp.compute.compute_status #=> String, one of "PENDING", "ACTIVE", "TERMINATING", "IMPAIRED"
|
3995
4446
|
# resp.compute.location #=> String
|
3996
4447
|
# resp.compute.creation_time #=> Time
|
3997
4448
|
# resp.compute.operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2", "WINDOWS_2016", "AMAZON_LINUX_2023"
|
@@ -3999,10 +4450,10 @@ module Aws::GameLift
|
|
3999
4450
|
# resp.compute.game_lift_service_sdk_endpoint #=> String
|
4000
4451
|
# resp.compute.game_lift_agent_endpoint #=> String
|
4001
4452
|
# resp.compute.instance_id #=> String
|
4002
|
-
# resp.compute.container_attributes
|
4003
|
-
# resp.compute.container_attributes
|
4004
|
-
# resp.compute.container_attributes
|
4005
|
-
# resp.compute.
|
4453
|
+
# resp.compute.container_attributes #=> Array
|
4454
|
+
# resp.compute.container_attributes[0].container_name #=> String
|
4455
|
+
# resp.compute.container_attributes[0].container_runtime_id #=> String
|
4456
|
+
# resp.compute.game_server_container_group_definition_arn #=> String
|
4006
4457
|
#
|
4007
4458
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeCompute AWS API Documentation
|
4008
4459
|
#
|
@@ -4013,15 +4464,105 @@ module Aws::GameLift
|
|
4013
4464
|
req.send_request(options)
|
4014
4465
|
end
|
4015
4466
|
|
4016
|
-
#
|
4017
|
-
#
|
4467
|
+
# Retrieves the properties for a container fleet. When requesting
|
4468
|
+
# attributes for multiple fleets, use the pagination parameters to
|
4469
|
+
# retrieve results as a set of sequential pages.
|
4018
4470
|
#
|
4471
|
+
# **Request options**
|
4472
|
+
#
|
4473
|
+
# * Get container fleet properties for a single fleet. Provide either
|
4474
|
+
# the fleet ID or ARN value.
|
4475
|
+
#
|
4476
|
+
# ^
|
4477
|
+
#
|
4478
|
+
# **Results**
|
4479
|
+
#
|
4480
|
+
# If successful, a `ContainerFleet` object is returned. This object
|
4481
|
+
# includes the fleet properties, including information about the most
|
4482
|
+
# recent deployment.
|
4483
|
+
#
|
4484
|
+
# <note markdown="1"> Some API operations limit the number of fleet IDs that allowed in one
|
4485
|
+
# request. If a request exceeds this limit, the request fails and the
|
4486
|
+
# error message contains the maximum allowed number.
|
4487
|
+
#
|
4488
|
+
# </note>
|
4489
|
+
#
|
4490
|
+
# @option params [required, String] :fleet_id
|
4491
|
+
# A unique identifier for the container fleet to retrieve. You can use
|
4492
|
+
# either the fleet ID or ARN value.
|
4493
|
+
#
|
4494
|
+
# @return [Types::DescribeContainerFleetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4495
|
+
#
|
4496
|
+
# * {Types::DescribeContainerFleetOutput#container_fleet #container_fleet} => Types::ContainerFleet
|
4497
|
+
#
|
4498
|
+
# @example Request syntax with placeholder values
|
4499
|
+
#
|
4500
|
+
# resp = client.describe_container_fleet({
|
4501
|
+
# fleet_id: "FleetIdOrArn", # required
|
4502
|
+
# })
|
4503
|
+
#
|
4504
|
+
# @example Response structure
|
4505
|
+
#
|
4506
|
+
# resp.container_fleet.fleet_id #=> String
|
4507
|
+
# resp.container_fleet.fleet_arn #=> String
|
4508
|
+
# resp.container_fleet.fleet_role_arn #=> String
|
4509
|
+
# resp.container_fleet.game_server_container_group_definition_name #=> String
|
4510
|
+
# resp.container_fleet.game_server_container_group_definition_arn #=> String
|
4511
|
+
# resp.container_fleet.per_instance_container_group_definition_name #=> String
|
4512
|
+
# resp.container_fleet.per_instance_container_group_definition_arn #=> String
|
4513
|
+
# resp.container_fleet.instance_connection_port_range.from_port #=> Integer
|
4514
|
+
# resp.container_fleet.instance_connection_port_range.to_port #=> Integer
|
4515
|
+
# resp.container_fleet.instance_inbound_permissions #=> Array
|
4516
|
+
# resp.container_fleet.instance_inbound_permissions[0].from_port #=> Integer
|
4517
|
+
# resp.container_fleet.instance_inbound_permissions[0].to_port #=> Integer
|
4518
|
+
# resp.container_fleet.instance_inbound_permissions[0].ip_range #=> String
|
4519
|
+
# resp.container_fleet.instance_inbound_permissions[0].protocol #=> String, one of "TCP", "UDP"
|
4520
|
+
# resp.container_fleet.game_server_container_groups_per_instance #=> Integer
|
4521
|
+
# resp.container_fleet.maximum_game_server_container_groups_per_instance #=> Integer
|
4522
|
+
# resp.container_fleet.instance_type #=> String
|
4523
|
+
# resp.container_fleet.billing_type #=> String, one of "ON_DEMAND", "SPOT"
|
4524
|
+
# resp.container_fleet.description #=> String
|
4525
|
+
# resp.container_fleet.creation_time #=> Time
|
4526
|
+
# resp.container_fleet.metric_groups #=> Array
|
4527
|
+
# resp.container_fleet.metric_groups[0] #=> String
|
4528
|
+
# resp.container_fleet.new_game_session_protection_policy #=> String, one of "NoProtection", "FullProtection"
|
4529
|
+
# resp.container_fleet.game_session_creation_limit_policy.new_game_sessions_per_creator #=> Integer
|
4530
|
+
# resp.container_fleet.game_session_creation_limit_policy.policy_period_in_minutes #=> Integer
|
4531
|
+
# resp.container_fleet.status #=> String, one of "PENDING", "CREATING", "CREATED", "ACTIVATING", "ACTIVE", "UPDATING", "DELETING"
|
4532
|
+
# resp.container_fleet.deployment_details.latest_deployment_id #=> String
|
4533
|
+
# resp.container_fleet.log_configuration.log_destination #=> String, one of "NONE", "CLOUDWATCH", "S3"
|
4534
|
+
# resp.container_fleet.log_configuration.s3_bucket_name #=> String
|
4535
|
+
# resp.container_fleet.log_configuration.log_group_arn #=> String
|
4536
|
+
# resp.container_fleet.location_attributes #=> Array
|
4537
|
+
# resp.container_fleet.location_attributes[0].location #=> String
|
4538
|
+
# resp.container_fleet.location_attributes[0].status #=> String, one of "PENDING", "CREATING", "CREATED", "ACTIVATING", "ACTIVE", "UPDATING", "DELETING"
|
4539
|
+
#
|
4540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeContainerFleet AWS API Documentation
|
4541
|
+
#
|
4542
|
+
# @overload describe_container_fleet(params = {})
|
4543
|
+
# @param [Hash] params ({})
|
4544
|
+
def describe_container_fleet(params = {}, options = {})
|
4545
|
+
req = build_request(:describe_container_fleet, params)
|
4546
|
+
req.send_request(options)
|
4547
|
+
end
|
4548
|
+
|
4019
4549
|
# Retrieves the properties of a container group definition, including
|
4020
4550
|
# all container definitions in the group.
|
4021
4551
|
#
|
4022
|
-
#
|
4023
|
-
#
|
4024
|
-
#
|
4552
|
+
# **Request options:**
|
4553
|
+
#
|
4554
|
+
# * Retrieve the latest version of a container group definition. Specify
|
4555
|
+
# the container group definition name only, or use an ARN value
|
4556
|
+
# without a version number.
|
4557
|
+
#
|
4558
|
+
# * Retrieve a particular version. Specify the container group
|
4559
|
+
# definition name and a version number, or use an ARN value that
|
4560
|
+
# includes the version number.
|
4561
|
+
#
|
4562
|
+
# **Results:**
|
4563
|
+
#
|
4564
|
+
# If successful, this operation returns the complete properties of a
|
4565
|
+
# container group definition version.
|
4025
4566
|
#
|
4026
4567
|
# **Learn more**
|
4027
4568
|
#
|
@@ -4037,6 +4578,9 @@ module Aws::GameLift
|
|
4037
4578
|
# The unique identifier for the container group definition to retrieve
|
4038
4579
|
# properties for. You can use either the `Name` or `ARN` value.
|
4039
4580
|
#
|
4581
|
+
# @option params [Integer] :version_number
|
4582
|
+
# The specific version to retrieve.
|
4583
|
+
#
|
4040
4584
|
# @return [Types::DescribeContainerGroupDefinitionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4041
4585
|
#
|
4042
4586
|
# * {Types::DescribeContainerGroupDefinitionOutput#container_group_definition #container_group_definition} => Types::ContainerGroupDefinition
|
@@ -4045,6 +4589,7 @@ module Aws::GameLift
|
|
4045
4589
|
#
|
4046
4590
|
# resp = client.describe_container_group_definition({
|
4047
4591
|
# name: "ContainerGroupDefinitionNameOrArn", # required
|
4592
|
+
# version_number: 1,
|
4048
4593
|
# })
|
4049
4594
|
#
|
4050
4595
|
# @example Response structure
|
@@ -4053,38 +4598,56 @@ module Aws::GameLift
|
|
4053
4598
|
# resp.container_group_definition.creation_time #=> Time
|
4054
4599
|
# resp.container_group_definition.operating_system #=> String, one of "AMAZON_LINUX_2023"
|
4055
4600
|
# resp.container_group_definition.name #=> String
|
4056
|
-
# resp.container_group_definition.
|
4057
|
-
# resp.container_group_definition.
|
4058
|
-
# resp.container_group_definition.
|
4059
|
-
# resp.container_group_definition.
|
4060
|
-
# resp.container_group_definition.
|
4061
|
-
# resp.container_group_definition.
|
4062
|
-
# resp.container_group_definition.
|
4063
|
-
# resp.container_group_definition.
|
4064
|
-
# resp.container_group_definition.
|
4065
|
-
# resp.container_group_definition.
|
4066
|
-
# resp.container_group_definition.
|
4067
|
-
# resp.container_group_definition.
|
4068
|
-
# resp.container_group_definition.
|
4069
|
-
# resp.container_group_definition.
|
4070
|
-
# resp.container_group_definition.
|
4071
|
-
# resp.container_group_definition.
|
4072
|
-
# resp.container_group_definition.
|
4073
|
-
# resp.container_group_definition.
|
4074
|
-
# resp.container_group_definition.
|
4075
|
-
# resp.container_group_definition.
|
4076
|
-
# resp.container_group_definition.
|
4077
|
-
# resp.container_group_definition.
|
4078
|
-
# resp.container_group_definition.
|
4079
|
-
# resp.container_group_definition.
|
4080
|
-
# resp.container_group_definition.
|
4081
|
-
# resp.container_group_definition.
|
4082
|
-
# resp.container_group_definition.
|
4083
|
-
# resp.container_group_definition.
|
4084
|
-
# resp.container_group_definition.
|
4085
|
-
# resp.container_group_definition.
|
4086
|
-
# resp.container_group_definition.
|
4087
|
-
# resp.container_group_definition.
|
4601
|
+
# resp.container_group_definition.container_group_type #=> String, one of "GAME_SERVER", "PER_INSTANCE"
|
4602
|
+
# resp.container_group_definition.total_memory_limit_mebibytes #=> Integer
|
4603
|
+
# resp.container_group_definition.total_vcpu_limit #=> Float
|
4604
|
+
# resp.container_group_definition.game_server_container_definition.container_name #=> String
|
4605
|
+
# resp.container_group_definition.game_server_container_definition.depends_on #=> Array
|
4606
|
+
# resp.container_group_definition.game_server_container_definition.depends_on[0].container_name #=> String
|
4607
|
+
# resp.container_group_definition.game_server_container_definition.depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
4608
|
+
# resp.container_group_definition.game_server_container_definition.mount_points #=> Array
|
4609
|
+
# resp.container_group_definition.game_server_container_definition.mount_points[0].instance_path #=> String
|
4610
|
+
# resp.container_group_definition.game_server_container_definition.mount_points[0].container_path #=> String
|
4611
|
+
# resp.container_group_definition.game_server_container_definition.mount_points[0].access_level #=> String, one of "READ_ONLY", "READ_AND_WRITE"
|
4612
|
+
# resp.container_group_definition.game_server_container_definition.environment_override #=> Array
|
4613
|
+
# resp.container_group_definition.game_server_container_definition.environment_override[0].name #=> String
|
4614
|
+
# resp.container_group_definition.game_server_container_definition.environment_override[0].value #=> String
|
4615
|
+
# resp.container_group_definition.game_server_container_definition.image_uri #=> String
|
4616
|
+
# resp.container_group_definition.game_server_container_definition.port_configuration.container_port_ranges #=> Array
|
4617
|
+
# resp.container_group_definition.game_server_container_definition.port_configuration.container_port_ranges[0].from_port #=> Integer
|
4618
|
+
# resp.container_group_definition.game_server_container_definition.port_configuration.container_port_ranges[0].to_port #=> Integer
|
4619
|
+
# resp.container_group_definition.game_server_container_definition.port_configuration.container_port_ranges[0].protocol #=> String, one of "TCP", "UDP"
|
4620
|
+
# resp.container_group_definition.game_server_container_definition.resolved_image_digest #=> String
|
4621
|
+
# resp.container_group_definition.game_server_container_definition.server_sdk_version #=> String
|
4622
|
+
# resp.container_group_definition.support_container_definitions #=> Array
|
4623
|
+
# resp.container_group_definition.support_container_definitions[0].container_name #=> String
|
4624
|
+
# resp.container_group_definition.support_container_definitions[0].depends_on #=> Array
|
4625
|
+
# resp.container_group_definition.support_container_definitions[0].depends_on[0].container_name #=> String
|
4626
|
+
# resp.container_group_definition.support_container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
4627
|
+
# resp.container_group_definition.support_container_definitions[0].mount_points #=> Array
|
4628
|
+
# resp.container_group_definition.support_container_definitions[0].mount_points[0].instance_path #=> String
|
4629
|
+
# resp.container_group_definition.support_container_definitions[0].mount_points[0].container_path #=> String
|
4630
|
+
# resp.container_group_definition.support_container_definitions[0].mount_points[0].access_level #=> String, one of "READ_ONLY", "READ_AND_WRITE"
|
4631
|
+
# resp.container_group_definition.support_container_definitions[0].environment_override #=> Array
|
4632
|
+
# resp.container_group_definition.support_container_definitions[0].environment_override[0].name #=> String
|
4633
|
+
# resp.container_group_definition.support_container_definitions[0].environment_override[0].value #=> String
|
4634
|
+
# resp.container_group_definition.support_container_definitions[0].essential #=> Boolean
|
4635
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.command #=> Array
|
4636
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.command[0] #=> String
|
4637
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.interval #=> Integer
|
4638
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.retries #=> Integer
|
4639
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.start_period #=> Integer
|
4640
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.timeout #=> Integer
|
4641
|
+
# resp.container_group_definition.support_container_definitions[0].image_uri #=> String
|
4642
|
+
# resp.container_group_definition.support_container_definitions[0].memory_hard_limit_mebibytes #=> Integer
|
4643
|
+
# resp.container_group_definition.support_container_definitions[0].port_configuration.container_port_ranges #=> Array
|
4644
|
+
# resp.container_group_definition.support_container_definitions[0].port_configuration.container_port_ranges[0].from_port #=> Integer
|
4645
|
+
# resp.container_group_definition.support_container_definitions[0].port_configuration.container_port_ranges[0].to_port #=> Integer
|
4646
|
+
# resp.container_group_definition.support_container_definitions[0].port_configuration.container_port_ranges[0].protocol #=> String, one of "TCP", "UDP"
|
4647
|
+
# resp.container_group_definition.support_container_definitions[0].resolved_image_digest #=> String
|
4648
|
+
# resp.container_group_definition.support_container_definitions[0].vcpu #=> Float
|
4649
|
+
# resp.container_group_definition.version_number #=> Integer
|
4650
|
+
# resp.container_group_definition.version_description #=> String
|
4088
4651
|
# resp.container_group_definition.status #=> String, one of "READY", "COPYING", "FAILED"
|
4089
4652
|
# resp.container_group_definition.status_reason #=> String
|
4090
4653
|
#
|
@@ -4195,9 +4758,6 @@ module Aws::GameLift
|
|
4195
4758
|
req.send_request(options)
|
4196
4759
|
end
|
4197
4760
|
|
4198
|
-
# **This operation has been expanded to use with the Amazon GameLift
|
4199
|
-
# containers feature, which is currently in public preview.**
|
4200
|
-
#
|
4201
4761
|
# Retrieves core fleet-wide properties for fleets in an Amazon Web
|
4202
4762
|
# Services Region. Properties include the computing hardware and
|
4203
4763
|
# deployment configuration for instances in the fleet.
|
@@ -4292,16 +4852,9 @@ module Aws::GameLift
|
|
4292
4852
|
# resp.fleet_attributes[0].stopped_actions[0] #=> String, one of "AUTO_SCALING"
|
4293
4853
|
# resp.fleet_attributes[0].instance_role_arn #=> String
|
4294
4854
|
# resp.fleet_attributes[0].certificate_configuration.certificate_type #=> String, one of "DISABLED", "GENERATED"
|
4295
|
-
# resp.fleet_attributes[0].compute_type #=> String, one of "EC2", "ANYWHERE"
|
4855
|
+
# resp.fleet_attributes[0].compute_type #=> String, one of "EC2", "ANYWHERE"
|
4296
4856
|
# resp.fleet_attributes[0].anywhere_configuration.cost #=> String
|
4297
4857
|
# resp.fleet_attributes[0].instance_role_credentials_provider #=> String, one of "SHARED_CREDENTIAL_FILE"
|
4298
|
-
# resp.fleet_attributes[0].container_groups_attributes.container_group_definition_properties #=> Array
|
4299
|
-
# resp.fleet_attributes[0].container_groups_attributes.container_group_definition_properties[0].scheduling_strategy #=> String, one of "REPLICA", "DAEMON"
|
4300
|
-
# resp.fleet_attributes[0].container_groups_attributes.container_group_definition_properties[0].container_group_definition_name #=> String
|
4301
|
-
# resp.fleet_attributes[0].container_groups_attributes.connection_port_range.from_port #=> Integer
|
4302
|
-
# resp.fleet_attributes[0].container_groups_attributes.connection_port_range.to_port #=> Integer
|
4303
|
-
# resp.fleet_attributes[0].container_groups_attributes.container_groups_per_instance.desired_replica_container_groups_per_instance #=> Integer
|
4304
|
-
# resp.fleet_attributes[0].container_groups_attributes.container_groups_per_instance.max_replica_container_groups_per_instance #=> Integer
|
4305
4858
|
# resp.next_token #=> String
|
4306
4859
|
#
|
4307
4860
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetAttributes AWS API Documentation
|
@@ -4313,11 +4866,8 @@ module Aws::GameLift
|
|
4313
4866
|
req.send_request(options)
|
4314
4867
|
end
|
4315
4868
|
|
4316
|
-
# **This operation has been expanded to use with the Amazon GameLift
|
4317
|
-
# containers feature, which is currently in public preview.**
|
4318
|
-
#
|
4319
4869
|
# Retrieves the resource capacity settings for one or more fleets. For a
|
4320
|
-
# container fleet, this operation also returns counts for
|
4870
|
+
# container fleet, this operation also returns counts for game server
|
4321
4871
|
# container groups.
|
4322
4872
|
#
|
4323
4873
|
# With multi-location fleets, this operation retrieves data for the
|
@@ -4404,10 +4954,10 @@ module Aws::GameLift
|
|
4404
4954
|
# resp.fleet_capacity[0].instance_counts.idle #=> Integer
|
4405
4955
|
# resp.fleet_capacity[0].instance_counts.terminating #=> Integer
|
4406
4956
|
# resp.fleet_capacity[0].location #=> String
|
4407
|
-
# resp.fleet_capacity[0].
|
4408
|
-
# resp.fleet_capacity[0].
|
4409
|
-
# resp.fleet_capacity[0].
|
4410
|
-
# resp.fleet_capacity[0].
|
4957
|
+
# resp.fleet_capacity[0].game_server_container_group_counts.pending #=> Integer
|
4958
|
+
# resp.fleet_capacity[0].game_server_container_group_counts.active #=> Integer
|
4959
|
+
# resp.fleet_capacity[0].game_server_container_group_counts.idle #=> Integer
|
4960
|
+
# resp.fleet_capacity[0].game_server_container_group_counts.terminating #=> Integer
|
4411
4961
|
# resp.next_token #=> String
|
4412
4962
|
#
|
4413
4963
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetCapacity AWS API Documentation
|
@@ -4419,6 +4969,64 @@ module Aws::GameLift
|
|
4419
4969
|
req.send_request(options)
|
4420
4970
|
end
|
4421
4971
|
|
4972
|
+
# Retrieves information about a managed container fleet deployment.
|
4973
|
+
#
|
4974
|
+
# **Request options**
|
4975
|
+
#
|
4976
|
+
# * Get information about the latest deployment for a specific fleet.
|
4977
|
+
# Provide the fleet ID or ARN.
|
4978
|
+
#
|
4979
|
+
# * Get information about a specific deployment. Provide the fleet ID or
|
4980
|
+
# ARN and the deployment ID.
|
4981
|
+
#
|
4982
|
+
# **Results**
|
4983
|
+
#
|
4984
|
+
# If successful, a `FleetDeployment` object is returned.
|
4985
|
+
#
|
4986
|
+
# @option params [required, String] :fleet_id
|
4987
|
+
# A unique identifier for the container fleet. You can use either the
|
4988
|
+
# fleet ID or ARN value.
|
4989
|
+
#
|
4990
|
+
# @option params [String] :deployment_id
|
4991
|
+
# A unique identifier for the deployment to return information for.
|
4992
|
+
#
|
4993
|
+
# @return [Types::DescribeFleetDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4994
|
+
#
|
4995
|
+
# * {Types::DescribeFleetDeploymentOutput#fleet_deployment #fleet_deployment} => Types::FleetDeployment
|
4996
|
+
# * {Types::DescribeFleetDeploymentOutput#locational_deployments #locational_deployments} => Hash<String,Types::LocationalDeployment>
|
4997
|
+
#
|
4998
|
+
# @example Request syntax with placeholder values
|
4999
|
+
#
|
5000
|
+
# resp = client.describe_fleet_deployment({
|
5001
|
+
# fleet_id: "FleetIdOrArn", # required
|
5002
|
+
# deployment_id: "DeploymentId",
|
5003
|
+
# })
|
5004
|
+
#
|
5005
|
+
# @example Response structure
|
5006
|
+
#
|
5007
|
+
# resp.fleet_deployment.deployment_id #=> String
|
5008
|
+
# resp.fleet_deployment.fleet_id #=> String
|
5009
|
+
# resp.fleet_deployment.game_server_binary_arn #=> String
|
5010
|
+
# resp.fleet_deployment.rollback_game_server_binary_arn #=> String
|
5011
|
+
# resp.fleet_deployment.per_instance_binary_arn #=> String
|
5012
|
+
# resp.fleet_deployment.rollback_per_instance_binary_arn #=> String
|
5013
|
+
# resp.fleet_deployment.deployment_status #=> String, one of "IN_PROGRESS", "IMPAIRED", "COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "CANCELLED", "PENDING"
|
5014
|
+
# resp.fleet_deployment.deployment_configuration.protection_strategy #=> String, one of "WITH_PROTECTION", "IGNORE_PROTECTION"
|
5015
|
+
# resp.fleet_deployment.deployment_configuration.minimum_healthy_percentage #=> Integer
|
5016
|
+
# resp.fleet_deployment.deployment_configuration.impairment_strategy #=> String, one of "MAINTAIN", "ROLLBACK"
|
5017
|
+
# resp.fleet_deployment.creation_time #=> Time
|
5018
|
+
# resp.locational_deployments #=> Hash
|
5019
|
+
# resp.locational_deployments["NonZeroAnd128MaxAsciiString"].deployment_status #=> String, one of "IN_PROGRESS", "IMPAIRED", "COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "CANCELLED", "PENDING"
|
5020
|
+
#
|
5021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetDeployment AWS API Documentation
|
5022
|
+
#
|
5023
|
+
# @overload describe_fleet_deployment(params = {})
|
5024
|
+
# @param [Hash] params ({})
|
5025
|
+
def describe_fleet_deployment(params = {}, options = {})
|
5026
|
+
req = build_request(:describe_fleet_deployment, params)
|
5027
|
+
req.send_request(options)
|
5028
|
+
end
|
5029
|
+
|
4422
5030
|
# Retrieves entries from a fleet's event log. Fleet events are
|
4423
5031
|
# initiated by changes in status, such as during fleet creation and
|
4424
5032
|
# termination, changes in capacity, etc. If a fleet has multiple
|
@@ -4488,7 +5096,7 @@ module Aws::GameLift
|
|
4488
5096
|
# resp.events #=> Array
|
4489
5097
|
# resp.events[0].event_id #=> String
|
4490
5098
|
# resp.events[0].resource_id #=> String
|
4491
|
-
# resp.events[0].event_code #=> String, one of "GENERIC_EVENT", "FLEET_CREATED", "FLEET_DELETED", "FLEET_SCALING_EVENT", "FLEET_STATE_DOWNLOADING", "FLEET_STATE_VALIDATING", "FLEET_STATE_BUILDING", "FLEET_STATE_ACTIVATING", "FLEET_STATE_ACTIVE", "FLEET_STATE_ERROR", "FLEET_INITIALIZATION_FAILED", "FLEET_BINARY_DOWNLOAD_FAILED", "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND", "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE", "FLEET_VALIDATION_TIMED_OUT", "FLEET_ACTIVATION_FAILED", "FLEET_ACTIVATION_FAILED_NO_INSTANCES", "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED", "SERVER_PROCESS_INVALID_PATH", "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT", "SERVER_PROCESS_PROCESS_READY_TIMEOUT", "SERVER_PROCESS_CRASHED", "SERVER_PROCESS_TERMINATED_UNHEALTHY", "SERVER_PROCESS_FORCE_TERMINATED", "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT", "GAME_SESSION_ACTIVATION_TIMEOUT", "FLEET_CREATION_EXTRACTING_BUILD", "FLEET_CREATION_RUNNING_INSTALLER", "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG", "FLEET_VPC_PEERING_SUCCEEDED", "FLEET_VPC_PEERING_FAILED", "FLEET_VPC_PEERING_DELETED", "INSTANCE_INTERRUPTED", "INSTANCE_RECYCLED", "FLEET_CREATION_COMPLETED_INSTALLER", "FLEET_CREATION_FAILED_INSTALLER"
|
5099
|
+
# resp.events[0].event_code #=> String, one of "GENERIC_EVENT", "FLEET_CREATED", "FLEET_DELETED", "FLEET_SCALING_EVENT", "FLEET_STATE_DOWNLOADING", "FLEET_STATE_VALIDATING", "FLEET_STATE_BUILDING", "FLEET_STATE_ACTIVATING", "FLEET_STATE_ACTIVE", "FLEET_STATE_ERROR", "FLEET_STATE_PENDING", "FLEET_STATE_CREATING", "FLEET_STATE_CREATED", "FLEET_STATE_UPDATING", "FLEET_INITIALIZATION_FAILED", "FLEET_BINARY_DOWNLOAD_FAILED", "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND", "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE", "FLEET_VALIDATION_TIMED_OUT", "FLEET_ACTIVATION_FAILED", "FLEET_ACTIVATION_FAILED_NO_INSTANCES", "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED", "SERVER_PROCESS_INVALID_PATH", "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT", "SERVER_PROCESS_PROCESS_READY_TIMEOUT", "SERVER_PROCESS_CRASHED", "SERVER_PROCESS_TERMINATED_UNHEALTHY", "SERVER_PROCESS_FORCE_TERMINATED", "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT", "SERVER_PROCESS_SDK_INITIALIZATION_FAILED", "SERVER_PROCESS_MISCONFIGURED_CONTAINER_PORT", "GAME_SESSION_ACTIVATION_TIMEOUT", "FLEET_CREATION_EXTRACTING_BUILD", "FLEET_CREATION_RUNNING_INSTALLER", "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG", "FLEET_VPC_PEERING_SUCCEEDED", "FLEET_VPC_PEERING_FAILED", "FLEET_VPC_PEERING_DELETED", "INSTANCE_INTERRUPTED", "INSTANCE_RECYCLED", "INSTANCE_REPLACED_UNHEALTHY", "FLEET_CREATION_COMPLETED_INSTALLER", "FLEET_CREATION_FAILED_INSTALLER", "COMPUTE_LOG_UPLOAD_FAILED", "GAME_SERVER_CONTAINER_GROUP_CRASHED", "PER_INSTANCE_CONTAINER_GROUP_CRASHED", "GAME_SERVER_CONTAINER_GROUP_REPLACED_UNHEALTHY", "LOCATION_STATE_PENDING", "LOCATION_STATE_CREATING", "LOCATION_STATE_CREATED", "LOCATION_STATE_ACTIVATING", "LOCATION_STATE_ACTIVE", "LOCATION_STATE_UPDATING", "LOCATION_STATE_ERROR", "LOCATION_STATE_DELETING", "LOCATION_STATE_DELETED"
|
4492
5100
|
# resp.events[0].message #=> String
|
4493
5101
|
# resp.events[0].event_time #=> Time
|
4494
5102
|
# resp.events[0].pre_signed_log_url #=> String
|
@@ -4598,8 +5206,8 @@ module Aws::GameLift
|
|
4598
5206
|
# Retrieves the resource capacity settings for a fleet location. The
|
4599
5207
|
# data returned includes the current capacity (number of EC2 instances)
|
4600
5208
|
# and some scaling settings for the requested fleet location. For a
|
4601
|
-
# container fleet, this operation also returns counts for
|
4602
|
-
# container groups.
|
5209
|
+
# managed container fleet, this operation also returns counts for game
|
5210
|
+
# server container groups.
|
4603
5211
|
#
|
4604
5212
|
# Use this operation to retrieve capacity information for a fleet's
|
4605
5213
|
# remote location or home Region (you can also retrieve home Region
|
@@ -4657,10 +5265,10 @@ module Aws::GameLift
|
|
4657
5265
|
# resp.fleet_capacity.instance_counts.idle #=> Integer
|
4658
5266
|
# resp.fleet_capacity.instance_counts.terminating #=> Integer
|
4659
5267
|
# resp.fleet_capacity.location #=> String
|
4660
|
-
# resp.fleet_capacity.
|
4661
|
-
# resp.fleet_capacity.
|
4662
|
-
# resp.fleet_capacity.
|
4663
|
-
# resp.fleet_capacity.
|
5268
|
+
# resp.fleet_capacity.game_server_container_group_counts.pending #=> Integer
|
5269
|
+
# resp.fleet_capacity.game_server_container_group_counts.active #=> Integer
|
5270
|
+
# resp.fleet_capacity.game_server_container_group_counts.idle #=> Integer
|
5271
|
+
# resp.fleet_capacity.game_server_container_group_counts.terminating #=> Integer
|
4664
5272
|
#
|
4665
5273
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetLocationCapacity AWS API Documentation
|
4666
5274
|
#
|
@@ -4735,13 +5343,13 @@ module Aws::GameLift
|
|
4735
5343
|
req.send_request(options)
|
4736
5344
|
end
|
4737
5345
|
|
4738
|
-
# Retrieves a fleet's inbound connection permissions.
|
5346
|
+
# Retrieves a fleet's inbound connection permissions. Inbound
|
4739
5347
|
# permissions specify IP addresses and port settings that incoming
|
4740
5348
|
# traffic can use to access server processes in the fleet. Game server
|
4741
5349
|
# processes that are running in the fleet must use a port that falls
|
4742
|
-
# within this range. To connect to game server processes on a
|
4743
|
-
# fleet, the port settings should include one or more of the
|
4744
|
-
# connection ports.
|
5350
|
+
# within this range. To connect to game server processes on a managed
|
5351
|
+
# container fleet, the port settings should include one or more of the
|
5352
|
+
# container fleet's connection ports.
|
4745
5353
|
#
|
4746
5354
|
# Use this operation in the following ways:
|
4747
5355
|
#
|
@@ -5963,13 +6571,10 @@ module Aws::GameLift
|
|
5963
6571
|
end
|
5964
6572
|
|
5965
6573
|
# Retrieves a fleet's runtime configuration settings. The runtime
|
5966
|
-
# configuration determines which server processes run, and how,
|
5967
|
-
#
|
5968
|
-
#
|
5969
|
-
#
|
5970
|
-
# server processes that run in each replica container group. You can
|
5971
|
-
# update a fleet's runtime configuration at any time using
|
5972
|
-
# UpdateRuntimeConfiguration.
|
6574
|
+
# configuration determines which server processes run, and how they run,
|
6575
|
+
# and how many run concurrently on computes in managed EC2 and Anywhere
|
6576
|
+
# fleets. You can update a fleet's runtime configuration at any time
|
6577
|
+
# using UpdateRuntimeConfiguration.
|
5973
6578
|
#
|
5974
6579
|
# To get the current runtime configuration for a fleet, provide the
|
5975
6580
|
# fleet ID.
|
@@ -6260,43 +6865,31 @@ module Aws::GameLift
|
|
6260
6865
|
req.send_request(options)
|
6261
6866
|
end
|
6262
6867
|
|
6263
|
-
# **This operation has been expanded to use with the Amazon GameLift
|
6264
|
-
# containers feature, which is currently in public preview.**
|
6265
|
-
#
|
6266
6868
|
# Requests authorization to remotely connect to a hosting resource in a
|
6267
6869
|
# Amazon GameLift managed fleet. This operation is not used with Amazon
|
6268
|
-
# GameLift Anywhere fleets
|
6870
|
+
# GameLift Anywhere fleets.
|
6269
6871
|
#
|
6270
|
-
#
|
6271
|
-
# successful, this operation returns a set of temporary Amazon Web
|
6272
|
-
# Services credentials, including a two-part access key and a session
|
6273
|
-
# token.
|
6274
|
-
#
|
6275
|
-
# **EC2 fleets**
|
6276
|
-
#
|
6277
|
-
# With an EC2 fleet (where compute type is `EC2`), use these credentials
|
6278
|
-
# with Amazon EC2 Systems Manager (SSM) to start a session with the
|
6279
|
-
# compute. For more details, see [ Starting a session (CLI)][1] in the
|
6280
|
-
# *Amazon EC2 Systems Manager User Guide*.
|
6872
|
+
# **Request options**
|
6281
6873
|
#
|
6282
|
-
#
|
6874
|
+
# To request access to a compute, specify the compute name and the fleet
|
6875
|
+
# ID.
|
6283
6876
|
#
|
6284
|
-
#
|
6285
|
-
# credentials and the target value with SSM to connect to the fleet
|
6286
|
-
# instance where the container is running. After you're connected to
|
6287
|
-
# the instance, use Docker commands to interact with the container.
|
6877
|
+
# **Results**
|
6288
6878
|
#
|
6289
|
-
#
|
6879
|
+
# If successful, this operation returns a set of temporary Amazon Web
|
6880
|
+
# Services credentials, including a two-part access key and a session
|
6881
|
+
# token.
|
6290
6882
|
#
|
6291
|
-
# *
|
6883
|
+
# * With a managed EC2 fleet (where compute type is `EC2`), use these
|
6884
|
+
# credentials with Amazon EC2 Systems Manager (SSM) to start a session
|
6885
|
+
# with the compute. For more details, see [ Starting a session
|
6886
|
+
# (CLI)][1] in the *Amazon EC2 Systems Manager User Guide*.
|
6292
6887
|
#
|
6293
|
-
#
|
6888
|
+
# ^
|
6294
6889
|
#
|
6295
6890
|
#
|
6296
6891
|
#
|
6297
6892
|
# [1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html#sessions-start-cli
|
6298
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html
|
6299
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html
|
6300
6893
|
#
|
6301
6894
|
# @option params [required, String] :fleet_id
|
6302
6895
|
# A unique identifier for the fleet that holds the compute resource that
|
@@ -6304,10 +6897,8 @@ module Aws::GameLift
|
|
6304
6897
|
#
|
6305
6898
|
# @option params [required, String] :compute_name
|
6306
6899
|
# A unique identifier for the compute resource that you want to connect
|
6307
|
-
# to. For an EC2 fleet compute, use the instance ID.
|
6308
|
-
#
|
6309
|
-
# `a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9`)
|
6310
|
-
# or the compute ARN.
|
6900
|
+
# to. For an EC2 fleet compute, use the instance ID. Use ListCompute to
|
6901
|
+
# retrieve compute identifiers.
|
6311
6902
|
#
|
6312
6903
|
# @return [Types::GetComputeAccessOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6313
6904
|
#
|
@@ -6317,6 +6908,7 @@ module Aws::GameLift
|
|
6317
6908
|
# * {Types::GetComputeAccessOutput#compute_arn #compute_arn} => String
|
6318
6909
|
# * {Types::GetComputeAccessOutput#credentials #credentials} => Types::AwsCredentials
|
6319
6910
|
# * {Types::GetComputeAccessOutput#target #target} => String
|
6911
|
+
# * {Types::GetComputeAccessOutput#container_identifiers #container_identifiers} => Array<Types::ContainerIdentifier>
|
6320
6912
|
#
|
6321
6913
|
# @example Request syntax with placeholder values
|
6322
6914
|
#
|
@@ -6335,6 +6927,9 @@ module Aws::GameLift
|
|
6335
6927
|
# resp.credentials.secret_access_key #=> String
|
6336
6928
|
# resp.credentials.session_token #=> String
|
6337
6929
|
# resp.target #=> String
|
6930
|
+
# resp.container_identifiers #=> Array
|
6931
|
+
# resp.container_identifiers[0].container_name #=> String
|
6932
|
+
# resp.container_identifiers[0].container_runtime_id #=> String
|
6338
6933
|
#
|
6339
6934
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAccess AWS API Documentation
|
6340
6935
|
#
|
@@ -6346,25 +6941,23 @@ module Aws::GameLift
|
|
6346
6941
|
end
|
6347
6942
|
|
6348
6943
|
# Requests an authentication token from Amazon GameLift for a compute
|
6349
|
-
# resource in an Amazon GameLift
|
6350
|
-
#
|
6351
|
-
#
|
6352
|
-
#
|
6353
|
-
#
|
6354
|
-
#
|
6355
|
-
#
|
6356
|
-
#
|
6357
|
-
#
|
6358
|
-
#
|
6359
|
-
#
|
6360
|
-
#
|
6361
|
-
#
|
6362
|
-
#
|
6363
|
-
#
|
6364
|
-
#
|
6365
|
-
#
|
6366
|
-
# retrieve and refresh auth tokens for computes that are running game
|
6367
|
-
# server processes.
|
6944
|
+
# resource in an Amazon GameLift fleet. Game servers that are running on
|
6945
|
+
# the compute use this token to communicate with the Amazon GameLift
|
6946
|
+
# service, such as when calling the Amazon GameLift server SDK action
|
6947
|
+
# `InitSDK()`. Authentication tokens are valid for a limited time span,
|
6948
|
+
# so you need to request a fresh token before the current token expires.
|
6949
|
+
#
|
6950
|
+
# **Request options**
|
6951
|
+
#
|
6952
|
+
# * For managed EC2 fleets (compute type `EC2`), auth token retrieval
|
6953
|
+
# and refresh is handled automatically. All game servers that are
|
6954
|
+
# running on all fleet instances have access to a valid auth token.
|
6955
|
+
#
|
6956
|
+
# * For Anywhere fleets (compute type `ANYWHERE`), if you're using the
|
6957
|
+
# Amazon GameLift Agent, auth token retrieval and refresh is handled
|
6958
|
+
# automatically for any compute where the Agent is running. If you're
|
6959
|
+
# not using the Agent, create a mechanism to retrieve and refresh auth
|
6960
|
+
# tokens for computes that are running game server processes.
|
6368
6961
|
#
|
6369
6962
|
# **Learn more**
|
6370
6963
|
#
|
@@ -6386,10 +6979,7 @@ module Aws::GameLift
|
|
6386
6979
|
# @option params [required, String] :compute_name
|
6387
6980
|
# The name of the compute resource you are requesting the authentication
|
6388
6981
|
# token for. For an Anywhere fleet compute, use the registered compute
|
6389
|
-
# name. For an EC2 fleet instance, use the instance ID.
|
6390
|
-
# fleet, use the compute name (for example,
|
6391
|
-
# `a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9`)
|
6392
|
-
# or the compute ARN.
|
6982
|
+
# name. For an EC2 fleet instance, use the instance ID.
|
6393
6983
|
#
|
6394
6984
|
# @return [Types::GetComputeAuthTokenOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6395
6985
|
#
|
@@ -6686,7 +7276,7 @@ module Aws::GameLift
|
|
6686
7276
|
# @option params [String] :next_token
|
6687
7277
|
# A token that indicates the start of the next sequential page of
|
6688
7278
|
# results. Use the token that is returned with a previous call to this
|
6689
|
-
# operation. To start at the beginning of the result set,
|
7279
|
+
# operation. To start at the beginning of the result set, do not specify
|
6690
7280
|
# a value.
|
6691
7281
|
#
|
6692
7282
|
# @return [Types::ListBuildsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -6727,43 +7317,55 @@ module Aws::GameLift
|
|
6727
7317
|
req.send_request(options)
|
6728
7318
|
end
|
6729
7319
|
|
6730
|
-
# **This operation has been expanded to use with the Amazon GameLift
|
6731
|
-
# containers feature, which is currently in public preview.**
|
6732
|
-
#
|
6733
7320
|
# Retrieves information on the compute resources in an Amazon GameLift
|
6734
|
-
# fleet.
|
7321
|
+
# fleet. Use the pagination parameters to retrieve results in a set of
|
7322
|
+
# sequential pages.
|
6735
7323
|
#
|
6736
|
-
#
|
6737
|
-
#
|
6738
|
-
#
|
7324
|
+
# **Request options:**
|
7325
|
+
#
|
7326
|
+
# * Retrieve a list of all computes in a fleet. Specify a fleet ID.
|
6739
7327
|
#
|
6740
|
-
#
|
7328
|
+
# * Retrieve a list of all computes in a specific fleet location.
|
7329
|
+
# Specify a fleet ID and location.
|
6741
7330
|
#
|
6742
|
-
#
|
6743
|
-
# the requested fleet. Depending on the fleet's compute type, the
|
6744
|
-
# result includes the following information:
|
7331
|
+
# **Results:**
|
6745
7332
|
#
|
6746
|
-
#
|
6747
|
-
#
|
7333
|
+
# If successful, this operation returns information on a set of
|
7334
|
+
# computes. Depending on the type of fleet, the result includes the
|
7335
|
+
# following information:
|
6748
7336
|
#
|
6749
|
-
# * For `
|
6750
|
-
#
|
6751
|
-
#
|
6752
|
-
# `GameLiftAgentEndpoint` is included.
|
7337
|
+
# * For managed EC2 fleets (compute type `EC2`), this operation returns
|
7338
|
+
# information about the EC2 instance. Compute names are EC2 instance
|
7339
|
+
# IDs.
|
6753
7340
|
#
|
6754
|
-
# * For `
|
6755
|
-
#
|
6756
|
-
#
|
7341
|
+
# * For Anywhere fleets (compute type `ANYWHERE`), this operation
|
7342
|
+
# returns compute names and details as provided when the compute was
|
7343
|
+
# registered with `RegisterCompute`. This includes
|
7344
|
+
# `GameLiftServiceSdkEndpoint` or `GameLiftAgentEndpoint`.
|
6757
7345
|
#
|
6758
7346
|
# @option params [required, String] :fleet_id
|
6759
7347
|
# A unique identifier for the fleet to retrieve compute resources for.
|
6760
7348
|
#
|
6761
7349
|
# @option params [String] :location
|
6762
7350
|
# The name of a location to retrieve compute resources for. For an
|
6763
|
-
# Amazon GameLift Anywhere fleet, use a custom location. For a
|
6764
|
-
#
|
6765
|
-
#
|
6766
|
-
#
|
7351
|
+
# Amazon GameLift Anywhere fleet, use a custom location. For a managed
|
7352
|
+
# fleet, provide a Amazon Web Services Region or Local Zone code (for
|
7353
|
+
# example: `us-west-2` or `us-west-2-lax-1`).
|
7354
|
+
#
|
7355
|
+
# @option params [String] :container_group_definition_name
|
7356
|
+
# For computes in a managed container fleet, the name of the deployed
|
7357
|
+
# container group definition.
|
7358
|
+
#
|
7359
|
+
# @option params [String] :compute_status
|
7360
|
+
# The status of computes in a managed container fleet, based on the
|
7361
|
+
# success of the latest update deployment.
|
7362
|
+
#
|
7363
|
+
# * `ACTIVE` -- The compute is deployed with the correct container
|
7364
|
+
# definitions. It is ready to process game servers and host game
|
7365
|
+
# sessions.
|
7366
|
+
#
|
7367
|
+
# * `IMPAIRED` -- An update deployment to the compute failed, and the
|
7368
|
+
# compute is deployed with incorrect container definitions.
|
6767
7369
|
#
|
6768
7370
|
# @option params [Integer] :limit
|
6769
7371
|
# The maximum number of results to return. Use this parameter with
|
@@ -6787,6 +7389,8 @@ module Aws::GameLift
|
|
6787
7389
|
# resp = client.list_compute({
|
6788
7390
|
# fleet_id: "FleetIdOrArn", # required
|
6789
7391
|
# location: "LocationStringModel",
|
7392
|
+
# container_group_definition_name: "ContainerGroupDefinitionNameOrArn",
|
7393
|
+
# compute_status: "ACTIVE", # accepts ACTIVE, IMPAIRED
|
6790
7394
|
# limit: 1,
|
6791
7395
|
# next_token: "NonZeroAndMaxString",
|
6792
7396
|
# })
|
@@ -6800,7 +7404,7 @@ module Aws::GameLift
|
|
6800
7404
|
# resp.compute_list[0].compute_arn #=> String
|
6801
7405
|
# resp.compute_list[0].ip_address #=> String
|
6802
7406
|
# resp.compute_list[0].dns_name #=> String
|
6803
|
-
# resp.compute_list[0].compute_status #=> String, one of "PENDING", "ACTIVE", "TERMINATING"
|
7407
|
+
# resp.compute_list[0].compute_status #=> String, one of "PENDING", "ACTIVE", "TERMINATING", "IMPAIRED"
|
6804
7408
|
# resp.compute_list[0].location #=> String
|
6805
7409
|
# resp.compute_list[0].creation_time #=> Time
|
6806
7410
|
# resp.compute_list[0].operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2", "WINDOWS_2016", "AMAZON_LINUX_2023"
|
@@ -6808,29 +7412,279 @@ module Aws::GameLift
|
|
6808
7412
|
# resp.compute_list[0].game_lift_service_sdk_endpoint #=> String
|
6809
7413
|
# resp.compute_list[0].game_lift_agent_endpoint #=> String
|
6810
7414
|
# resp.compute_list[0].instance_id #=> String
|
6811
|
-
# resp.compute_list[0].container_attributes
|
6812
|
-
# resp.compute_list[0].container_attributes
|
6813
|
-
# resp.compute_list[0].container_attributes
|
6814
|
-
# resp.compute_list[0].
|
7415
|
+
# resp.compute_list[0].container_attributes #=> Array
|
7416
|
+
# resp.compute_list[0].container_attributes[0].container_name #=> String
|
7417
|
+
# resp.compute_list[0].container_attributes[0].container_runtime_id #=> String
|
7418
|
+
# resp.compute_list[0].game_server_container_group_definition_arn #=> String
|
7419
|
+
# resp.next_token #=> String
|
7420
|
+
#
|
7421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListCompute AWS API Documentation
|
7422
|
+
#
|
7423
|
+
# @overload list_compute(params = {})
|
7424
|
+
# @param [Hash] params ({})
|
7425
|
+
def list_compute(params = {}, options = {})
|
7426
|
+
req = build_request(:list_compute, params)
|
7427
|
+
req.send_request(options)
|
7428
|
+
end
|
7429
|
+
|
7430
|
+
# Retrieves a collection of container fleet resources in an Amazon Web
|
7431
|
+
# Services Region. For fleets that have multiple locations, this
|
7432
|
+
# operation retrieves fleets based on their home Region only.
|
7433
|
+
#
|
7434
|
+
# **Request options**
|
7435
|
+
#
|
7436
|
+
# * Get a list of all fleets. Call this operation without specifying a
|
7437
|
+
# container group definition.
|
7438
|
+
#
|
7439
|
+
# * Get a list of fleets filtered by container group definition. Provide
|
7440
|
+
# the container group definition name or ARN value.
|
7441
|
+
#
|
7442
|
+
# * To get a list of all Realtime Servers fleets with a specific
|
7443
|
+
# configuration script, provide the script ID.
|
7444
|
+
#
|
7445
|
+
# Use the pagination parameters to retrieve results as a set of
|
7446
|
+
# sequential pages.
|
7447
|
+
#
|
7448
|
+
# If successful, this operation returns a collection of container fleets
|
7449
|
+
# that match the request parameters. A NextToken value is also returned
|
7450
|
+
# if there are more result pages to retrieve.
|
7451
|
+
#
|
7452
|
+
# <note markdown="1"> Fleet IDs are returned in no particular order.
|
7453
|
+
#
|
7454
|
+
# </note>
|
7455
|
+
#
|
7456
|
+
# @option params [String] :container_group_definition_name
|
7457
|
+
# The container group definition to filter the list on. Use this
|
7458
|
+
# parameter to retrieve only those fleets that use the specified
|
7459
|
+
# container group definition. You can specify the container group
|
7460
|
+
# definition's name to get fleets with the latest versions.
|
7461
|
+
# Alternatively, provide an ARN value to get fleets with a specific
|
7462
|
+
# version number.
|
7463
|
+
#
|
7464
|
+
# @option params [Integer] :limit
|
7465
|
+
# The maximum number of results to return. Use this parameter with
|
7466
|
+
# `NextToken` to get results as a set of sequential pages.
|
7467
|
+
#
|
7468
|
+
# @option params [String] :next_token
|
7469
|
+
# A token that indicates the start of the next sequential page of
|
7470
|
+
# results. Use the token that is returned with a previous call to this
|
7471
|
+
# operation. To start at the beginning of the result set, do not specify
|
7472
|
+
# a value.
|
7473
|
+
#
|
7474
|
+
# @return [Types::ListContainerFleetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7475
|
+
#
|
7476
|
+
# * {Types::ListContainerFleetsOutput#container_fleets #container_fleets} => Array<Types::ContainerFleet>
|
7477
|
+
# * {Types::ListContainerFleetsOutput#next_token #next_token} => String
|
7478
|
+
#
|
7479
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7480
|
+
#
|
7481
|
+
# @example Request syntax with placeholder values
|
7482
|
+
#
|
7483
|
+
# resp = client.list_container_fleets({
|
7484
|
+
# container_group_definition_name: "ContainerGroupDefinitionNameOrArn",
|
7485
|
+
# limit: 1,
|
7486
|
+
# next_token: "NonZeroAndMaxString",
|
7487
|
+
# })
|
7488
|
+
#
|
7489
|
+
# @example Response structure
|
7490
|
+
#
|
7491
|
+
# resp.container_fleets #=> Array
|
7492
|
+
# resp.container_fleets[0].fleet_id #=> String
|
7493
|
+
# resp.container_fleets[0].fleet_arn #=> String
|
7494
|
+
# resp.container_fleets[0].fleet_role_arn #=> String
|
7495
|
+
# resp.container_fleets[0].game_server_container_group_definition_name #=> String
|
7496
|
+
# resp.container_fleets[0].game_server_container_group_definition_arn #=> String
|
7497
|
+
# resp.container_fleets[0].per_instance_container_group_definition_name #=> String
|
7498
|
+
# resp.container_fleets[0].per_instance_container_group_definition_arn #=> String
|
7499
|
+
# resp.container_fleets[0].instance_connection_port_range.from_port #=> Integer
|
7500
|
+
# resp.container_fleets[0].instance_connection_port_range.to_port #=> Integer
|
7501
|
+
# resp.container_fleets[0].instance_inbound_permissions #=> Array
|
7502
|
+
# resp.container_fleets[0].instance_inbound_permissions[0].from_port #=> Integer
|
7503
|
+
# resp.container_fleets[0].instance_inbound_permissions[0].to_port #=> Integer
|
7504
|
+
# resp.container_fleets[0].instance_inbound_permissions[0].ip_range #=> String
|
7505
|
+
# resp.container_fleets[0].instance_inbound_permissions[0].protocol #=> String, one of "TCP", "UDP"
|
7506
|
+
# resp.container_fleets[0].game_server_container_groups_per_instance #=> Integer
|
7507
|
+
# resp.container_fleets[0].maximum_game_server_container_groups_per_instance #=> Integer
|
7508
|
+
# resp.container_fleets[0].instance_type #=> String
|
7509
|
+
# resp.container_fleets[0].billing_type #=> String, one of "ON_DEMAND", "SPOT"
|
7510
|
+
# resp.container_fleets[0].description #=> String
|
7511
|
+
# resp.container_fleets[0].creation_time #=> Time
|
7512
|
+
# resp.container_fleets[0].metric_groups #=> Array
|
7513
|
+
# resp.container_fleets[0].metric_groups[0] #=> String
|
7514
|
+
# resp.container_fleets[0].new_game_session_protection_policy #=> String, one of "NoProtection", "FullProtection"
|
7515
|
+
# resp.container_fleets[0].game_session_creation_limit_policy.new_game_sessions_per_creator #=> Integer
|
7516
|
+
# resp.container_fleets[0].game_session_creation_limit_policy.policy_period_in_minutes #=> Integer
|
7517
|
+
# resp.container_fleets[0].status #=> String, one of "PENDING", "CREATING", "CREATED", "ACTIVATING", "ACTIVE", "UPDATING", "DELETING"
|
7518
|
+
# resp.container_fleets[0].deployment_details.latest_deployment_id #=> String
|
7519
|
+
# resp.container_fleets[0].log_configuration.log_destination #=> String, one of "NONE", "CLOUDWATCH", "S3"
|
7520
|
+
# resp.container_fleets[0].log_configuration.s3_bucket_name #=> String
|
7521
|
+
# resp.container_fleets[0].log_configuration.log_group_arn #=> String
|
7522
|
+
# resp.container_fleets[0].location_attributes #=> Array
|
7523
|
+
# resp.container_fleets[0].location_attributes[0].location #=> String
|
7524
|
+
# resp.container_fleets[0].location_attributes[0].status #=> String, one of "PENDING", "CREATING", "CREATED", "ACTIVATING", "ACTIVE", "UPDATING", "DELETING"
|
7525
|
+
# resp.next_token #=> String
|
7526
|
+
#
|
7527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListContainerFleets AWS API Documentation
|
7528
|
+
#
|
7529
|
+
# @overload list_container_fleets(params = {})
|
7530
|
+
# @param [Hash] params ({})
|
7531
|
+
def list_container_fleets(params = {}, options = {})
|
7532
|
+
req = build_request(:list_container_fleets, params)
|
7533
|
+
req.send_request(options)
|
7534
|
+
end
|
7535
|
+
|
7536
|
+
# Retrieves all versions of a container group definition. Use the
|
7537
|
+
# pagination parameters to retrieve results in a set of sequential
|
7538
|
+
# pages.
|
7539
|
+
#
|
7540
|
+
# **Request options:**
|
7541
|
+
#
|
7542
|
+
# * Get all versions of a specified container group definition. Specify
|
7543
|
+
# the container group definition name or ARN value. (If the ARN value
|
7544
|
+
# has a version number, it's ignored.)
|
7545
|
+
#
|
7546
|
+
# ^
|
7547
|
+
#
|
7548
|
+
# **Results:**
|
7549
|
+
#
|
7550
|
+
# If successful, this operation returns the complete properties of a set
|
7551
|
+
# of container group definition versions that match the request.
|
7552
|
+
#
|
7553
|
+
# <note markdown="1"> This operation returns the list of container group definitions in
|
7554
|
+
# descending version order (latest first).
|
7555
|
+
#
|
7556
|
+
# </note>
|
7557
|
+
#
|
7558
|
+
# **Learn more**
|
7559
|
+
#
|
7560
|
+
# * [Manage a container group definition][1]
|
7561
|
+
#
|
7562
|
+
# ^
|
7563
|
+
#
|
7564
|
+
#
|
7565
|
+
#
|
7566
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html
|
7567
|
+
#
|
7568
|
+
# @option params [required, String] :name
|
7569
|
+
# The unique identifier for the container group definition to retrieve
|
7570
|
+
# properties for. You can use either the `Name` or `ARN` value.
|
7571
|
+
#
|
7572
|
+
# @option params [Integer] :limit
|
7573
|
+
# The maximum number of results to return. Use this parameter with
|
7574
|
+
# `NextToken` to get results as a set of sequential pages.
|
7575
|
+
#
|
7576
|
+
# @option params [String] :next_token
|
7577
|
+
# A token that indicates the start of the next sequential page of
|
7578
|
+
# results. Use the token that is returned with a previous call to this
|
7579
|
+
# operation. To start at the beginning of the result set, do not specify
|
7580
|
+
# a value.
|
7581
|
+
#
|
7582
|
+
# @return [Types::ListContainerGroupDefinitionVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7583
|
+
#
|
7584
|
+
# * {Types::ListContainerGroupDefinitionVersionsOutput#container_group_definitions #container_group_definitions} => Array<Types::ContainerGroupDefinition>
|
7585
|
+
# * {Types::ListContainerGroupDefinitionVersionsOutput#next_token #next_token} => String
|
7586
|
+
#
|
7587
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7588
|
+
#
|
7589
|
+
# @example Request syntax with placeholder values
|
7590
|
+
#
|
7591
|
+
# resp = client.list_container_group_definition_versions({
|
7592
|
+
# name: "ContainerGroupDefinitionNameOrArn", # required
|
7593
|
+
# limit: 1,
|
7594
|
+
# next_token: "NonZeroAndMaxString",
|
7595
|
+
# })
|
7596
|
+
#
|
7597
|
+
# @example Response structure
|
7598
|
+
#
|
7599
|
+
# resp.container_group_definitions #=> Array
|
7600
|
+
# resp.container_group_definitions[0].container_group_definition_arn #=> String
|
7601
|
+
# resp.container_group_definitions[0].creation_time #=> Time
|
7602
|
+
# resp.container_group_definitions[0].operating_system #=> String, one of "AMAZON_LINUX_2023"
|
7603
|
+
# resp.container_group_definitions[0].name #=> String
|
7604
|
+
# resp.container_group_definitions[0].container_group_type #=> String, one of "GAME_SERVER", "PER_INSTANCE"
|
7605
|
+
# resp.container_group_definitions[0].total_memory_limit_mebibytes #=> Integer
|
7606
|
+
# resp.container_group_definitions[0].total_vcpu_limit #=> Float
|
7607
|
+
# resp.container_group_definitions[0].game_server_container_definition.container_name #=> String
|
7608
|
+
# resp.container_group_definitions[0].game_server_container_definition.depends_on #=> Array
|
7609
|
+
# resp.container_group_definitions[0].game_server_container_definition.depends_on[0].container_name #=> String
|
7610
|
+
# resp.container_group_definitions[0].game_server_container_definition.depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
7611
|
+
# resp.container_group_definitions[0].game_server_container_definition.mount_points #=> Array
|
7612
|
+
# resp.container_group_definitions[0].game_server_container_definition.mount_points[0].instance_path #=> String
|
7613
|
+
# resp.container_group_definitions[0].game_server_container_definition.mount_points[0].container_path #=> String
|
7614
|
+
# resp.container_group_definitions[0].game_server_container_definition.mount_points[0].access_level #=> String, one of "READ_ONLY", "READ_AND_WRITE"
|
7615
|
+
# resp.container_group_definitions[0].game_server_container_definition.environment_override #=> Array
|
7616
|
+
# resp.container_group_definitions[0].game_server_container_definition.environment_override[0].name #=> String
|
7617
|
+
# resp.container_group_definitions[0].game_server_container_definition.environment_override[0].value #=> String
|
7618
|
+
# resp.container_group_definitions[0].game_server_container_definition.image_uri #=> String
|
7619
|
+
# resp.container_group_definitions[0].game_server_container_definition.port_configuration.container_port_ranges #=> Array
|
7620
|
+
# resp.container_group_definitions[0].game_server_container_definition.port_configuration.container_port_ranges[0].from_port #=> Integer
|
7621
|
+
# resp.container_group_definitions[0].game_server_container_definition.port_configuration.container_port_ranges[0].to_port #=> Integer
|
7622
|
+
# resp.container_group_definitions[0].game_server_container_definition.port_configuration.container_port_ranges[0].protocol #=> String, one of "TCP", "UDP"
|
7623
|
+
# resp.container_group_definitions[0].game_server_container_definition.resolved_image_digest #=> String
|
7624
|
+
# resp.container_group_definitions[0].game_server_container_definition.server_sdk_version #=> String
|
7625
|
+
# resp.container_group_definitions[0].support_container_definitions #=> Array
|
7626
|
+
# resp.container_group_definitions[0].support_container_definitions[0].container_name #=> String
|
7627
|
+
# resp.container_group_definitions[0].support_container_definitions[0].depends_on #=> Array
|
7628
|
+
# resp.container_group_definitions[0].support_container_definitions[0].depends_on[0].container_name #=> String
|
7629
|
+
# resp.container_group_definitions[0].support_container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
7630
|
+
# resp.container_group_definitions[0].support_container_definitions[0].mount_points #=> Array
|
7631
|
+
# resp.container_group_definitions[0].support_container_definitions[0].mount_points[0].instance_path #=> String
|
7632
|
+
# resp.container_group_definitions[0].support_container_definitions[0].mount_points[0].container_path #=> String
|
7633
|
+
# resp.container_group_definitions[0].support_container_definitions[0].mount_points[0].access_level #=> String, one of "READ_ONLY", "READ_AND_WRITE"
|
7634
|
+
# resp.container_group_definitions[0].support_container_definitions[0].environment_override #=> Array
|
7635
|
+
# resp.container_group_definitions[0].support_container_definitions[0].environment_override[0].name #=> String
|
7636
|
+
# resp.container_group_definitions[0].support_container_definitions[0].environment_override[0].value #=> String
|
7637
|
+
# resp.container_group_definitions[0].support_container_definitions[0].essential #=> Boolean
|
7638
|
+
# resp.container_group_definitions[0].support_container_definitions[0].health_check.command #=> Array
|
7639
|
+
# resp.container_group_definitions[0].support_container_definitions[0].health_check.command[0] #=> String
|
7640
|
+
# resp.container_group_definitions[0].support_container_definitions[0].health_check.interval #=> Integer
|
7641
|
+
# resp.container_group_definitions[0].support_container_definitions[0].health_check.retries #=> Integer
|
7642
|
+
# resp.container_group_definitions[0].support_container_definitions[0].health_check.start_period #=> Integer
|
7643
|
+
# resp.container_group_definitions[0].support_container_definitions[0].health_check.timeout #=> Integer
|
7644
|
+
# resp.container_group_definitions[0].support_container_definitions[0].image_uri #=> String
|
7645
|
+
# resp.container_group_definitions[0].support_container_definitions[0].memory_hard_limit_mebibytes #=> Integer
|
7646
|
+
# resp.container_group_definitions[0].support_container_definitions[0].port_configuration.container_port_ranges #=> Array
|
7647
|
+
# resp.container_group_definitions[0].support_container_definitions[0].port_configuration.container_port_ranges[0].from_port #=> Integer
|
7648
|
+
# resp.container_group_definitions[0].support_container_definitions[0].port_configuration.container_port_ranges[0].to_port #=> Integer
|
7649
|
+
# resp.container_group_definitions[0].support_container_definitions[0].port_configuration.container_port_ranges[0].protocol #=> String, one of "TCP", "UDP"
|
7650
|
+
# resp.container_group_definitions[0].support_container_definitions[0].resolved_image_digest #=> String
|
7651
|
+
# resp.container_group_definitions[0].support_container_definitions[0].vcpu #=> Float
|
7652
|
+
# resp.container_group_definitions[0].version_number #=> Integer
|
7653
|
+
# resp.container_group_definitions[0].version_description #=> String
|
7654
|
+
# resp.container_group_definitions[0].status #=> String, one of "READY", "COPYING", "FAILED"
|
7655
|
+
# resp.container_group_definitions[0].status_reason #=> String
|
6815
7656
|
# resp.next_token #=> String
|
6816
7657
|
#
|
6817
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/
|
7658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListContainerGroupDefinitionVersions AWS API Documentation
|
6818
7659
|
#
|
6819
|
-
# @overload
|
7660
|
+
# @overload list_container_group_definition_versions(params = {})
|
6820
7661
|
# @param [Hash] params ({})
|
6821
|
-
def
|
6822
|
-
req = build_request(:
|
7662
|
+
def list_container_group_definition_versions(params = {}, options = {})
|
7663
|
+
req = build_request(:list_container_group_definition_versions, params)
|
6823
7664
|
req.send_request(options)
|
6824
7665
|
end
|
6825
7666
|
|
6826
|
-
#
|
6827
|
-
#
|
7667
|
+
# Retrieves container group definitions for the Amazon Web Services
|
7668
|
+
# account and Amazon Web Services Region. Use the pagination parameters
|
7669
|
+
# to retrieve results in a set of sequential pages.
|
7670
|
+
#
|
7671
|
+
# This operation returns only the latest version of each definition. To
|
7672
|
+
# retrieve all versions of a container group definition, use
|
7673
|
+
# ListContainerGroupDefinitionVersions.
|
7674
|
+
#
|
7675
|
+
# **Request options:**
|
7676
|
+
#
|
7677
|
+
# * Retrieve the most recent versions of all container group
|
7678
|
+
# definitions.
|
7679
|
+
#
|
7680
|
+
# * Retrieve the most recent versions of all container group
|
7681
|
+
# definitions, filtered by type. Specify the container group type to
|
7682
|
+
# filter on.
|
6828
7683
|
#
|
6829
|
-
#
|
6830
|
-
#
|
6831
|
-
#
|
6832
|
-
#
|
6833
|
-
# of sequential pages.
|
7684
|
+
# **Results:**
|
7685
|
+
#
|
7686
|
+
# If successful, this operation returns the complete properties of a set
|
7687
|
+
# of container group definition versions that match the request.
|
6834
7688
|
#
|
6835
7689
|
# <note markdown="1"> This operation returns the list of container group definitions in no
|
6836
7690
|
# particular order.
|
@@ -6847,15 +7701,10 @@ module Aws::GameLift
|
|
6847
7701
|
#
|
6848
7702
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html
|
6849
7703
|
#
|
6850
|
-
# @option params [String] :
|
6851
|
-
# The type of container group
|
6852
|
-
#
|
6853
|
-
#
|
6854
|
-
# deployed once per fleet instance.
|
6855
|
-
#
|
6856
|
-
# * `REPLICA` -- Replica container groups run your game server
|
6857
|
-
# application and supporting software. Replica groups might be
|
6858
|
-
# deployed multiple times per fleet instance.
|
7704
|
+
# @option params [String] :container_group_type
|
7705
|
+
# The type of container group to retrieve. Container group type
|
7706
|
+
# determines how Amazon GameLift deploys the container group on each
|
7707
|
+
# fleet instance.
|
6859
7708
|
#
|
6860
7709
|
# @option params [Integer] :limit
|
6861
7710
|
# The maximum number of results to return. Use this parameter with
|
@@ -6877,9 +7726,9 @@ module Aws::GameLift
|
|
6877
7726
|
# @example Request syntax with placeholder values
|
6878
7727
|
#
|
6879
7728
|
# resp = client.list_container_group_definitions({
|
6880
|
-
#
|
7729
|
+
# container_group_type: "GAME_SERVER", # accepts GAME_SERVER, PER_INSTANCE
|
6881
7730
|
# limit: 1,
|
6882
|
-
# next_token: "
|
7731
|
+
# next_token: "NonZeroAndMaxString",
|
6883
7732
|
# })
|
6884
7733
|
#
|
6885
7734
|
# @example Response structure
|
@@ -6889,38 +7738,56 @@ module Aws::GameLift
|
|
6889
7738
|
# resp.container_group_definitions[0].creation_time #=> Time
|
6890
7739
|
# resp.container_group_definitions[0].operating_system #=> String, one of "AMAZON_LINUX_2023"
|
6891
7740
|
# resp.container_group_definitions[0].name #=> String
|
6892
|
-
# resp.container_group_definitions[0].
|
6893
|
-
# resp.container_group_definitions[0].
|
6894
|
-
# resp.container_group_definitions[0].
|
6895
|
-
# resp.container_group_definitions[0].
|
6896
|
-
# resp.container_group_definitions[0].
|
6897
|
-
# resp.container_group_definitions[0].
|
6898
|
-
# resp.container_group_definitions[0].
|
6899
|
-
# resp.container_group_definitions[0].
|
6900
|
-
# resp.container_group_definitions[0].
|
6901
|
-
# resp.container_group_definitions[0].
|
6902
|
-
# resp.container_group_definitions[0].
|
6903
|
-
# resp.container_group_definitions[0].
|
6904
|
-
# resp.container_group_definitions[0].
|
6905
|
-
# resp.container_group_definitions[0].
|
6906
|
-
# resp.container_group_definitions[0].
|
6907
|
-
# resp.container_group_definitions[0].
|
6908
|
-
# resp.container_group_definitions[0].
|
6909
|
-
# resp.container_group_definitions[0].
|
6910
|
-
# resp.container_group_definitions[0].
|
6911
|
-
# resp.container_group_definitions[0].
|
6912
|
-
# resp.container_group_definitions[0].
|
6913
|
-
# resp.container_group_definitions[0].
|
6914
|
-
# resp.container_group_definitions[0].
|
6915
|
-
# resp.container_group_definitions[0].
|
6916
|
-
# resp.container_group_definitions[0].
|
6917
|
-
# resp.container_group_definitions[0].
|
6918
|
-
# resp.container_group_definitions[0].
|
6919
|
-
# resp.container_group_definitions[0].
|
6920
|
-
# resp.container_group_definitions[0].
|
6921
|
-
# resp.container_group_definitions[0].
|
6922
|
-
# resp.container_group_definitions[0].
|
6923
|
-
# resp.container_group_definitions[0].
|
7741
|
+
# resp.container_group_definitions[0].container_group_type #=> String, one of "GAME_SERVER", "PER_INSTANCE"
|
7742
|
+
# resp.container_group_definitions[0].total_memory_limit_mebibytes #=> Integer
|
7743
|
+
# resp.container_group_definitions[0].total_vcpu_limit #=> Float
|
7744
|
+
# resp.container_group_definitions[0].game_server_container_definition.container_name #=> String
|
7745
|
+
# resp.container_group_definitions[0].game_server_container_definition.depends_on #=> Array
|
7746
|
+
# resp.container_group_definitions[0].game_server_container_definition.depends_on[0].container_name #=> String
|
7747
|
+
# resp.container_group_definitions[0].game_server_container_definition.depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
7748
|
+
# resp.container_group_definitions[0].game_server_container_definition.mount_points #=> Array
|
7749
|
+
# resp.container_group_definitions[0].game_server_container_definition.mount_points[0].instance_path #=> String
|
7750
|
+
# resp.container_group_definitions[0].game_server_container_definition.mount_points[0].container_path #=> String
|
7751
|
+
# resp.container_group_definitions[0].game_server_container_definition.mount_points[0].access_level #=> String, one of "READ_ONLY", "READ_AND_WRITE"
|
7752
|
+
# resp.container_group_definitions[0].game_server_container_definition.environment_override #=> Array
|
7753
|
+
# resp.container_group_definitions[0].game_server_container_definition.environment_override[0].name #=> String
|
7754
|
+
# resp.container_group_definitions[0].game_server_container_definition.environment_override[0].value #=> String
|
7755
|
+
# resp.container_group_definitions[0].game_server_container_definition.image_uri #=> String
|
7756
|
+
# resp.container_group_definitions[0].game_server_container_definition.port_configuration.container_port_ranges #=> Array
|
7757
|
+
# resp.container_group_definitions[0].game_server_container_definition.port_configuration.container_port_ranges[0].from_port #=> Integer
|
7758
|
+
# resp.container_group_definitions[0].game_server_container_definition.port_configuration.container_port_ranges[0].to_port #=> Integer
|
7759
|
+
# resp.container_group_definitions[0].game_server_container_definition.port_configuration.container_port_ranges[0].protocol #=> String, one of "TCP", "UDP"
|
7760
|
+
# resp.container_group_definitions[0].game_server_container_definition.resolved_image_digest #=> String
|
7761
|
+
# resp.container_group_definitions[0].game_server_container_definition.server_sdk_version #=> String
|
7762
|
+
# resp.container_group_definitions[0].support_container_definitions #=> Array
|
7763
|
+
# resp.container_group_definitions[0].support_container_definitions[0].container_name #=> String
|
7764
|
+
# resp.container_group_definitions[0].support_container_definitions[0].depends_on #=> Array
|
7765
|
+
# resp.container_group_definitions[0].support_container_definitions[0].depends_on[0].container_name #=> String
|
7766
|
+
# resp.container_group_definitions[0].support_container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
7767
|
+
# resp.container_group_definitions[0].support_container_definitions[0].mount_points #=> Array
|
7768
|
+
# resp.container_group_definitions[0].support_container_definitions[0].mount_points[0].instance_path #=> String
|
7769
|
+
# resp.container_group_definitions[0].support_container_definitions[0].mount_points[0].container_path #=> String
|
7770
|
+
# resp.container_group_definitions[0].support_container_definitions[0].mount_points[0].access_level #=> String, one of "READ_ONLY", "READ_AND_WRITE"
|
7771
|
+
# resp.container_group_definitions[0].support_container_definitions[0].environment_override #=> Array
|
7772
|
+
# resp.container_group_definitions[0].support_container_definitions[0].environment_override[0].name #=> String
|
7773
|
+
# resp.container_group_definitions[0].support_container_definitions[0].environment_override[0].value #=> String
|
7774
|
+
# resp.container_group_definitions[0].support_container_definitions[0].essential #=> Boolean
|
7775
|
+
# resp.container_group_definitions[0].support_container_definitions[0].health_check.command #=> Array
|
7776
|
+
# resp.container_group_definitions[0].support_container_definitions[0].health_check.command[0] #=> String
|
7777
|
+
# resp.container_group_definitions[0].support_container_definitions[0].health_check.interval #=> Integer
|
7778
|
+
# resp.container_group_definitions[0].support_container_definitions[0].health_check.retries #=> Integer
|
7779
|
+
# resp.container_group_definitions[0].support_container_definitions[0].health_check.start_period #=> Integer
|
7780
|
+
# resp.container_group_definitions[0].support_container_definitions[0].health_check.timeout #=> Integer
|
7781
|
+
# resp.container_group_definitions[0].support_container_definitions[0].image_uri #=> String
|
7782
|
+
# resp.container_group_definitions[0].support_container_definitions[0].memory_hard_limit_mebibytes #=> Integer
|
7783
|
+
# resp.container_group_definitions[0].support_container_definitions[0].port_configuration.container_port_ranges #=> Array
|
7784
|
+
# resp.container_group_definitions[0].support_container_definitions[0].port_configuration.container_port_ranges[0].from_port #=> Integer
|
7785
|
+
# resp.container_group_definitions[0].support_container_definitions[0].port_configuration.container_port_ranges[0].to_port #=> Integer
|
7786
|
+
# resp.container_group_definitions[0].support_container_definitions[0].port_configuration.container_port_ranges[0].protocol #=> String, one of "TCP", "UDP"
|
7787
|
+
# resp.container_group_definitions[0].support_container_definitions[0].resolved_image_digest #=> String
|
7788
|
+
# resp.container_group_definitions[0].support_container_definitions[0].vcpu #=> Float
|
7789
|
+
# resp.container_group_definitions[0].version_number #=> Integer
|
7790
|
+
# resp.container_group_definitions[0].version_description #=> String
|
6924
7791
|
# resp.container_group_definitions[0].status #=> String, one of "READY", "COPYING", "FAILED"
|
6925
7792
|
# resp.container_group_definitions[0].status_reason #=> String
|
6926
7793
|
# resp.next_token #=> String
|
@@ -6934,9 +7801,87 @@ module Aws::GameLift
|
|
6934
7801
|
req.send_request(options)
|
6935
7802
|
end
|
6936
7803
|
|
6937
|
-
#
|
6938
|
-
#
|
7804
|
+
# Retrieves a collection of container fleet deployments in an Amazon Web
|
7805
|
+
# Services Region.
|
7806
|
+
#
|
7807
|
+
# **Request options**
|
7808
|
+
#
|
7809
|
+
# * Get a list of all deployments. Call this operation without
|
7810
|
+
# specifying a fleet ID.
|
7811
|
+
#
|
7812
|
+
# * Get a list of all deployments for a fleet. Specify the container
|
7813
|
+
# fleet ID or ARN value.
|
7814
|
+
#
|
7815
|
+
# * To get a list of all Realtime Servers fleets with a specific
|
7816
|
+
# configuration script, provide the script ID.
|
7817
|
+
#
|
7818
|
+
# Use the pagination parameters to retrieve results as a set of
|
7819
|
+
# sequential pages.
|
7820
|
+
#
|
7821
|
+
# **Results**
|
7822
|
+
#
|
7823
|
+
# If successful, this operation returns a list of deployments that match
|
7824
|
+
# the request parameters. A NextToken value is also returned if there
|
7825
|
+
# are more result pages to retrieve.
|
7826
|
+
#
|
7827
|
+
# <note markdown="1"> Fleet IDs are returned in no particular order.
|
7828
|
+
#
|
7829
|
+
# </note>
|
7830
|
+
#
|
7831
|
+
# @option params [String] :fleet_id
|
7832
|
+
# A unique identifier for the container fleet. You can use either the
|
7833
|
+
# fleet ID or ARN value.
|
7834
|
+
#
|
7835
|
+
# @option params [Integer] :limit
|
7836
|
+
# The maximum number of results to return. Use this parameter with
|
7837
|
+
# `NextToken` to get results as a set of sequential pages.
|
7838
|
+
#
|
7839
|
+
# @option params [String] :next_token
|
7840
|
+
# A token that indicates the start of the next sequential page of
|
7841
|
+
# results. Use the token that is returned with a previous call to this
|
7842
|
+
# operation. To start at the beginning of the result set, do not specify
|
7843
|
+
# a value.
|
7844
|
+
#
|
7845
|
+
# @return [Types::ListFleetDeploymentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7846
|
+
#
|
7847
|
+
# * {Types::ListFleetDeploymentsOutput#fleet_deployments #fleet_deployments} => Array<Types::FleetDeployment>
|
7848
|
+
# * {Types::ListFleetDeploymentsOutput#next_token #next_token} => String
|
7849
|
+
#
|
7850
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7851
|
+
#
|
7852
|
+
# @example Request syntax with placeholder values
|
7853
|
+
#
|
7854
|
+
# resp = client.list_fleet_deployments({
|
7855
|
+
# fleet_id: "FleetIdOrArn",
|
7856
|
+
# limit: 1,
|
7857
|
+
# next_token: "NonZeroAndMaxString",
|
7858
|
+
# })
|
7859
|
+
#
|
7860
|
+
# @example Response structure
|
7861
|
+
#
|
7862
|
+
# resp.fleet_deployments #=> Array
|
7863
|
+
# resp.fleet_deployments[0].deployment_id #=> String
|
7864
|
+
# resp.fleet_deployments[0].fleet_id #=> String
|
7865
|
+
# resp.fleet_deployments[0].game_server_binary_arn #=> String
|
7866
|
+
# resp.fleet_deployments[0].rollback_game_server_binary_arn #=> String
|
7867
|
+
# resp.fleet_deployments[0].per_instance_binary_arn #=> String
|
7868
|
+
# resp.fleet_deployments[0].rollback_per_instance_binary_arn #=> String
|
7869
|
+
# resp.fleet_deployments[0].deployment_status #=> String, one of "IN_PROGRESS", "IMPAIRED", "COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "CANCELLED", "PENDING"
|
7870
|
+
# resp.fleet_deployments[0].deployment_configuration.protection_strategy #=> String, one of "WITH_PROTECTION", "IGNORE_PROTECTION"
|
7871
|
+
# resp.fleet_deployments[0].deployment_configuration.minimum_healthy_percentage #=> Integer
|
7872
|
+
# resp.fleet_deployments[0].deployment_configuration.impairment_strategy #=> String, one of "MAINTAIN", "ROLLBACK"
|
7873
|
+
# resp.fleet_deployments[0].creation_time #=> Time
|
7874
|
+
# resp.next_token #=> String
|
7875
|
+
#
|
7876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListFleetDeployments AWS API Documentation
|
6939
7877
|
#
|
7878
|
+
# @overload list_fleet_deployments(params = {})
|
7879
|
+
# @param [Hash] params ({})
|
7880
|
+
def list_fleet_deployments(params = {}, options = {})
|
7881
|
+
req = build_request(:list_fleet_deployments, params)
|
7882
|
+
req.send_request(options)
|
7883
|
+
end
|
7884
|
+
|
6940
7885
|
# Retrieves a collection of fleet resources in an Amazon Web Services
|
6941
7886
|
# Region. You can filter the result set to find only those fleets that
|
6942
7887
|
# are deployed with a specific build or script. For fleets that have
|
@@ -6954,9 +7899,6 @@ module Aws::GameLift
|
|
6954
7899
|
# * To get a list of all Realtime Servers fleets with a specific
|
6955
7900
|
# configuration script, provide the script ID.
|
6956
7901
|
#
|
6957
|
-
# * To get a list of all fleets with a specific container group
|
6958
|
-
# definition, provide the `ContainerGroupDefinition` ID.
|
6959
|
-
#
|
6960
7902
|
# Use the pagination parameters to retrieve results as a set of
|
6961
7903
|
# sequential pages.
|
6962
7904
|
#
|
@@ -6978,11 +7920,6 @@ module Aws::GameLift
|
|
6978
7920
|
# this parameter to return only fleets using a specified script. Use
|
6979
7921
|
# either the script ID or ARN value.
|
6980
7922
|
#
|
6981
|
-
# @option params [String] :container_group_definition_name
|
6982
|
-
# The container group definition name to request fleets for. Use this
|
6983
|
-
# parameter to return only fleets that are deployed with the specified
|
6984
|
-
# container group definition.
|
6985
|
-
#
|
6986
7923
|
# @option params [Integer] :limit
|
6987
7924
|
# The maximum number of results to return. Use this parameter with
|
6988
7925
|
# `NextToken` to get results as a set of sequential pages.
|
@@ -7005,7 +7942,6 @@ module Aws::GameLift
|
|
7005
7942
|
# resp = client.list_fleets({
|
7006
7943
|
# build_id: "BuildIdOrArn",
|
7007
7944
|
# script_id: "ScriptIdOrArn",
|
7008
|
-
# container_group_definition_name: "ContainerGroupDefinitionNameOrArn",
|
7009
7945
|
# limit: 1,
|
7010
7946
|
# next_token: "NonZeroAndMaxString",
|
7011
7947
|
# })
|
@@ -7224,7 +8160,7 @@ module Aws::GameLift
|
|
7224
8160
|
# @option params [String] :next_token
|
7225
8161
|
# A token that indicates the start of the next sequential page of
|
7226
8162
|
# results. Use the token that is returned with a previous call to this
|
7227
|
-
# operation. To start at the beginning of the result set,
|
8163
|
+
# operation. To start at the beginning of the result set, do not specify
|
7228
8164
|
# a value.
|
7229
8165
|
#
|
7230
8166
|
# @return [Types::ListScriptsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -7536,16 +8472,12 @@ module Aws::GameLift
|
|
7536
8472
|
req.send_request(options)
|
7537
8473
|
end
|
7538
8474
|
|
7539
|
-
#
|
7540
|
-
# containers feature, which is currently in public preview.**
|
8475
|
+
# Registers a compute resource in an Amazon GameLift Anywhere fleet.
|
7541
8476
|
#
|
7542
|
-
#
|
7543
|
-
#
|
7544
|
-
#
|
7545
|
-
#
|
7546
|
-
# GameLift Agent, the Agent handles all compute registry tasks for you.
|
7547
|
-
# For an Anywhere fleet that doesn't use the Agent, call this operation
|
7548
|
-
# to register fleet computes.
|
8477
|
+
# For an Anywhere fleet that's running the Amazon GameLift Agent, the
|
8478
|
+
# Agent handles all compute registry tasks for you. For an Anywhere
|
8479
|
+
# fleet that doesn't use the Agent, call this operation to register
|
8480
|
+
# fleet computes.
|
7549
8481
|
#
|
7550
8482
|
# To register a compute, give the compute a name (must be unique within
|
7551
8483
|
# the fleet) and specify the compute resource's DNS name or IP address.
|
@@ -7625,7 +8557,7 @@ module Aws::GameLift
|
|
7625
8557
|
# resp.compute.compute_arn #=> String
|
7626
8558
|
# resp.compute.ip_address #=> String
|
7627
8559
|
# resp.compute.dns_name #=> String
|
7628
|
-
# resp.compute.compute_status #=> String, one of "PENDING", "ACTIVE", "TERMINATING"
|
8560
|
+
# resp.compute.compute_status #=> String, one of "PENDING", "ACTIVE", "TERMINATING", "IMPAIRED"
|
7629
8561
|
# resp.compute.location #=> String
|
7630
8562
|
# resp.compute.creation_time #=> Time
|
7631
8563
|
# resp.compute.operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2", "WINDOWS_2016", "AMAZON_LINUX_2023"
|
@@ -7633,10 +8565,10 @@ module Aws::GameLift
|
|
7633
8565
|
# resp.compute.game_lift_service_sdk_endpoint #=> String
|
7634
8566
|
# resp.compute.game_lift_agent_endpoint #=> String
|
7635
8567
|
# resp.compute.instance_id #=> String
|
7636
|
-
# resp.compute.container_attributes
|
7637
|
-
# resp.compute.container_attributes
|
7638
|
-
# resp.compute.container_attributes
|
7639
|
-
# resp.compute.
|
8568
|
+
# resp.compute.container_attributes #=> Array
|
8569
|
+
# resp.compute.container_attributes[0].container_name #=> String
|
8570
|
+
# resp.compute.container_attributes[0].container_runtime_id #=> String
|
8571
|
+
# resp.compute.game_server_container_group_definition_arn #=> String
|
7640
8572
|
#
|
7641
8573
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterCompute AWS API Documentation
|
7642
8574
|
#
|
@@ -8247,7 +9179,7 @@ module Aws::GameLift
|
|
8247
9179
|
# [DescribeGameSessionPlacement][1] and check the request's status. If
|
8248
9180
|
# the status is `FULFILLED`, a new game session has been created and a
|
8249
9181
|
# game session ARN and Region are referenced. If the placement request
|
8250
|
-
# times out,
|
9182
|
+
# times out, submit a new request to the same queue or a different
|
8251
9183
|
# queue.
|
8252
9184
|
#
|
8253
9185
|
#
|
@@ -8277,19 +9209,18 @@ module Aws::GameLift
|
|
8277
9209
|
#
|
8278
9210
|
# @option params [Array<Types::PlayerLatency>] :player_latencies
|
8279
9211
|
# A set of values, expressed in milliseconds, that indicates the amount
|
8280
|
-
# of latency that a player experiences when connected to
|
8281
|
-
#
|
8282
|
-
#
|
8283
|
-
# for the players.
|
9212
|
+
# of latency that a player experiences when connected to @aws; Regions.
|
9213
|
+
# This information is used to try to place the new game session where it
|
9214
|
+
# can offer the best possible gameplay experience for the players.
|
8284
9215
|
#
|
8285
9216
|
# @option params [Array<Types::DesiredPlayerSession>] :desired_player_sessions
|
8286
9217
|
# Set of information on each player to create a player session for.
|
8287
9218
|
#
|
8288
9219
|
# @option params [String] :game_session_data
|
8289
9220
|
# A set of custom game session properties, formatted as a single string
|
8290
|
-
# value. This data is passed to a game server process
|
8291
|
-
#
|
8292
|
-
#
|
9221
|
+
# value. This data is passed to a game server process with a request to
|
9222
|
+
# start a new game session. For more information, see [Start a game
|
9223
|
+
# session][1].
|
8293
9224
|
#
|
8294
9225
|
#
|
8295
9226
|
#
|
@@ -9095,12 +10026,12 @@ module Aws::GameLift
|
|
9095
10026
|
# build ID or ARN value.
|
9096
10027
|
#
|
9097
10028
|
# @option params [String] :name
|
9098
|
-
# A descriptive label associated with a build. Build names
|
9099
|
-
# to be unique.
|
10029
|
+
# A descriptive label that is associated with a build. Build names do
|
10030
|
+
# not need to be unique.
|
9100
10031
|
#
|
9101
10032
|
# @option params [String] :version
|
9102
|
-
# Version information associated with a build or script. Version
|
9103
|
-
#
|
10033
|
+
# Version information that is associated with a build or script. Version
|
10034
|
+
# strings do not need to be unique.
|
9104
10035
|
#
|
9105
10036
|
# @return [Types::UpdateBuildOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9106
10037
|
#
|
@@ -9135,6 +10066,486 @@ module Aws::GameLift
|
|
9135
10066
|
req.send_request(options)
|
9136
10067
|
end
|
9137
10068
|
|
10069
|
+
# Updates the properties of a managed container fleet. Depending on the
|
10070
|
+
# properties being updated, this operation might initiate a fleet
|
10071
|
+
# deployment. You can track deployments for a fleet using
|
10072
|
+
# DescribeFleetDeployment.
|
10073
|
+
#
|
10074
|
+
# **Request options**
|
10075
|
+
#
|
10076
|
+
# As with CreateContainerFleet, many fleet properties use common
|
10077
|
+
# defaults or are calculated based on the fleet's container group
|
10078
|
+
# definitions.
|
10079
|
+
#
|
10080
|
+
# * Update fleet properties that result in a fleet deployment. Include
|
10081
|
+
# only those properties that you want to change. Specify deployment
|
10082
|
+
# configuration settings.
|
10083
|
+
#
|
10084
|
+
# * Update fleet properties that don't result in a fleet deployment.
|
10085
|
+
# Include only those properties that you want to change.
|
10086
|
+
#
|
10087
|
+
# Changes to the following properties initiate a fleet deployment:
|
10088
|
+
#
|
10089
|
+
# * `GameServerContainerGroupDefinition`
|
10090
|
+
#
|
10091
|
+
# * `PerInstanceContainerGroupDefinition`
|
10092
|
+
#
|
10093
|
+
# * `GameServerContainerGroupsPerInstance`
|
10094
|
+
#
|
10095
|
+
# * `InstanceInboundPermissions`
|
10096
|
+
#
|
10097
|
+
# * `InstanceConnectionPortRange`
|
10098
|
+
#
|
10099
|
+
# * `LogConfiguration`
|
10100
|
+
#
|
10101
|
+
# **Results**
|
10102
|
+
#
|
10103
|
+
# If successful, this operation updates the container fleet resource,
|
10104
|
+
# and might initiate a new deployment of fleet resources using the
|
10105
|
+
# deployment configuration provided. A deployment replaces existing
|
10106
|
+
# fleet instances with new instances that are deployed with the updated
|
10107
|
+
# fleet properties. The fleet is placed in `UPDATING` status until the
|
10108
|
+
# deployment is complete, then return to `ACTIVE`.
|
10109
|
+
#
|
10110
|
+
# You can have only one update deployment active at a time for a fleet.
|
10111
|
+
# If a second update request initiates a deployment while another
|
10112
|
+
# deployment is in progress, the first deployment is cancelled.
|
10113
|
+
#
|
10114
|
+
# @option params [required, String] :fleet_id
|
10115
|
+
# A unique identifier for the container fleet to update. You can use
|
10116
|
+
# either the fleet ID or ARN value.
|
10117
|
+
#
|
10118
|
+
# @option params [String] :game_server_container_group_definition_name
|
10119
|
+
# The name or ARN value of a new game server container group definition
|
10120
|
+
# to deploy on the fleet. If you're updating the fleet to a specific
|
10121
|
+
# version of a container group definition, use the ARN value and include
|
10122
|
+
# the version number. If you're updating the fleet to the latest
|
10123
|
+
# version of a container group definition, you can use the name value.
|
10124
|
+
# You can't remove a fleet's game server container group definition,
|
10125
|
+
# you can only update or replace it with another definition.
|
10126
|
+
#
|
10127
|
+
# Update a container group definition by calling
|
10128
|
+
# UpdateContainerGroupDefinition. This operation creates a
|
10129
|
+
# ContainerGroupDefinition resource with an incremented version.
|
10130
|
+
#
|
10131
|
+
# @option params [String] :per_instance_container_group_definition_name
|
10132
|
+
# The name or ARN value of a new per-instance container group definition
|
10133
|
+
# to deploy on the fleet. If you're updating the fleet to a specific
|
10134
|
+
# version of a container group definition, use the ARN value and include
|
10135
|
+
# the version number. If you're updating the fleet to the latest
|
10136
|
+
# version of a container group definition, you can use the name value.
|
10137
|
+
#
|
10138
|
+
# Update a container group definition by calling
|
10139
|
+
# UpdateContainerGroupDefinition. This operation creates a
|
10140
|
+
# ContainerGroupDefinition resource with an incremented version.
|
10141
|
+
#
|
10142
|
+
# To remove a fleet's per-instance container group definition, leave
|
10143
|
+
# this parameter empty and use the parameter `RemoveAttributes`.
|
10144
|
+
#
|
10145
|
+
# @option params [Integer] :game_server_container_groups_per_instance
|
10146
|
+
# The number of times to replicate the game server container group on
|
10147
|
+
# each fleet instance. By default, Amazon GameLift calculates the
|
10148
|
+
# maximum number of game server container groups that can fit on each
|
10149
|
+
# instance. You can remove this property value to use the calculated
|
10150
|
+
# value, or set it manually. If you set this number manually, Amazon
|
10151
|
+
# GameLift uses your value as long as it's less than the calculated
|
10152
|
+
# maximum.
|
10153
|
+
#
|
10154
|
+
# @option params [Types::ConnectionPortRange] :instance_connection_port_range
|
10155
|
+
# A revised set of port numbers to open on each fleet instance. By
|
10156
|
+
# default, Amazon GameLift calculates an optimal port range based on
|
10157
|
+
# your fleet configuration. If you previously set this parameter
|
10158
|
+
# manually, you can't reset this to use the calculated settings.
|
10159
|
+
#
|
10160
|
+
# @option params [Array<Types::IpPermission>] :instance_inbound_permission_authorizations
|
10161
|
+
# A set of ports to add to the container fleet's inbound permissions.
|
10162
|
+
#
|
10163
|
+
# @option params [Array<Types::IpPermission>] :instance_inbound_permission_revocations
|
10164
|
+
# A set of ports to remove from the container fleet's inbound
|
10165
|
+
# permissions.
|
10166
|
+
#
|
10167
|
+
# @option params [Types::DeploymentConfiguration] :deployment_configuration
|
10168
|
+
# Instructions for how to deploy updates to a container fleet, if the
|
10169
|
+
# fleet update initiates a deployment. The deployment configuration lets
|
10170
|
+
# you determine how to replace fleet instances and what actions to take
|
10171
|
+
# if the deployment fails.
|
10172
|
+
#
|
10173
|
+
# @option params [String] :description
|
10174
|
+
# A meaningful description of the container fleet.
|
10175
|
+
#
|
10176
|
+
# @option params [Array<String>] :metric_groups
|
10177
|
+
# The name of an Amazon Web Services CloudWatch metric group to add this
|
10178
|
+
# fleet to.
|
10179
|
+
#
|
10180
|
+
# @option params [String] :new_game_session_protection_policy
|
10181
|
+
# The game session protection policy to apply to all new game sessions
|
10182
|
+
# that are started in this fleet. Game sessions that already exist are
|
10183
|
+
# not affected.
|
10184
|
+
#
|
10185
|
+
# @option params [Types::GameSessionCreationLimitPolicy] :game_session_creation_limit_policy
|
10186
|
+
# A policy that limits the number of game sessions that each individual
|
10187
|
+
# player can create on instances in this fleet. The limit applies for a
|
10188
|
+
# specified span of time.
|
10189
|
+
#
|
10190
|
+
# @option params [Types::LogConfiguration] :log_configuration
|
10191
|
+
# The method for collecting container logs for the fleet.
|
10192
|
+
#
|
10193
|
+
# @option params [Array<String>] :remove_attributes
|
10194
|
+
# If set, this update removes a fleet's per-instance container group
|
10195
|
+
# definition. You can't remove a fleet's game server container group
|
10196
|
+
# definition.
|
10197
|
+
#
|
10198
|
+
# @return [Types::UpdateContainerFleetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10199
|
+
#
|
10200
|
+
# * {Types::UpdateContainerFleetOutput#container_fleet #container_fleet} => Types::ContainerFleet
|
10201
|
+
#
|
10202
|
+
# @example Request syntax with placeholder values
|
10203
|
+
#
|
10204
|
+
# resp = client.update_container_fleet({
|
10205
|
+
# fleet_id: "FleetIdOrArn", # required
|
10206
|
+
# game_server_container_group_definition_name: "ContainerGroupDefinitionNameOrArn",
|
10207
|
+
# per_instance_container_group_definition_name: "ContainerGroupDefinitionNameOrArn",
|
10208
|
+
# game_server_container_groups_per_instance: 1,
|
10209
|
+
# instance_connection_port_range: {
|
10210
|
+
# from_port: 1, # required
|
10211
|
+
# to_port: 1, # required
|
10212
|
+
# },
|
10213
|
+
# instance_inbound_permission_authorizations: [
|
10214
|
+
# {
|
10215
|
+
# from_port: 1, # required
|
10216
|
+
# to_port: 1, # required
|
10217
|
+
# ip_range: "IpRange", # required
|
10218
|
+
# protocol: "TCP", # required, accepts TCP, UDP
|
10219
|
+
# },
|
10220
|
+
# ],
|
10221
|
+
# instance_inbound_permission_revocations: [
|
10222
|
+
# {
|
10223
|
+
# from_port: 1, # required
|
10224
|
+
# to_port: 1, # required
|
10225
|
+
# ip_range: "IpRange", # required
|
10226
|
+
# protocol: "TCP", # required, accepts TCP, UDP
|
10227
|
+
# },
|
10228
|
+
# ],
|
10229
|
+
# deployment_configuration: {
|
10230
|
+
# protection_strategy: "WITH_PROTECTION", # accepts WITH_PROTECTION, IGNORE_PROTECTION
|
10231
|
+
# minimum_healthy_percentage: 1,
|
10232
|
+
# impairment_strategy: "MAINTAIN", # accepts MAINTAIN, ROLLBACK
|
10233
|
+
# },
|
10234
|
+
# description: "NonZeroAndMaxString",
|
10235
|
+
# metric_groups: ["MetricGroup"],
|
10236
|
+
# new_game_session_protection_policy: "NoProtection", # accepts NoProtection, FullProtection
|
10237
|
+
# game_session_creation_limit_policy: {
|
10238
|
+
# new_game_sessions_per_creator: 1,
|
10239
|
+
# policy_period_in_minutes: 1,
|
10240
|
+
# },
|
10241
|
+
# log_configuration: {
|
10242
|
+
# log_destination: "NONE", # accepts NONE, CLOUDWATCH, S3
|
10243
|
+
# s3_bucket_name: "NonEmptyString",
|
10244
|
+
# log_group_arn: "LogGroupArnStringModel",
|
10245
|
+
# },
|
10246
|
+
# remove_attributes: ["PER_INSTANCE_CONTAINER_GROUP_DEFINITION"], # accepts PER_INSTANCE_CONTAINER_GROUP_DEFINITION
|
10247
|
+
# })
|
10248
|
+
#
|
10249
|
+
# @example Response structure
|
10250
|
+
#
|
10251
|
+
# resp.container_fleet.fleet_id #=> String
|
10252
|
+
# resp.container_fleet.fleet_arn #=> String
|
10253
|
+
# resp.container_fleet.fleet_role_arn #=> String
|
10254
|
+
# resp.container_fleet.game_server_container_group_definition_name #=> String
|
10255
|
+
# resp.container_fleet.game_server_container_group_definition_arn #=> String
|
10256
|
+
# resp.container_fleet.per_instance_container_group_definition_name #=> String
|
10257
|
+
# resp.container_fleet.per_instance_container_group_definition_arn #=> String
|
10258
|
+
# resp.container_fleet.instance_connection_port_range.from_port #=> Integer
|
10259
|
+
# resp.container_fleet.instance_connection_port_range.to_port #=> Integer
|
10260
|
+
# resp.container_fleet.instance_inbound_permissions #=> Array
|
10261
|
+
# resp.container_fleet.instance_inbound_permissions[0].from_port #=> Integer
|
10262
|
+
# resp.container_fleet.instance_inbound_permissions[0].to_port #=> Integer
|
10263
|
+
# resp.container_fleet.instance_inbound_permissions[0].ip_range #=> String
|
10264
|
+
# resp.container_fleet.instance_inbound_permissions[0].protocol #=> String, one of "TCP", "UDP"
|
10265
|
+
# resp.container_fleet.game_server_container_groups_per_instance #=> Integer
|
10266
|
+
# resp.container_fleet.maximum_game_server_container_groups_per_instance #=> Integer
|
10267
|
+
# resp.container_fleet.instance_type #=> String
|
10268
|
+
# resp.container_fleet.billing_type #=> String, one of "ON_DEMAND", "SPOT"
|
10269
|
+
# resp.container_fleet.description #=> String
|
10270
|
+
# resp.container_fleet.creation_time #=> Time
|
10271
|
+
# resp.container_fleet.metric_groups #=> Array
|
10272
|
+
# resp.container_fleet.metric_groups[0] #=> String
|
10273
|
+
# resp.container_fleet.new_game_session_protection_policy #=> String, one of "NoProtection", "FullProtection"
|
10274
|
+
# resp.container_fleet.game_session_creation_limit_policy.new_game_sessions_per_creator #=> Integer
|
10275
|
+
# resp.container_fleet.game_session_creation_limit_policy.policy_period_in_minutes #=> Integer
|
10276
|
+
# resp.container_fleet.status #=> String, one of "PENDING", "CREATING", "CREATED", "ACTIVATING", "ACTIVE", "UPDATING", "DELETING"
|
10277
|
+
# resp.container_fleet.deployment_details.latest_deployment_id #=> String
|
10278
|
+
# resp.container_fleet.log_configuration.log_destination #=> String, one of "NONE", "CLOUDWATCH", "S3"
|
10279
|
+
# resp.container_fleet.log_configuration.s3_bucket_name #=> String
|
10280
|
+
# resp.container_fleet.log_configuration.log_group_arn #=> String
|
10281
|
+
# resp.container_fleet.location_attributes #=> Array
|
10282
|
+
# resp.container_fleet.location_attributes[0].location #=> String
|
10283
|
+
# resp.container_fleet.location_attributes[0].status #=> String, one of "PENDING", "CREATING", "CREATED", "ACTIVATING", "ACTIVE", "UPDATING", "DELETING"
|
10284
|
+
#
|
10285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateContainerFleet AWS API Documentation
|
10286
|
+
#
|
10287
|
+
# @overload update_container_fleet(params = {})
|
10288
|
+
# @param [Hash] params ({})
|
10289
|
+
def update_container_fleet(params = {}, options = {})
|
10290
|
+
req = build_request(:update_container_fleet, params)
|
10291
|
+
req.send_request(options)
|
10292
|
+
end
|
10293
|
+
|
10294
|
+
# Updates properties in an existing container group definition. This
|
10295
|
+
# operation doesn't replace the definition. Instead, it creates a new
|
10296
|
+
# version of the definition and saves it separately. You can access all
|
10297
|
+
# versions that you choose to retain.
|
10298
|
+
#
|
10299
|
+
# The only property you can't update is the container group type.
|
10300
|
+
#
|
10301
|
+
# **Request options:**
|
10302
|
+
#
|
10303
|
+
# * Update based on the latest version of the container group
|
10304
|
+
# definition. Specify the container group definition name only, or use
|
10305
|
+
# an ARN value without a version number. Provide updated values for
|
10306
|
+
# the properties that you want to change only. All other values remain
|
10307
|
+
# the same as the latest version.
|
10308
|
+
#
|
10309
|
+
# * Update based on a specific version of the container group
|
10310
|
+
# definition. Specify the container group definition name and a source
|
10311
|
+
# version number, or use an ARN value with a version number. Provide
|
10312
|
+
# updated values for the properties that you want to change only. All
|
10313
|
+
# other values remain the same as the source version.
|
10314
|
+
#
|
10315
|
+
# * Change a game server container definition. Provide the updated
|
10316
|
+
# container definition.
|
10317
|
+
#
|
10318
|
+
# * Add or change a support container definition. Provide a complete set
|
10319
|
+
# of container definitions, including the updated definition.
|
10320
|
+
#
|
10321
|
+
# * Remove a support container definition. Provide a complete set of
|
10322
|
+
# container definitions, excluding the definition to remove. If the
|
10323
|
+
# container group has only one support container definition, provide
|
10324
|
+
# an empty set.
|
10325
|
+
#
|
10326
|
+
# **Results:**
|
10327
|
+
#
|
10328
|
+
# If successful, this operation returns the complete properties of the
|
10329
|
+
# new container group definition version.
|
10330
|
+
#
|
10331
|
+
# If the container group definition version is used in an active fleets,
|
10332
|
+
# the update automatically initiates a new fleet deployment of the new
|
10333
|
+
# version. You can track a fleet's deployments using
|
10334
|
+
# ListFleetDeployments.
|
10335
|
+
#
|
10336
|
+
# @option params [required, String] :name
|
10337
|
+
# A descriptive identifier for the container group definition. The name
|
10338
|
+
# value must be unique in an Amazon Web Services Region.
|
10339
|
+
#
|
10340
|
+
# @option params [Types::GameServerContainerDefinitionInput] :game_server_container_definition
|
10341
|
+
# An updated definition for the game server container in this group.
|
10342
|
+
# Define a game server container only when the container group type is
|
10343
|
+
# `GAME_SERVER`. You can pass in your container definitions as a JSON
|
10344
|
+
# file.
|
10345
|
+
#
|
10346
|
+
# @option params [Array<Types::SupportContainerDefinitionInput>] :support_container_definitions
|
10347
|
+
# One or more definitions for support containers in this group. You can
|
10348
|
+
# define a support container in any type of container group. You can
|
10349
|
+
# pass in your container definitions as a JSON file.
|
10350
|
+
#
|
10351
|
+
# @option params [Integer] :total_memory_limit_mebibytes
|
10352
|
+
# The maximum amount of memory (in MiB) to allocate to the container
|
10353
|
+
# group. All containers in the group share this memory. If you specify
|
10354
|
+
# memory limits for an individual container, the total value must be
|
10355
|
+
# greater than any individual container's memory limit.
|
10356
|
+
#
|
10357
|
+
# @option params [Float] :total_vcpu_limit
|
10358
|
+
# The maximum amount of vCPU units to allocate to the container group (1
|
10359
|
+
# vCPU is equal to 1024 CPU units). All containers in the group share
|
10360
|
+
# this memory. If you specify vCPU limits for individual containers, the
|
10361
|
+
# total value must be equal to or greater than the sum of the CPU limits
|
10362
|
+
# for all containers in the group.
|
10363
|
+
#
|
10364
|
+
# @option params [String] :version_description
|
10365
|
+
# A description for this update to the container group definition.
|
10366
|
+
#
|
10367
|
+
# @option params [Integer] :source_version_number
|
10368
|
+
# The container group definition version to update. The new version
|
10369
|
+
# starts with values from the source version, and then updates values
|
10370
|
+
# included in this request.
|
10371
|
+
#
|
10372
|
+
# @option params [String] :operating_system
|
10373
|
+
# The platform that all containers in the group use. Containers in a
|
10374
|
+
# group must run on the same operating system.
|
10375
|
+
#
|
10376
|
+
# <note markdown="1"> Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more
|
10377
|
+
# details in the [Amazon Linux 2 FAQs][1]. For game servers that are
|
10378
|
+
# hosted on AL2 and use Amazon GameLift server SDK 4.x, first update the
|
10379
|
+
# game server build to server SDK 5.x, and then deploy to AL2023
|
10380
|
+
# instances. See [ Migrate to Amazon GameLift server SDK version 5.][2]
|
10381
|
+
#
|
10382
|
+
# </note>
|
10383
|
+
#
|
10384
|
+
#
|
10385
|
+
#
|
10386
|
+
# [1]: https://aws.amazon.com/amazon-linux-2/faqs/
|
10387
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html
|
10388
|
+
#
|
10389
|
+
# @return [Types::UpdateContainerGroupDefinitionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10390
|
+
#
|
10391
|
+
# * {Types::UpdateContainerGroupDefinitionOutput#container_group_definition #container_group_definition} => Types::ContainerGroupDefinition
|
10392
|
+
#
|
10393
|
+
# @example Request syntax with placeholder values
|
10394
|
+
#
|
10395
|
+
# resp = client.update_container_group_definition({
|
10396
|
+
# name: "ContainerGroupDefinitionNameOrArn", # required
|
10397
|
+
# game_server_container_definition: {
|
10398
|
+
# container_name: "NonZeroAnd128MaxAsciiString", # required
|
10399
|
+
# depends_on: [
|
10400
|
+
# {
|
10401
|
+
# container_name: "NonZeroAnd128MaxAsciiString", # required
|
10402
|
+
# condition: "START", # required, accepts START, COMPLETE, SUCCESS, HEALTHY
|
10403
|
+
# },
|
10404
|
+
# ],
|
10405
|
+
# mount_points: [
|
10406
|
+
# {
|
10407
|
+
# instance_path: "InstancePathString", # required
|
10408
|
+
# container_path: "ContainerPathString",
|
10409
|
+
# access_level: "READ_ONLY", # accepts READ_ONLY, READ_AND_WRITE
|
10410
|
+
# },
|
10411
|
+
# ],
|
10412
|
+
# environment_override: [
|
10413
|
+
# {
|
10414
|
+
# name: "NonZeroAnd255MaxString", # required
|
10415
|
+
# value: "NonZeroAnd255MaxString", # required
|
10416
|
+
# },
|
10417
|
+
# ],
|
10418
|
+
# image_uri: "ImageUriString", # required
|
10419
|
+
# port_configuration: { # required
|
10420
|
+
# container_port_ranges: [ # required
|
10421
|
+
# {
|
10422
|
+
# from_port: 1, # required
|
10423
|
+
# to_port: 1, # required
|
10424
|
+
# protocol: "TCP", # required, accepts TCP, UDP
|
10425
|
+
# },
|
10426
|
+
# ],
|
10427
|
+
# },
|
10428
|
+
# server_sdk_version: "ServerSdkVersion", # required
|
10429
|
+
# },
|
10430
|
+
# support_container_definitions: [
|
10431
|
+
# {
|
10432
|
+
# container_name: "NonZeroAnd128MaxAsciiString", # required
|
10433
|
+
# depends_on: [
|
10434
|
+
# {
|
10435
|
+
# container_name: "NonZeroAnd128MaxAsciiString", # required
|
10436
|
+
# condition: "START", # required, accepts START, COMPLETE, SUCCESS, HEALTHY
|
10437
|
+
# },
|
10438
|
+
# ],
|
10439
|
+
# mount_points: [
|
10440
|
+
# {
|
10441
|
+
# instance_path: "InstancePathString", # required
|
10442
|
+
# container_path: "ContainerPathString",
|
10443
|
+
# access_level: "READ_ONLY", # accepts READ_ONLY, READ_AND_WRITE
|
10444
|
+
# },
|
10445
|
+
# ],
|
10446
|
+
# environment_override: [
|
10447
|
+
# {
|
10448
|
+
# name: "NonZeroAnd255MaxString", # required
|
10449
|
+
# value: "NonZeroAnd255MaxString", # required
|
10450
|
+
# },
|
10451
|
+
# ],
|
10452
|
+
# essential: false,
|
10453
|
+
# health_check: {
|
10454
|
+
# command: ["NonZeroAnd255MaxString"], # required
|
10455
|
+
# interval: 1,
|
10456
|
+
# retries: 1,
|
10457
|
+
# start_period: 1,
|
10458
|
+
# timeout: 1,
|
10459
|
+
# },
|
10460
|
+
# image_uri: "ImageUriString", # required
|
10461
|
+
# memory_hard_limit_mebibytes: 1,
|
10462
|
+
# port_configuration: {
|
10463
|
+
# container_port_ranges: [ # required
|
10464
|
+
# {
|
10465
|
+
# from_port: 1, # required
|
10466
|
+
# to_port: 1, # required
|
10467
|
+
# protocol: "TCP", # required, accepts TCP, UDP
|
10468
|
+
# },
|
10469
|
+
# ],
|
10470
|
+
# },
|
10471
|
+
# vcpu: 1.0,
|
10472
|
+
# },
|
10473
|
+
# ],
|
10474
|
+
# total_memory_limit_mebibytes: 1,
|
10475
|
+
# total_vcpu_limit: 1.0,
|
10476
|
+
# version_description: "NonZeroAndMaxString",
|
10477
|
+
# source_version_number: 1,
|
10478
|
+
# operating_system: "AMAZON_LINUX_2023", # accepts AMAZON_LINUX_2023
|
10479
|
+
# })
|
10480
|
+
#
|
10481
|
+
# @example Response structure
|
10482
|
+
#
|
10483
|
+
# resp.container_group_definition.container_group_definition_arn #=> String
|
10484
|
+
# resp.container_group_definition.creation_time #=> Time
|
10485
|
+
# resp.container_group_definition.operating_system #=> String, one of "AMAZON_LINUX_2023"
|
10486
|
+
# resp.container_group_definition.name #=> String
|
10487
|
+
# resp.container_group_definition.container_group_type #=> String, one of "GAME_SERVER", "PER_INSTANCE"
|
10488
|
+
# resp.container_group_definition.total_memory_limit_mebibytes #=> Integer
|
10489
|
+
# resp.container_group_definition.total_vcpu_limit #=> Float
|
10490
|
+
# resp.container_group_definition.game_server_container_definition.container_name #=> String
|
10491
|
+
# resp.container_group_definition.game_server_container_definition.depends_on #=> Array
|
10492
|
+
# resp.container_group_definition.game_server_container_definition.depends_on[0].container_name #=> String
|
10493
|
+
# resp.container_group_definition.game_server_container_definition.depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
10494
|
+
# resp.container_group_definition.game_server_container_definition.mount_points #=> Array
|
10495
|
+
# resp.container_group_definition.game_server_container_definition.mount_points[0].instance_path #=> String
|
10496
|
+
# resp.container_group_definition.game_server_container_definition.mount_points[0].container_path #=> String
|
10497
|
+
# resp.container_group_definition.game_server_container_definition.mount_points[0].access_level #=> String, one of "READ_ONLY", "READ_AND_WRITE"
|
10498
|
+
# resp.container_group_definition.game_server_container_definition.environment_override #=> Array
|
10499
|
+
# resp.container_group_definition.game_server_container_definition.environment_override[0].name #=> String
|
10500
|
+
# resp.container_group_definition.game_server_container_definition.environment_override[0].value #=> String
|
10501
|
+
# resp.container_group_definition.game_server_container_definition.image_uri #=> String
|
10502
|
+
# resp.container_group_definition.game_server_container_definition.port_configuration.container_port_ranges #=> Array
|
10503
|
+
# resp.container_group_definition.game_server_container_definition.port_configuration.container_port_ranges[0].from_port #=> Integer
|
10504
|
+
# resp.container_group_definition.game_server_container_definition.port_configuration.container_port_ranges[0].to_port #=> Integer
|
10505
|
+
# resp.container_group_definition.game_server_container_definition.port_configuration.container_port_ranges[0].protocol #=> String, one of "TCP", "UDP"
|
10506
|
+
# resp.container_group_definition.game_server_container_definition.resolved_image_digest #=> String
|
10507
|
+
# resp.container_group_definition.game_server_container_definition.server_sdk_version #=> String
|
10508
|
+
# resp.container_group_definition.support_container_definitions #=> Array
|
10509
|
+
# resp.container_group_definition.support_container_definitions[0].container_name #=> String
|
10510
|
+
# resp.container_group_definition.support_container_definitions[0].depends_on #=> Array
|
10511
|
+
# resp.container_group_definition.support_container_definitions[0].depends_on[0].container_name #=> String
|
10512
|
+
# resp.container_group_definition.support_container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
|
10513
|
+
# resp.container_group_definition.support_container_definitions[0].mount_points #=> Array
|
10514
|
+
# resp.container_group_definition.support_container_definitions[0].mount_points[0].instance_path #=> String
|
10515
|
+
# resp.container_group_definition.support_container_definitions[0].mount_points[0].container_path #=> String
|
10516
|
+
# resp.container_group_definition.support_container_definitions[0].mount_points[0].access_level #=> String, one of "READ_ONLY", "READ_AND_WRITE"
|
10517
|
+
# resp.container_group_definition.support_container_definitions[0].environment_override #=> Array
|
10518
|
+
# resp.container_group_definition.support_container_definitions[0].environment_override[0].name #=> String
|
10519
|
+
# resp.container_group_definition.support_container_definitions[0].environment_override[0].value #=> String
|
10520
|
+
# resp.container_group_definition.support_container_definitions[0].essential #=> Boolean
|
10521
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.command #=> Array
|
10522
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.command[0] #=> String
|
10523
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.interval #=> Integer
|
10524
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.retries #=> Integer
|
10525
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.start_period #=> Integer
|
10526
|
+
# resp.container_group_definition.support_container_definitions[0].health_check.timeout #=> Integer
|
10527
|
+
# resp.container_group_definition.support_container_definitions[0].image_uri #=> String
|
10528
|
+
# resp.container_group_definition.support_container_definitions[0].memory_hard_limit_mebibytes #=> Integer
|
10529
|
+
# resp.container_group_definition.support_container_definitions[0].port_configuration.container_port_ranges #=> Array
|
10530
|
+
# resp.container_group_definition.support_container_definitions[0].port_configuration.container_port_ranges[0].from_port #=> Integer
|
10531
|
+
# resp.container_group_definition.support_container_definitions[0].port_configuration.container_port_ranges[0].to_port #=> Integer
|
10532
|
+
# resp.container_group_definition.support_container_definitions[0].port_configuration.container_port_ranges[0].protocol #=> String, one of "TCP", "UDP"
|
10533
|
+
# resp.container_group_definition.support_container_definitions[0].resolved_image_digest #=> String
|
10534
|
+
# resp.container_group_definition.support_container_definitions[0].vcpu #=> Float
|
10535
|
+
# resp.container_group_definition.version_number #=> Integer
|
10536
|
+
# resp.container_group_definition.version_description #=> String
|
10537
|
+
# resp.container_group_definition.status #=> String, one of "READY", "COPYING", "FAILED"
|
10538
|
+
# resp.container_group_definition.status_reason #=> String
|
10539
|
+
#
|
10540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateContainerGroupDefinition AWS API Documentation
|
10541
|
+
#
|
10542
|
+
# @overload update_container_group_definition(params = {})
|
10543
|
+
# @param [Hash] params ({})
|
10544
|
+
def update_container_group_definition(params = {}, options = {})
|
10545
|
+
req = build_request(:update_container_group_definition, params)
|
10546
|
+
req.send_request(options)
|
10547
|
+
end
|
10548
|
+
|
9138
10549
|
# Updates a fleet's mutable attributes, such as game session protection
|
9139
10550
|
# and resource creation limits.
|
9140
10551
|
#
|
@@ -9165,7 +10576,7 @@ module Aws::GameLift
|
|
9165
10576
|
# The game session protection policy to apply to all new game sessions
|
9166
10577
|
# created in this fleet. Game sessions that already exist are not
|
9167
10578
|
# affected. You can set protection for individual game sessions using
|
9168
|
-
# [UpdateGameSession][1]
|
10579
|
+
# [UpdateGameSession][1].
|
9169
10580
|
#
|
9170
10581
|
# * **NoProtection** -- The game session can be terminated during a
|
9171
10582
|
# scale-down event.
|
@@ -9227,11 +10638,8 @@ module Aws::GameLift
|
|
9227
10638
|
req.send_request(options)
|
9228
10639
|
end
|
9229
10640
|
|
9230
|
-
#
|
9231
|
-
#
|
9232
|
-
#
|
9233
|
-
# Updates capacity settings for a managed EC2 fleet or container fleet.
|
9234
|
-
# For these fleets, you adjust capacity by changing the number of
|
10641
|
+
# Updates capacity settings for a managed EC2 fleet or managed container
|
10642
|
+
# fleet. For these fleets, you adjust capacity by changing the number of
|
9235
10643
|
# instances in the fleet. Fleet capacity determines the number of game
|
9236
10644
|
# sessions and players that the fleet can host based on its
|
9237
10645
|
# configuration. For fleets with multiple locations, use this operation
|
@@ -9765,18 +11173,15 @@ module Aws::GameLift
|
|
9765
11173
|
# @option params [Integer] :timeout_in_seconds
|
9766
11174
|
# The maximum time, in seconds, that a new game session placement
|
9767
11175
|
# request remains in the queue. When a request exceeds this time, the
|
9768
|
-
# game session placement changes to a `TIMED_OUT` status.
|
9769
|
-
# this property is set to `600`.
|
11176
|
+
# game session placement changes to a `TIMED_OUT` status.
|
9770
11177
|
#
|
9771
11178
|
# @option params [Array<Types::PlayerLatencyPolicy>] :player_latency_policies
|
9772
|
-
# A set of policies that
|
9773
|
-
#
|
9774
|
-
#
|
9775
|
-
#
|
9776
|
-
#
|
9777
|
-
#
|
9778
|
-
# lowest value. When updating policies, provide a complete collection of
|
9779
|
-
# policies.
|
11179
|
+
# A set of policies that enforce a sliding cap on player latency when
|
11180
|
+
# processing game sessions placement requests. Use multiple policies to
|
11181
|
+
# gradually relax the cap over time if Amazon GameLift can't make a
|
11182
|
+
# placement. Policies are evaluated in order starting with the lowest
|
11183
|
+
# maximum latency value. When updating policies, provide a complete
|
11184
|
+
# collection of policies.
|
9780
11185
|
#
|
9781
11186
|
# @option params [Array<Types::GameSessionQueueDestination>] :destinations
|
9782
11187
|
# A list of fleets and/or fleet aliases that can be used to fulfill game
|
@@ -9940,10 +11345,9 @@ module Aws::GameLift
|
|
9940
11345
|
# @option params [Integer] :additional_player_count
|
9941
11346
|
# The number of player slots in a match to keep open for future players.
|
9942
11347
|
# For example, if the configuration's rule set specifies a match for a
|
9943
|
-
# single
|
9944
|
-
# players
|
9945
|
-
#
|
9946
|
-
# is set to `STANDALONE`.
|
11348
|
+
# single 12-person team, and the additional player count is set to 2,
|
11349
|
+
# only 10 players are selected for the match. This parameter is not used
|
11350
|
+
# if `FlexMatchMode` is set to `STANDALONE`.
|
9947
11351
|
#
|
9948
11352
|
# @option params [String] :custom_event_data
|
9949
11353
|
# Information to add to all events related to the matchmaking
|
@@ -9959,10 +11363,10 @@ module Aws::GameLift
|
|
9959
11363
|
# @option params [String] :game_session_data
|
9960
11364
|
# A set of custom game session properties, formatted as a single string
|
9961
11365
|
# value. This data is passed to a game server process with a request to
|
9962
|
-
# start a new game session
|
9963
|
-
# information is added to the game session that is
|
9964
|
-
# successful match. This parameter is not used if
|
9965
|
-
# to `STANDALONE`.
|
11366
|
+
# start a new game session. For more information, see [Start a game
|
11367
|
+
# session][1]. This information is added to the game session that is
|
11368
|
+
# created for a successful match. This parameter is not used if
|
11369
|
+
# `FlexMatchMode` is set to `STANDALONE`.
|
9966
11370
|
#
|
9967
11371
|
#
|
9968
11372
|
#
|
@@ -10059,11 +11463,9 @@ module Aws::GameLift
|
|
10059
11463
|
|
10060
11464
|
# Updates the runtime configuration for the specified fleet. The runtime
|
10061
11465
|
# configuration tells Amazon GameLift how to launch server processes on
|
10062
|
-
# computes in
|
10063
|
-
#
|
10064
|
-
#
|
10065
|
-
# group. You can update a fleet's runtime configuration at any time
|
10066
|
-
# after the fleet is created; it does not need to be in `ACTIVE` status.
|
11466
|
+
# computes in managed EC2 and Anywhere fleets. You can update a fleet's
|
11467
|
+
# runtime configuration at any time after the fleet is created; it does
|
11468
|
+
# not need to be in `ACTIVE` status.
|
10067
11469
|
#
|
10068
11470
|
# To update runtime configuration, specify the fleet ID and provide a
|
10069
11471
|
# `RuntimeConfiguration` with an updated set of server process
|
@@ -10168,12 +11570,12 @@ module Aws::GameLift
|
|
10168
11570
|
# either the script ID or ARN value.
|
10169
11571
|
#
|
10170
11572
|
# @option params [String] :name
|
10171
|
-
# A descriptive label that is associated with a script. Script names
|
10172
|
-
#
|
11573
|
+
# A descriptive label that is associated with a script. Script names do
|
11574
|
+
# not need to be unique.
|
10173
11575
|
#
|
10174
11576
|
# @option params [String] :version
|
10175
|
-
# Version information associated with a build or script. Version
|
10176
|
-
#
|
11577
|
+
# Version information that is associated with a build or script. Version
|
11578
|
+
# strings do not need to be unique.
|
10177
11579
|
#
|
10178
11580
|
# @option params [Types::S3Location] :storage_location
|
10179
11581
|
# The location of the Amazon S3 bucket where a zipped file containing
|
@@ -10296,7 +11698,7 @@ module Aws::GameLift
|
|
10296
11698
|
tracer: tracer
|
10297
11699
|
)
|
10298
11700
|
context[:gem_name] = 'aws-sdk-gamelift'
|
10299
|
-
context[:gem_version] = '1.
|
11701
|
+
context[:gem_version] = '1.96.0'
|
10300
11702
|
Seahorse::Client::Request.new(handlers, context)
|
10301
11703
|
end
|
10302
11704
|
|