aws-sdk-gamelift 1.76.0 → 1.77.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-gamelift/client.rb +1012 -287
- data/lib/aws-sdk-gamelift/client_api.rb +292 -0
- data/lib/aws-sdk-gamelift/endpoints.rb +56 -0
- data/lib/aws-sdk-gamelift/errors.rb +16 -0
- data/lib/aws-sdk-gamelift/plugins/endpoints.rb +8 -0
- data/lib/aws-sdk-gamelift/types.rb +1551 -192
- data/lib/aws-sdk-gamelift.rb +1 -1
- data/sig/client.rbs +104 -2
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +198 -2
- metadata +2 -2
@@ -105,8 +105,7 @@ module Aws::GameLift
|
|
105
105
|
include Aws::Structure
|
106
106
|
end
|
107
107
|
|
108
|
-
# Amazon GameLift
|
109
|
-
# fleets.
|
108
|
+
# Amazon GameLift configuration options for your Anywhere fleets.
|
110
109
|
#
|
111
110
|
# @!attribute [rw] cost
|
112
111
|
# The cost to run your fleet per hour. Amazon GameLift uses the
|
@@ -302,6 +301,9 @@ module Aws::GameLift
|
|
302
301
|
include Aws::Structure
|
303
302
|
end
|
304
303
|
|
304
|
+
# **This data type has been expanded to use with the Amazon GameLift
|
305
|
+
# containers feature, which is currently in public preview.**
|
306
|
+
#
|
305
307
|
# Determines whether a TLS/SSL certificate is generated for a fleet.
|
306
308
|
# This feature must be enabled when creating the fleet. All instances in
|
307
309
|
# a fleet share the same certificate. The certificate can be retrieved
|
@@ -396,9 +398,20 @@ module Aws::GameLift
|
|
396
398
|
include Aws::Structure
|
397
399
|
end
|
398
400
|
|
399
|
-
#
|
400
|
-
#
|
401
|
-
#
|
401
|
+
# **This data type has been expanded to use with the Amazon GameLift
|
402
|
+
# containers feature, which is currently in public preview.**
|
403
|
+
#
|
404
|
+
# An Amazon GameLift compute resource for hosting your game servers.
|
405
|
+
# Computes in an Amazon GameLift fleet differs depending on the fleet's
|
406
|
+
# compute type property as follows:
|
407
|
+
#
|
408
|
+
# * For `EC2` fleets, a compute is an EC2 instance.
|
409
|
+
#
|
410
|
+
# * For `ANYWHERE` fleets, a compute is a computing resource that you
|
411
|
+
# provide and is registered to the fleet.
|
412
|
+
#
|
413
|
+
# * For `CONTAINER` fleets, a compute is a container that's registered
|
414
|
+
# to the fleet.
|
402
415
|
#
|
403
416
|
# @!attribute [rw] fleet_id
|
404
417
|
# A unique identifier for the fleet that the compute belongs to.
|
@@ -411,13 +424,14 @@ module Aws::GameLift
|
|
411
424
|
#
|
412
425
|
# @!attribute [rw] compute_name
|
413
426
|
# A descriptive label for the compute resource. For instances in a
|
414
|
-
# managed EC2 fleet, the compute name is
|
427
|
+
# managed EC2 fleet, the compute name is the same value as the
|
428
|
+
# `InstanceId` ID.
|
415
429
|
# @return [String]
|
416
430
|
#
|
417
431
|
# @!attribute [rw] compute_arn
|
418
432
|
# The ARN that is assigned to a compute resource and uniquely
|
419
433
|
# identifies it. ARNs are unique across locations. Instances in
|
420
|
-
# managed EC2 fleets are not assigned a
|
434
|
+
# managed EC2 fleets are not assigned a Compute ARN.
|
421
435
|
# @return [String]
|
422
436
|
#
|
423
437
|
# @!attribute [rw] ip_address
|
@@ -440,59 +454,1051 @@ module Aws::GameLift
|
|
440
454
|
# compute resource resides in.
|
441
455
|
# @return [String]
|
442
456
|
#
|
443
|
-
# @!attribute [rw] creation_time
|
444
|
-
# A time stamp indicating when this data object was created. Format is
|
445
|
-
# a number expressed in Unix time as milliseconds (for example
|
446
|
-
# `"1469498468.057"`).
|
447
|
-
# @return [Time]
|
457
|
+
# @!attribute [rw] creation_time
|
458
|
+
# A time stamp indicating when this data object was created. Format is
|
459
|
+
# a number expressed in Unix time as milliseconds (for example
|
460
|
+
# `"1469498468.057"`).
|
461
|
+
# @return [Time]
|
462
|
+
#
|
463
|
+
# @!attribute [rw] operating_system
|
464
|
+
# The type of operating system on the compute resource.
|
465
|
+
# @return [String]
|
466
|
+
#
|
467
|
+
# @!attribute [rw] type
|
468
|
+
# The Amazon EC2 instance type that the fleet uses. For registered
|
469
|
+
# computes in an Amazon GameLift Anywhere fleet, this property is
|
470
|
+
# empty.
|
471
|
+
# @return [String]
|
472
|
+
#
|
473
|
+
# @!attribute [rw] game_lift_service_sdk_endpoint
|
474
|
+
# The Amazon GameLift SDK endpoint connection for a registered compute
|
475
|
+
# resource in an Anywhere fleet. The game servers on the compute use
|
476
|
+
# this endpoint to connect to the Amazon GameLift service.
|
477
|
+
# @return [String]
|
478
|
+
#
|
479
|
+
# @!attribute [rw] game_lift_agent_endpoint
|
480
|
+
# The endpoint of the Amazon GameLift Agent.
|
481
|
+
# @return [String]
|
482
|
+
#
|
483
|
+
# @!attribute [rw] instance_id
|
484
|
+
# The `InstanceID` of the `Instance` hosting the compute for Container
|
485
|
+
# and Managed EC2 fleets.
|
486
|
+
# @return [String]
|
487
|
+
#
|
488
|
+
# @!attribute [rw] container_attributes
|
489
|
+
# Some attributes of a container.
|
490
|
+
# @return [Types::ContainerAttributes]
|
491
|
+
#
|
492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/Compute AWS API Documentation
|
493
|
+
#
|
494
|
+
class Compute < Struct.new(
|
495
|
+
:fleet_id,
|
496
|
+
:fleet_arn,
|
497
|
+
:compute_name,
|
498
|
+
:compute_arn,
|
499
|
+
:ip_address,
|
500
|
+
:dns_name,
|
501
|
+
:compute_status,
|
502
|
+
:location,
|
503
|
+
:creation_time,
|
504
|
+
:operating_system,
|
505
|
+
:type,
|
506
|
+
:game_lift_service_sdk_endpoint,
|
507
|
+
:game_lift_agent_endpoint,
|
508
|
+
:instance_id,
|
509
|
+
:container_attributes)
|
510
|
+
SENSITIVE = [:ip_address]
|
511
|
+
include Aws::Structure
|
512
|
+
end
|
513
|
+
|
514
|
+
# The requested operation would cause a conflict with the current state
|
515
|
+
# of a service resource associated with the request. Resolve the
|
516
|
+
# conflict before retrying this request.
|
517
|
+
#
|
518
|
+
# @!attribute [rw] message
|
519
|
+
# @return [String]
|
520
|
+
#
|
521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ConflictException AWS API Documentation
|
522
|
+
#
|
523
|
+
class ConflictException < Struct.new(
|
524
|
+
:message)
|
525
|
+
SENSITIVE = []
|
526
|
+
include Aws::Structure
|
527
|
+
end
|
528
|
+
|
529
|
+
# **This operation has been expanded to use with the Amazon GameLift
|
530
|
+
# containers feature, which is currently in public preview.**
|
531
|
+
#
|
532
|
+
# The set of port numbers to open on each instance in a container fleet.
|
533
|
+
# Connection ports are used by inbound traffic to connect with processes
|
534
|
+
# that are running in containers on the fleet.
|
535
|
+
#
|
536
|
+
# **Part of:** ContainerGroupsConfiguration, ContainerGroupsAttributes
|
537
|
+
#
|
538
|
+
# @!attribute [rw] from_port
|
539
|
+
# Starting value for the port range.
|
540
|
+
# @return [Integer]
|
541
|
+
#
|
542
|
+
# @!attribute [rw] to_port
|
543
|
+
# Ending value for the port. Port numbers are end-inclusive. This
|
544
|
+
# value must be equal to or greater than `FromPort`.
|
545
|
+
# @return [Integer]
|
546
|
+
#
|
547
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ConnectionPortRange AWS API Documentation
|
548
|
+
#
|
549
|
+
class ConnectionPortRange < Struct.new(
|
550
|
+
:from_port,
|
551
|
+
:to_port)
|
552
|
+
SENSITIVE = [:from_port, :to_port]
|
553
|
+
include Aws::Structure
|
554
|
+
end
|
555
|
+
|
556
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
557
|
+
# which is currently in public preview.**
|
558
|
+
#
|
559
|
+
# Describes attributes of containers that are deployed to a fleet with
|
560
|
+
# compute type `CONTAINER`.
|
561
|
+
#
|
562
|
+
# @!attribute [rw] container_port_mappings
|
563
|
+
# Describes how container ports map to connection ports on the fleet
|
564
|
+
# instance. Incoming traffic connects to a game via a connection port.
|
565
|
+
# A `ContainerPortMapping` directs the traffic from a connection port
|
566
|
+
# to a port on the container that hosts the game session.
|
567
|
+
# @return [Array<Types::ContainerPortMapping>]
|
568
|
+
#
|
569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerAttributes AWS API Documentation
|
570
|
+
#
|
571
|
+
class ContainerAttributes < Struct.new(
|
572
|
+
:container_port_mappings)
|
573
|
+
SENSITIVE = []
|
574
|
+
include Aws::Structure
|
575
|
+
end
|
576
|
+
|
577
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
578
|
+
# which is currently in public preview.**
|
579
|
+
#
|
580
|
+
# Describes a container in a container fleet, the resources available to
|
581
|
+
# the container, and the commands that are run when the container
|
582
|
+
# starts. Container properties can't be updated. To change a property,
|
583
|
+
# create a new container group definition. See also
|
584
|
+
# ContainerDefinitionInput.
|
585
|
+
#
|
586
|
+
# **Part of:** ContainerGroupDefinition
|
587
|
+
#
|
588
|
+
# **Returned by:** DescribeContainerGroupDefinition,
|
589
|
+
# ListContainerGroupDefinitions
|
590
|
+
#
|
591
|
+
# @!attribute [rw] container_name
|
592
|
+
# The container definition identifier. Container names are unique
|
593
|
+
# within a container group definition.
|
594
|
+
# @return [String]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] image_uri
|
597
|
+
# The URI to the image that $short; copied and deployed to a container
|
598
|
+
# fleet. For a more specific identifier, see `ResolvedImageDigest`.
|
599
|
+
# @return [String]
|
600
|
+
#
|
601
|
+
# @!attribute [rw] resolved_image_digest
|
602
|
+
# A unique and immutable identifier for the container image that is
|
603
|
+
# deployed to a container fleet. The digest is a SHA 256 hash of the
|
604
|
+
# container image manifest.
|
605
|
+
# @return [String]
|
606
|
+
#
|
607
|
+
# @!attribute [rw] memory_limits
|
608
|
+
# The amount of memory that Amazon GameLift makes available to the
|
609
|
+
# container. If memory limits aren't set for an individual container,
|
610
|
+
# the container shares the container group's total memory allocation.
|
611
|
+
#
|
612
|
+
# <b>Related data type: </b> ContainerGroupDefinition$TotalMemoryLimit
|
613
|
+
# @return [Types::ContainerMemoryLimits]
|
614
|
+
#
|
615
|
+
# @!attribute [rw] port_configuration
|
616
|
+
# Defines the ports that are available to assign to processes in the
|
617
|
+
# container. For example, a game server process requires a container
|
618
|
+
# port to allow game clients to connect to it. Container ports aren't
|
619
|
+
# directly accessed by inbound traffic. Amazon GameLift maps these
|
620
|
+
# container ports to externally accessible connection ports, which are
|
621
|
+
# assigned as needed from the container fleet's
|
622
|
+
# `ConnectionPortRange`.
|
623
|
+
# @return [Types::ContainerPortConfiguration]
|
624
|
+
#
|
625
|
+
# @!attribute [rw] cpu
|
626
|
+
# The number of CPU units that are reserved for the container. Note: 1
|
627
|
+
# vCPU unit equals 1024 CPU units. If no resources are reserved, the
|
628
|
+
# container shares the total CPU limit for the container group.
|
629
|
+
#
|
630
|
+
# <b>Related data type: </b> ContainerGroupDefinition$TotalCpuLimit
|
631
|
+
# @return [Integer]
|
632
|
+
#
|
633
|
+
# @!attribute [rw] health_check
|
634
|
+
# A configuration for a non-terminal health check. A container, which
|
635
|
+
# automatically restarts if it stops functioning, also restarts if it
|
636
|
+
# fails this health check. If an essential container in the daemon
|
637
|
+
# group fails a health check, the entire container group is restarted.
|
638
|
+
# The essential container in the replica group doesn't use this
|
639
|
+
# health check mechanism, because the Amazon GameLift Agent
|
640
|
+
# automatically handles the task.
|
641
|
+
# @return [Types::ContainerHealthCheck]
|
642
|
+
#
|
643
|
+
# @!attribute [rw] command
|
644
|
+
# A command that's passed to the container on startup. Each argument
|
645
|
+
# for the command is an additional string in the array. See the
|
646
|
+
# [ContainerDefinition::command][1] parameter in the *Amazon Elastic
|
647
|
+
# Container Service API reference.*
|
648
|
+
#
|
649
|
+
#
|
650
|
+
#
|
651
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-command
|
652
|
+
# @return [Array<String>]
|
653
|
+
#
|
654
|
+
# @!attribute [rw] essential
|
655
|
+
# Indicates whether the container is vital to the container group. If
|
656
|
+
# an essential container fails, the entire container group is
|
657
|
+
# restarted.
|
658
|
+
# @return [Boolean]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] entry_point
|
661
|
+
# The entry point that's passed to the container on startup. If there
|
662
|
+
# are multiple arguments, each argument is an additional string in the
|
663
|
+
# array. See the [ContainerDefinition::entryPoint][1] parameter in the
|
664
|
+
# *Amazon Elastic Container Service API Reference*.
|
665
|
+
#
|
666
|
+
#
|
667
|
+
#
|
668
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-entryPoint
|
669
|
+
# @return [Array<String>]
|
670
|
+
#
|
671
|
+
# @!attribute [rw] working_directory
|
672
|
+
# The directory in the container where commands are run. See the
|
673
|
+
# [ContainerDefinition::workingDirectory][1] parameter in the *Amazon
|
674
|
+
# Elastic Container Service API Reference*.
|
675
|
+
#
|
676
|
+
#
|
677
|
+
#
|
678
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-workingDirectory
|
679
|
+
# @return [String]
|
680
|
+
#
|
681
|
+
# @!attribute [rw] environment
|
682
|
+
# A set of environment variables that's passed to the container on
|
683
|
+
# startup. See the [ContainerDefinition::environment][1] parameter in
|
684
|
+
# the *Amazon Elastic Container Service API Reference*.
|
685
|
+
#
|
686
|
+
#
|
687
|
+
#
|
688
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment
|
689
|
+
# @return [Array<Types::ContainerEnvironment>]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] depends_on
|
692
|
+
# Indicates that the container relies on the status of other
|
693
|
+
# containers in the same container group during its startup and
|
694
|
+
# shutdown sequences. A container might have dependencies on multiple
|
695
|
+
# containers.
|
696
|
+
# @return [Array<Types::ContainerDependency>]
|
697
|
+
#
|
698
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerDefinition AWS API Documentation
|
699
|
+
#
|
700
|
+
class ContainerDefinition < Struct.new(
|
701
|
+
:container_name,
|
702
|
+
:image_uri,
|
703
|
+
:resolved_image_digest,
|
704
|
+
:memory_limits,
|
705
|
+
:port_configuration,
|
706
|
+
:cpu,
|
707
|
+
:health_check,
|
708
|
+
:command,
|
709
|
+
:essential,
|
710
|
+
:entry_point,
|
711
|
+
:working_directory,
|
712
|
+
:environment,
|
713
|
+
:depends_on)
|
714
|
+
SENSITIVE = []
|
715
|
+
include Aws::Structure
|
716
|
+
end
|
717
|
+
|
718
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
719
|
+
# which is currently in public preview.**
|
720
|
+
#
|
721
|
+
# Describes a container's configuration, resources, and start
|
722
|
+
# instructions. Use this data type to create a container group
|
723
|
+
# definition. For the properties of a container that's been deployed to
|
724
|
+
# a fleet, see ContainerDefinition. You can't change these properties
|
725
|
+
# after you've created the container group definition. If you need a
|
726
|
+
# container group with different properties, then you must create a new
|
727
|
+
# one.
|
728
|
+
#
|
729
|
+
# <b>Used with: </b> CreateContainerGroupDefinition
|
730
|
+
#
|
731
|
+
# @!attribute [rw] container_name
|
732
|
+
# A string that uniquely identifies the container definition within a
|
733
|
+
# container group.
|
734
|
+
# @return [String]
|
735
|
+
#
|
736
|
+
# @!attribute [rw] image_uri
|
737
|
+
# The location of a container image that $short; will copy and deploy
|
738
|
+
# to a container fleet. Images in Amazon Elastic Container Registry
|
739
|
+
# private repositories are supported. The repository must be in the
|
740
|
+
# same Amazon Web Services account and Amazon Web Services Region
|
741
|
+
# where you're creating the container group definition. For limits on
|
742
|
+
# image size, see [Amazon GameLift endpoints and quotas][1]. You can
|
743
|
+
# use any of the following image URI formats:
|
744
|
+
#
|
745
|
+
# * Image ID only: `[AWS account].dkr.ecr.[AWS
|
746
|
+
# region].amazonaws.com/[repository ID]`
|
747
|
+
#
|
748
|
+
# * Image ID and digest: `[AWS account].dkr.ecr.[AWS
|
749
|
+
# region].amazonaws.com/[repository ID]@[digest]`
|
750
|
+
#
|
751
|
+
# * Image ID and tag: `[AWS account].dkr.ecr.[AWS
|
752
|
+
# region].amazonaws.com/[repository ID]:[tag]`
|
753
|
+
#
|
754
|
+
#
|
755
|
+
#
|
756
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/gamelift.html
|
757
|
+
# @return [String]
|
758
|
+
#
|
759
|
+
# @!attribute [rw] memory_limits
|
760
|
+
# The amount of memory to make available to the container. If you
|
761
|
+
# don't specify memory limits for this container, then it shares the
|
762
|
+
# container group's total memory allocation.
|
763
|
+
#
|
764
|
+
# <b>Related data type: </b> ContainerGroupDefinition$TotalMemoryLimit
|
765
|
+
# @return [Types::ContainerMemoryLimits]
|
766
|
+
#
|
767
|
+
# @!attribute [rw] port_configuration
|
768
|
+
# A set of ports that Amazon GameLift can assign to processes in the
|
769
|
+
# container. All processes that accept inbound traffic connections,
|
770
|
+
# including game server processes, must be assigned a port from this
|
771
|
+
# set. The set of ports must be large enough to assign one to each
|
772
|
+
# process in the container that needs one. If the container includes
|
773
|
+
# your game server, include enough ports to assign one port to each
|
774
|
+
# concurrent server process (as defined in a container fleet's
|
775
|
+
# RuntimeConfiguration). For more details, see [Networking for
|
776
|
+
# container fleets][1].
|
777
|
+
#
|
778
|
+
# Container ports aren't directly accessed by inbound traffic. Amazon
|
779
|
+
# GameLift maps these container ports to externally accessible
|
780
|
+
# connection ports, which are assigned as needed from the container
|
781
|
+
# fleet's `ConnectionPortRange`.
|
782
|
+
#
|
783
|
+
#
|
784
|
+
#
|
785
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-network
|
786
|
+
# @return [Types::ContainerPortConfiguration]
|
787
|
+
#
|
788
|
+
# @!attribute [rw] cpu
|
789
|
+
# The number of CPU units to reserve for this container. The container
|
790
|
+
# can use more resources when needed, if available. Note: 1 vCPU unit
|
791
|
+
# equals 1024 CPU units. If you don't reserve CPU units for this
|
792
|
+
# container, then it shares the total CPU limit for the container
|
793
|
+
# group. This property is similar to the Amazon ECS container
|
794
|
+
# definition parameter [environment][1] (*Amazon Elastic Container
|
795
|
+
# Service Developer Guide).*
|
796
|
+
#
|
797
|
+
# <b>Related data type: </b> ContainerGroupDefinition$TotalCpuLimit
|
798
|
+
#
|
799
|
+
#
|
800
|
+
#
|
801
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_environment
|
802
|
+
# @return [Integer]
|
803
|
+
#
|
804
|
+
# @!attribute [rw] health_check
|
805
|
+
# Configuration for a non-terminal health check. A container
|
806
|
+
# automatically restarts if it stops functioning. This parameter lets
|
807
|
+
# you define additional reasons to consider a container unhealthy and
|
808
|
+
# restart it. You can set a health check for any container except for
|
809
|
+
# the essential container in the replica container group. If an
|
810
|
+
# essential container in the daemon group fails a health check, the
|
811
|
+
# entire container group is restarted.
|
812
|
+
# @return [Types::ContainerHealthCheck]
|
813
|
+
#
|
814
|
+
# @!attribute [rw] command
|
815
|
+
# A command to pass to the container on startup. Add multiple
|
816
|
+
# arguments as additional strings in the array. See the
|
817
|
+
# [ContainerDefinition command][1] parameter in the *Amazon Elastic
|
818
|
+
# Container Service API reference.*
|
819
|
+
#
|
820
|
+
#
|
821
|
+
#
|
822
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-command
|
823
|
+
# @return [Array<String>]
|
824
|
+
#
|
825
|
+
# @!attribute [rw] essential
|
826
|
+
# Specifies whether the container is vital for the container group to
|
827
|
+
# function properly. If an essential container fails, it causes the
|
828
|
+
# entire container group to restart. Each container group must have an
|
829
|
+
# essential container.
|
830
|
+
#
|
831
|
+
# **Replica container groups** - A replica group must have exactly one
|
832
|
+
# essential container. Use the following to configure an essential
|
833
|
+
# replica container:
|
834
|
+
#
|
835
|
+
# * Choose a container is running your game server and the Amazon
|
836
|
+
# GameLift Agent.
|
837
|
+
#
|
838
|
+
# * Include a port configuration. This container runs your game server
|
839
|
+
# processes, and each process requires a container port to allow
|
840
|
+
# access to game clients.
|
841
|
+
#
|
842
|
+
# * Don't configure a health check. The Agent handles this task for
|
843
|
+
# the essential replica container.
|
844
|
+
#
|
845
|
+
# **Daemon container groups** - A daemon group must have at least one
|
846
|
+
# essential container.
|
847
|
+
# @return [Boolean]
|
848
|
+
#
|
849
|
+
# @!attribute [rw] entry_point
|
850
|
+
# An entry point to pass to the container on startup. Add multiple
|
851
|
+
# arguments as additional strings in the array. See the
|
852
|
+
# [ContainerDefinition::entryPoint][1] parameter in the *Amazon
|
853
|
+
# Elastic Container Service API Reference*.
|
854
|
+
#
|
855
|
+
#
|
856
|
+
#
|
857
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-entryPoint
|
858
|
+
# @return [Array<String>]
|
859
|
+
#
|
860
|
+
# @!attribute [rw] working_directory
|
861
|
+
# The directory in the container where commands are run. See the
|
862
|
+
# [ContainerDefinition::workingDirectory parameter][1] in the *Amazon
|
863
|
+
# Elastic Container Service API Reference*.
|
864
|
+
#
|
865
|
+
#
|
866
|
+
#
|
867
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-workingDirectory
|
868
|
+
# @return [String]
|
869
|
+
#
|
870
|
+
# @!attribute [rw] environment
|
871
|
+
# A set of environment variables to pass to the container on startup.
|
872
|
+
# See the [ContainerDefinition::environment][1] parameter in the
|
873
|
+
# *Amazon Elastic Container Service API Reference*.
|
874
|
+
#
|
875
|
+
#
|
876
|
+
#
|
877
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment
|
878
|
+
# @return [Array<Types::ContainerEnvironment>]
|
879
|
+
#
|
880
|
+
# @!attribute [rw] depends_on
|
881
|
+
# Sets up dependencies between this container and the status of other
|
882
|
+
# containers in the same container group. A container can have
|
883
|
+
# dependencies on multiple different containers.
|
884
|
+
#
|
885
|
+
# You can use dependencies to establish a startup/shutdown sequence
|
886
|
+
# across the container group. A container startup dependency is
|
887
|
+
# reversed on shutdown.
|
888
|
+
#
|
889
|
+
# For example, you might specify that SideCarContainerB has a `START`
|
890
|
+
# dependency on SideCarContainerA. This dependency means that
|
891
|
+
# SideCarContainerB can't start until after SideCarContainerA has
|
892
|
+
# started. This dependency is reversed on shutdown, which means that
|
893
|
+
# SideCarContainerB must shut down before SideCarContainerA can shut
|
894
|
+
# down.
|
895
|
+
# @return [Array<Types::ContainerDependency>]
|
896
|
+
#
|
897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerDefinitionInput AWS API Documentation
|
898
|
+
#
|
899
|
+
class ContainerDefinitionInput < Struct.new(
|
900
|
+
:container_name,
|
901
|
+
:image_uri,
|
902
|
+
:memory_limits,
|
903
|
+
:port_configuration,
|
904
|
+
:cpu,
|
905
|
+
:health_check,
|
906
|
+
:command,
|
907
|
+
:essential,
|
908
|
+
:entry_point,
|
909
|
+
:working_directory,
|
910
|
+
:environment,
|
911
|
+
:depends_on)
|
912
|
+
SENSITIVE = []
|
913
|
+
include Aws::Structure
|
914
|
+
end
|
915
|
+
|
916
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
917
|
+
# which is currently in public preview.**
|
918
|
+
#
|
919
|
+
# A container's dependency on another container in the same container
|
920
|
+
# group. The dependency impacts how the dependent container is able to
|
921
|
+
# start or shut down based the status of the other container.
|
922
|
+
#
|
923
|
+
# For example, ContainerA is configured with the following dependency: a
|
924
|
+
# `START` dependency on ContainerB. This means that ContainerA can't
|
925
|
+
# start until ContainerB has started. It also means that ContainerA must
|
926
|
+
# shut down before ContainerB.
|
927
|
+
#
|
928
|
+
# **Part of:** ContainerDefinition
|
929
|
+
#
|
930
|
+
# @!attribute [rw] container_name
|
931
|
+
# A descriptive label for the container definition that this container
|
932
|
+
# depends on.
|
933
|
+
# @return [String]
|
934
|
+
#
|
935
|
+
# @!attribute [rw] condition
|
936
|
+
# The condition that the dependency container must reach before the
|
937
|
+
# dependent container can start. Valid conditions include:
|
938
|
+
#
|
939
|
+
# * START - The dependency container must have started.
|
940
|
+
#
|
941
|
+
# * COMPLETE - The dependency container has run to completion (exits).
|
942
|
+
# Use this condition with nonessential containers, such as those
|
943
|
+
# that run a script and then exit. The dependency container can't
|
944
|
+
# be an essential container.
|
945
|
+
#
|
946
|
+
# * SUCCESS - The dependency container has run to completion and
|
947
|
+
# exited with a zero status. The dependency container can't be an
|
948
|
+
# essential container.
|
949
|
+
#
|
950
|
+
# * HEALTHY - The dependency container has passed its Docker health
|
951
|
+
# check. Use this condition with dependency containers that have
|
952
|
+
# health checks configured. This condition is confirmed at container
|
953
|
+
# group startup only.
|
954
|
+
# @return [String]
|
955
|
+
#
|
956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerDependency AWS API Documentation
|
957
|
+
#
|
958
|
+
class ContainerDependency < Struct.new(
|
959
|
+
:container_name,
|
960
|
+
:condition)
|
961
|
+
SENSITIVE = []
|
962
|
+
include Aws::Structure
|
963
|
+
end
|
964
|
+
|
965
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
966
|
+
# which is currently in public preview.**
|
967
|
+
#
|
968
|
+
# An environment variable to set inside a container, in the form of a
|
969
|
+
# key-value pair.
|
970
|
+
#
|
971
|
+
# <b>Related data type: </b> ContainerDefinition$Environment
|
972
|
+
#
|
973
|
+
# @!attribute [rw] name
|
974
|
+
# The environment variable name.
|
975
|
+
# @return [String]
|
976
|
+
#
|
977
|
+
# @!attribute [rw] value
|
978
|
+
# The environment variable value.
|
979
|
+
# @return [String]
|
980
|
+
#
|
981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerEnvironment AWS API Documentation
|
982
|
+
#
|
983
|
+
class ContainerEnvironment < Struct.new(
|
984
|
+
:name,
|
985
|
+
:value)
|
986
|
+
SENSITIVE = []
|
987
|
+
include Aws::Structure
|
988
|
+
end
|
989
|
+
|
990
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
991
|
+
# which is currently in public preview.**
|
992
|
+
#
|
993
|
+
# The properties that describe a container group resource. Container
|
994
|
+
# group definition properties can't be updated. To change a property,
|
995
|
+
# create a new container group definition.
|
996
|
+
#
|
997
|
+
# **Used with:** CreateContainerGroupDefinition
|
998
|
+
#
|
999
|
+
# **Returned by:** DescribeContainerGroupDefinition,
|
1000
|
+
# ListContainerGroupDefinitions
|
1001
|
+
#
|
1002
|
+
# @!attribute [rw] container_group_definition_arn
|
1003
|
+
# The Amazon Resource Name ([ARN][1]) that is assigned to an Amazon
|
1004
|
+
# GameLift `ContainerGroupDefinition` resource. It uniquely identifies
|
1005
|
+
# the resource across all Amazon Web Services Regions. Format is
|
1006
|
+
# `arn:aws:gamelift:<region>::containergroupdefinition/[container
|
1007
|
+
# group definition name]`.
|
1008
|
+
#
|
1009
|
+
#
|
1010
|
+
#
|
1011
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
1012
|
+
# @return [String]
|
1013
|
+
#
|
1014
|
+
# @!attribute [rw] creation_time
|
1015
|
+
# A time stamp indicating when this data object was created. Format is
|
1016
|
+
# a number expressed in Unix time as milliseconds (for example
|
1017
|
+
# `"1469498468.057"`).
|
1018
|
+
# @return [Time]
|
1019
|
+
#
|
1020
|
+
# @!attribute [rw] operating_system
|
1021
|
+
# The platform required for all containers in the container group
|
1022
|
+
# definition.
|
1023
|
+
# @return [String]
|
1024
|
+
#
|
1025
|
+
# @!attribute [rw] name
|
1026
|
+
# A descriptive identifier for the container group definition. The
|
1027
|
+
# name value is unique in an Amazon Web Services Region.
|
1028
|
+
# @return [String]
|
1029
|
+
#
|
1030
|
+
# @!attribute [rw] scheduling_strategy
|
1031
|
+
# The method for deploying the container group across fleet instances.
|
1032
|
+
# A replica container group might have multiple copies on each fleet
|
1033
|
+
# instance. A daemon container group maintains only one copy per fleet
|
1034
|
+
# instance.
|
1035
|
+
# @return [String]
|
1036
|
+
#
|
1037
|
+
# @!attribute [rw] total_memory_limit
|
1038
|
+
# The amount of memory (in MiB) on a fleet instance to allocate for
|
1039
|
+
# the container group. All containers in the group share these
|
1040
|
+
# resources.
|
1041
|
+
#
|
1042
|
+
# You can set additional limits for each ContainerDefinition in the
|
1043
|
+
# group. If individual containers have limits, this value must meet
|
1044
|
+
# the following requirements:
|
1045
|
+
#
|
1046
|
+
# * Equal to or greater than the sum of all container-specific soft
|
1047
|
+
# memory limits in the group.
|
1048
|
+
#
|
1049
|
+
# * Equal to or greater than any container-specific hard limits in the
|
1050
|
+
# group.
|
1051
|
+
#
|
1052
|
+
# For more details on memory allocation, see the [Container fleet
|
1053
|
+
# design guide][1].
|
1054
|
+
#
|
1055
|
+
#
|
1056
|
+
#
|
1057
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet
|
1058
|
+
# @return [Integer]
|
1059
|
+
#
|
1060
|
+
# @!attribute [rw] total_cpu_limit
|
1061
|
+
# The amount of CPU units on a fleet instance to allocate for the
|
1062
|
+
# container group. All containers in the group share these resources.
|
1063
|
+
# This property is an integer value in CPU units (1 vCPU is equal to
|
1064
|
+
# 1024 CPU units).
|
1065
|
+
#
|
1066
|
+
# You can set additional limits for each ContainerDefinition in the
|
1067
|
+
# group. If individual containers have limits, this value must be
|
1068
|
+
# equal to or greater than the sum of all container-specific CPU
|
1069
|
+
# limits in the group.
|
1070
|
+
#
|
1071
|
+
# For more details on memory allocation, see the [Container fleet
|
1072
|
+
# design guide][1].
|
1073
|
+
#
|
1074
|
+
#
|
1075
|
+
#
|
1076
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet
|
1077
|
+
# @return [Integer]
|
1078
|
+
#
|
1079
|
+
# @!attribute [rw] container_definitions
|
1080
|
+
# The set of container definitions that are included in the container
|
1081
|
+
# group.
|
1082
|
+
# @return [Array<Types::ContainerDefinition>]
|
1083
|
+
#
|
1084
|
+
# @!attribute [rw] status
|
1085
|
+
# Current status of the container group definition resource. Values
|
1086
|
+
# include:
|
1087
|
+
#
|
1088
|
+
# * `COPYING` -- Amazon GameLift is in the process of making copies of
|
1089
|
+
# all container images that are defined in the group. While in this
|
1090
|
+
# state, the resource can't be used to create a container fleet.
|
1091
|
+
#
|
1092
|
+
# * `READY` -- Amazon GameLift has copied the registry images for all
|
1093
|
+
# containers that are defined in the group. You can use a container
|
1094
|
+
# group definition in this status to create a container fleet.
|
1095
|
+
#
|
1096
|
+
# * `FAILED` -- Amazon GameLift failed to create a valid container
|
1097
|
+
# group definition resource. For more details on the cause of the
|
1098
|
+
# failure, see `StatusReason`. A container group definition resource
|
1099
|
+
# in failed status will be deleted within a few minutes.
|
1100
|
+
# @return [String]
|
1101
|
+
#
|
1102
|
+
# @!attribute [rw] status_reason
|
1103
|
+
# Additional information about a container group definition that's in
|
1104
|
+
# `FAILED` status. Possible reasons include:
|
1105
|
+
#
|
1106
|
+
# * An internal issue prevented Amazon GameLift from creating the
|
1107
|
+
# container group definition resource. Delete the failed resource
|
1108
|
+
# and call CreateContainerGroupDefinitionagain.
|
1109
|
+
#
|
1110
|
+
# * An access-denied message means that you don't have permissions to
|
1111
|
+
# access the container image on ECR. See [ IAM permission
|
1112
|
+
# examples][1] for help setting up required IAM permissions for
|
1113
|
+
# Amazon GameLift.
|
1114
|
+
#
|
1115
|
+
# * The `ImageUri` value for at least one of the containers in the
|
1116
|
+
# container group definition was invalid or not found in the current
|
1117
|
+
# Amazon Web Services account.
|
1118
|
+
#
|
1119
|
+
# * At least one of the container images referenced in the container
|
1120
|
+
# group definition exceeds the allowed size. For size limits, see [
|
1121
|
+
# Amazon GameLift endpoints and quotas][2].
|
1122
|
+
#
|
1123
|
+
# * At least one of the container images referenced in the container
|
1124
|
+
# group definition uses a different operating system than the one
|
1125
|
+
# defined for the container group.
|
1126
|
+
#
|
1127
|
+
#
|
1128
|
+
#
|
1129
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html
|
1130
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/gamelift.html
|
1131
|
+
# @return [String]
|
1132
|
+
#
|
1133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerGroupDefinition AWS API Documentation
|
1134
|
+
#
|
1135
|
+
class ContainerGroupDefinition < Struct.new(
|
1136
|
+
:container_group_definition_arn,
|
1137
|
+
:creation_time,
|
1138
|
+
:operating_system,
|
1139
|
+
:name,
|
1140
|
+
:scheduling_strategy,
|
1141
|
+
:total_memory_limit,
|
1142
|
+
:total_cpu_limit,
|
1143
|
+
:container_definitions,
|
1144
|
+
:status,
|
1145
|
+
:status_reason)
|
1146
|
+
SENSITIVE = []
|
1147
|
+
include Aws::Structure
|
1148
|
+
end
|
1149
|
+
|
1150
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
1151
|
+
# which is currently in public preview.**
|
1152
|
+
#
|
1153
|
+
# The properties of a container group that is deployed to a container
|
1154
|
+
# fleet.
|
1155
|
+
#
|
1156
|
+
# **Part of:** ContainerGroupsAttributes
|
1157
|
+
#
|
1158
|
+
# **Returned by:** DescribeFleetAttributes
|
1159
|
+
#
|
1160
|
+
# @!attribute [rw] scheduling_strategy
|
1161
|
+
# The method for scheduling and maintaining copies of the container
|
1162
|
+
# group across a container fleet.
|
1163
|
+
# @return [String]
|
1164
|
+
#
|
1165
|
+
# @!attribute [rw] container_group_definition_name
|
1166
|
+
# The unique identifier for the container group definition.
|
1167
|
+
# @return [String]
|
1168
|
+
#
|
1169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerGroupDefinitionProperty AWS API Documentation
|
1170
|
+
#
|
1171
|
+
class ContainerGroupDefinitionProperty < Struct.new(
|
1172
|
+
:scheduling_strategy,
|
1173
|
+
:container_group_definition_name)
|
1174
|
+
SENSITIVE = []
|
1175
|
+
include Aws::Structure
|
1176
|
+
end
|
1177
|
+
|
1178
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
1179
|
+
# which is currently in public preview.**
|
1180
|
+
#
|
1181
|
+
# The properties of container groups that are running on a container
|
1182
|
+
# fleet. Container group properties for a fleet can't be changed.
|
1183
|
+
#
|
1184
|
+
# **Returned by:** DescribeFleetAttributes, CreateFleet
|
1185
|
+
#
|
1186
|
+
# @!attribute [rw] container_group_definition_properties
|
1187
|
+
# A collection of properties that describe each container group in the
|
1188
|
+
# fleet. A container fleet is deployed with one or more
|
1189
|
+
# ContainerGroupDefinition resources, which is where these properties
|
1190
|
+
# are set.
|
1191
|
+
# @return [Array<Types::ContainerGroupDefinitionProperty>]
|
1192
|
+
#
|
1193
|
+
# @!attribute [rw] connection_port_range
|
1194
|
+
# A set of ports that allow inbound traffic to connect to processes
|
1195
|
+
# running in the fleet's container groups. Amazon GameLift maps each
|
1196
|
+
# connection port to a container port, which is assigned to a specific
|
1197
|
+
# container process. A fleet's connection port range can't be
|
1198
|
+
# changed, but you can control access to connection ports by updating
|
1199
|
+
# a fleet's `EC2InboundPermissions` with UpdateFleetPortSettings.
|
1200
|
+
# @return [Types::ConnectionPortRange]
|
1201
|
+
#
|
1202
|
+
# @!attribute [rw] container_groups_per_instance
|
1203
|
+
# Details about the number of replica container groups that Amazon
|
1204
|
+
# GameLift deploys to each instance in the container fleet.
|
1205
|
+
# @return [Types::ContainerGroupsPerInstance]
|
1206
|
+
#
|
1207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerGroupsAttributes AWS API Documentation
|
1208
|
+
#
|
1209
|
+
class ContainerGroupsAttributes < Struct.new(
|
1210
|
+
:container_group_definition_properties,
|
1211
|
+
:connection_port_range,
|
1212
|
+
:container_groups_per_instance)
|
1213
|
+
SENSITIVE = []
|
1214
|
+
include Aws::Structure
|
1215
|
+
end
|
1216
|
+
|
1217
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
1218
|
+
# which is currently in public preview.**
|
1219
|
+
#
|
1220
|
+
# Configuration details for a set of container groups, for use when
|
1221
|
+
# creating a fleet with compute type `CONTAINER`.
|
1222
|
+
#
|
1223
|
+
# **Used with:** CreateFleet
|
1224
|
+
#
|
1225
|
+
# @!attribute [rw] container_group_definition_names
|
1226
|
+
# The list of container group definition names to deploy to a new
|
1227
|
+
# container fleet.
|
1228
|
+
# @return [Array<String>]
|
1229
|
+
#
|
1230
|
+
# @!attribute [rw] connection_port_range
|
1231
|
+
# A set of ports to allow inbound traffic, including game clients, to
|
1232
|
+
# connect to processes running in the container fleet.
|
1233
|
+
#
|
1234
|
+
# Connection ports are dynamically mapped to container ports, which
|
1235
|
+
# are assigned to individual processes running in a container. The
|
1236
|
+
# connection port range must have enough ports to map to all container
|
1237
|
+
# ports across a fleet instance. To calculate the minimum connection
|
1238
|
+
# ports needed, use the following formula:
|
1239
|
+
#
|
1240
|
+
# *\[Total number of container ports as defined for containers in the
|
1241
|
+
# replica container group\] * \[Desired or calculated number of
|
1242
|
+
# replica container groups per instance\] + \[Total number of
|
1243
|
+
# container ports as defined for containers in the daemon container
|
1244
|
+
# group\]*
|
1245
|
+
#
|
1246
|
+
# As a best practice, double the minimum number of connection ports.
|
1247
|
+
#
|
1248
|
+
# <note markdown="1"> Use the fleet's `EC2InboundPermissions` property to control
|
1249
|
+
# external access to connection ports. Set this property to the
|
1250
|
+
# connection port numbers that you want to open access to. See
|
1251
|
+
# IpPermission for more details.
|
1252
|
+
#
|
1253
|
+
# </note>
|
1254
|
+
# @return [Types::ConnectionPortRange]
|
1255
|
+
#
|
1256
|
+
# @!attribute [rw] desired_replica_container_groups_per_instance
|
1257
|
+
# The number of times to replicate the replica container group on each
|
1258
|
+
# instance in a container fleet. By default, Amazon GameLift
|
1259
|
+
# calculates the maximum number of replica container groups that can
|
1260
|
+
# fit on a fleet instance (based on CPU and memory resources). Leave
|
1261
|
+
# this parameter empty if you want to use the maximum number, or
|
1262
|
+
# specify a desired number to override the maximum. The desired number
|
1263
|
+
# is used if it's less than the maximum number.
|
1264
|
+
# @return [Integer]
|
1265
|
+
#
|
1266
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerGroupsConfiguration AWS API Documentation
|
1267
|
+
#
|
1268
|
+
class ContainerGroupsConfiguration < Struct.new(
|
1269
|
+
:container_group_definition_names,
|
1270
|
+
:connection_port_range,
|
1271
|
+
:desired_replica_container_groups_per_instance)
|
1272
|
+
SENSITIVE = []
|
1273
|
+
include Aws::Structure
|
1274
|
+
end
|
1275
|
+
|
1276
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
1277
|
+
# which is currently in public preview.**
|
1278
|
+
#
|
1279
|
+
# Determines how many replica container groups that Amazon GameLift
|
1280
|
+
# deploys to each instance in a container fleet.
|
1281
|
+
#
|
1282
|
+
# Amazon GameLift calculates the maximum possible replica groups per
|
1283
|
+
# instance based on the instance 's CPU and memory resources. When
|
1284
|
+
# deploying a fleet, Amazon GameLift places replica container groups on
|
1285
|
+
# each fleet instance based on the following:
|
1286
|
+
#
|
1287
|
+
# * If no desired value is set, Amazon GameLift places the calculated
|
1288
|
+
# maximum.
|
1289
|
+
#
|
1290
|
+
# * If a desired number is set to a value higher than the calculated
|
1291
|
+
# maximum, Amazon GameLift places the calculated maximum.
|
1292
|
+
#
|
1293
|
+
# * If a desired number is set to a value lower than the calculated
|
1294
|
+
# maximum, Amazon GameLift places the desired number.
|
1295
|
+
#
|
1296
|
+
# **Part of:** ContainerGroupsConfiguration, ContainerGroupsAttributes
|
1297
|
+
#
|
1298
|
+
# **Returned by:** DescribeFleetAttributes, CreateFleet
|
1299
|
+
#
|
1300
|
+
# @!attribute [rw] desired_replica_container_groups_per_instance
|
1301
|
+
# The desired number of replica container groups to place on each
|
1302
|
+
# fleet instance.
|
1303
|
+
# @return [Integer]
|
1304
|
+
#
|
1305
|
+
# @!attribute [rw] max_replica_container_groups_per_instance
|
1306
|
+
# The maximum possible number of replica container groups that each
|
1307
|
+
# fleet instance can have.
|
1308
|
+
# @return [Integer]
|
1309
|
+
#
|
1310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerGroupsPerInstance AWS API Documentation
|
1311
|
+
#
|
1312
|
+
class ContainerGroupsPerInstance < Struct.new(
|
1313
|
+
:desired_replica_container_groups_per_instance,
|
1314
|
+
:max_replica_container_groups_per_instance)
|
1315
|
+
SENSITIVE = []
|
1316
|
+
include Aws::Structure
|
1317
|
+
end
|
1318
|
+
|
1319
|
+
# Instructions on when and how to check the health of a container in a
|
1320
|
+
# container fleet. When health check properties are set in a container
|
1321
|
+
# definition, they override any Docker health checks in the container
|
1322
|
+
# image. For more information on container health checks, see
|
1323
|
+
# [HealthCheck command][1] in the *Amazon Elastic Container Service
|
1324
|
+
# API*.
|
1325
|
+
#
|
1326
|
+
# The following example instructions tell the container to wait 100
|
1327
|
+
# seconds after launch before counting failed health checks, then
|
1328
|
+
# initiate the health check command every 60 seconds. After issuing the
|
1329
|
+
# health check command, wait 10 seconds for it to succeed. If it fails,
|
1330
|
+
# retry the command 3 times before considering the container to be
|
1331
|
+
# unhealthy.
|
1332
|
+
#
|
1333
|
+
# `\{"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit
|
1334
|
+
# 1" ], "Interval": 300, "Timeout": 30, "Retries": 5, "StartPeriod": 100
|
1335
|
+
# \}`
|
1336
|
+
#
|
1337
|
+
# **Part of:** ContainerDefinition$HealthCheck
|
1338
|
+
#
|
1339
|
+
#
|
1340
|
+
#
|
1341
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html#ECS-Type-HealthCheck-command
|
1342
|
+
#
|
1343
|
+
# @!attribute [rw] command
|
1344
|
+
# A string array that specifies the command that the container runs to
|
1345
|
+
# determine if it's healthy.
|
1346
|
+
# @return [Array<String>]
|
1347
|
+
#
|
1348
|
+
# @!attribute [rw] interval
|
1349
|
+
# The time period (in seconds) between each health check.
|
1350
|
+
# @return [Integer]
|
1351
|
+
#
|
1352
|
+
# @!attribute [rw] timeout
|
1353
|
+
# The time period (in seconds) to wait for a health check to succeed
|
1354
|
+
# before a failed health check is counted.
|
1355
|
+
# @return [Integer]
|
1356
|
+
#
|
1357
|
+
# @!attribute [rw] retries
|
1358
|
+
# The number of times to retry a failed health check before the
|
1359
|
+
# container is considered unhealthy. The first run of the command does
|
1360
|
+
# not count as a retry.
|
1361
|
+
# @return [Integer]
|
1362
|
+
#
|
1363
|
+
# @!attribute [rw] start_period
|
1364
|
+
# The optional grace period (in seconds) to give a container time to
|
1365
|
+
# bootstrap before the first failed health check counts toward the
|
1366
|
+
# number of retries.
|
1367
|
+
# @return [Integer]
|
1368
|
+
#
|
1369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerHealthCheck AWS API Documentation
|
1370
|
+
#
|
1371
|
+
class ContainerHealthCheck < Struct.new(
|
1372
|
+
:command,
|
1373
|
+
:interval,
|
1374
|
+
:timeout,
|
1375
|
+
:retries,
|
1376
|
+
:start_period)
|
1377
|
+
SENSITIVE = []
|
1378
|
+
include Aws::Structure
|
1379
|
+
end
|
1380
|
+
|
1381
|
+
# Specifies how much memory is available to a container. You can't
|
1382
|
+
# change this value after you create this object.
|
1383
|
+
#
|
1384
|
+
# <b>Part of: </b> ContainerDefinition$MemoryLimits
|
1385
|
+
#
|
1386
|
+
# @!attribute [rw] soft_limit
|
1387
|
+
# The amount of memory that is reserved for a container. When the
|
1388
|
+
# container group's shared memory is under contention, the system
|
1389
|
+
# attempts to maintain the container memory usage at this soft limit.
|
1390
|
+
# However, the container can use more memory when needed, if
|
1391
|
+
# available. This property is similar to the Amazon ECS container
|
1392
|
+
# definition parameter [memoryreservation][1] (*Amazon Elastic
|
1393
|
+
# Container Service Developer Guide*).
|
1394
|
+
#
|
1395
|
+
#
|
1396
|
+
#
|
1397
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#ContainerDefinition-memoryReservation
|
1398
|
+
# @return [Integer]
|
1399
|
+
#
|
1400
|
+
# @!attribute [rw] hard_limit
|
1401
|
+
# The maximum amount of memory that the container can use. If a
|
1402
|
+
# container attempts to exceed this limit, the container is stopped.
|
1403
|
+
# This property is similar to the Amazon ECS container definition
|
1404
|
+
# parameter [memory][1] in the *Amazon Elastic Container Service
|
1405
|
+
# Developer Guide.*
|
1406
|
+
#
|
1407
|
+
#
|
1408
|
+
#
|
1409
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_memory
|
1410
|
+
# @return [Integer]
|
1411
|
+
#
|
1412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerMemoryLimits AWS API Documentation
|
1413
|
+
#
|
1414
|
+
class ContainerMemoryLimits < Struct.new(
|
1415
|
+
:soft_limit,
|
1416
|
+
:hard_limit)
|
1417
|
+
SENSITIVE = []
|
1418
|
+
include Aws::Structure
|
1419
|
+
end
|
1420
|
+
|
1421
|
+
# Defines ranges of ports that server processes can connect to.
|
1422
|
+
#
|
1423
|
+
# **Part of:** ContainerDefinition$PortConfiguration
|
1424
|
+
#
|
1425
|
+
# @!attribute [rw] container_port_ranges
|
1426
|
+
# Specifies one or more ranges of ports on a container. These ranges
|
1427
|
+
# must not overlap.
|
1428
|
+
# @return [Array<Types::ContainerPortRange>]
|
1429
|
+
#
|
1430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerPortConfiguration AWS API Documentation
|
1431
|
+
#
|
1432
|
+
class ContainerPortConfiguration < Struct.new(
|
1433
|
+
:container_port_ranges)
|
1434
|
+
SENSITIVE = []
|
1435
|
+
include Aws::Structure
|
1436
|
+
end
|
1437
|
+
|
1438
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
1439
|
+
# which is currently in public preview.**
|
1440
|
+
#
|
1441
|
+
# Defines how an internal-facing container port is mapped to an
|
1442
|
+
# external-facing connection port on a fleet instance of compute type
|
1443
|
+
# `CONTAINER`. Incoming traffic, such as a game client, uses a
|
1444
|
+
# connection port to connect to a process in the container fleet. Amazon
|
1445
|
+
# GameLift directs the inbound traffic to the container port that is
|
1446
|
+
# assigned to the process, such as a game session, running on a
|
1447
|
+
# container.
|
448
1448
|
#
|
449
|
-
#
|
450
|
-
# The type of operating system on the compute resource.
|
451
|
-
# @return [String]
|
1449
|
+
# **Part of:** ContainerAttributes
|
452
1450
|
#
|
453
|
-
# @!attribute [rw]
|
454
|
-
# The
|
455
|
-
#
|
456
|
-
# empty.
|
457
|
-
# @return [String]
|
1451
|
+
# @!attribute [rw] container_port
|
1452
|
+
# The port opened on the container.
|
1453
|
+
# @return [Integer]
|
458
1454
|
#
|
459
|
-
# @!attribute [rw]
|
460
|
-
# The
|
461
|
-
#
|
462
|
-
#
|
1455
|
+
# @!attribute [rw] connection_port
|
1456
|
+
# The port opened on the fleet instance. This is also called the
|
1457
|
+
# "host port".
|
1458
|
+
# @return [Integer]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] protocol
|
1461
|
+
# The network protocol that this mapping supports.
|
463
1462
|
# @return [String]
|
464
1463
|
#
|
465
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/
|
1464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerPortMapping AWS API Documentation
|
466
1465
|
#
|
467
|
-
class
|
468
|
-
:
|
469
|
-
:
|
470
|
-
:
|
471
|
-
:
|
472
|
-
:ip_address,
|
473
|
-
:dns_name,
|
474
|
-
:compute_status,
|
475
|
-
:location,
|
476
|
-
:creation_time,
|
477
|
-
:operating_system,
|
478
|
-
:type,
|
479
|
-
:game_lift_service_sdk_endpoint)
|
480
|
-
SENSITIVE = [:ip_address]
|
1466
|
+
class ContainerPortMapping < Struct.new(
|
1467
|
+
:container_port,
|
1468
|
+
:connection_port,
|
1469
|
+
:protocol)
|
1470
|
+
SENSITIVE = [:container_port, :connection_port]
|
481
1471
|
include Aws::Structure
|
482
1472
|
end
|
483
1473
|
|
484
|
-
#
|
485
|
-
#
|
486
|
-
# conflict before retrying this request.
|
1474
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
1475
|
+
# which is currently in public preview.**
|
487
1476
|
#
|
488
|
-
#
|
1477
|
+
# A set of one or more port numbers that can be opened on the container.
|
1478
|
+
#
|
1479
|
+
# **Part of:** ContainerPortConfiguration
|
1480
|
+
#
|
1481
|
+
# @!attribute [rw] from_port
|
1482
|
+
# A starting value for the range of allowed port numbers.
|
1483
|
+
# @return [Integer]
|
1484
|
+
#
|
1485
|
+
# @!attribute [rw] to_port
|
1486
|
+
# An ending value for the range of allowed port numbers. Port numbers
|
1487
|
+
# are end-inclusive. This value must be equal to or greater than
|
1488
|
+
# `FromPort`.
|
1489
|
+
# @return [Integer]
|
1490
|
+
#
|
1491
|
+
# @!attribute [rw] protocol
|
1492
|
+
# The network protocol that these ports support.
|
489
1493
|
# @return [String]
|
490
1494
|
#
|
491
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/
|
1495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerPortRange AWS API Documentation
|
492
1496
|
#
|
493
|
-
class
|
494
|
-
:
|
495
|
-
|
1497
|
+
class ContainerPortRange < Struct.new(
|
1498
|
+
:from_port,
|
1499
|
+
:to_port,
|
1500
|
+
:protocol)
|
1501
|
+
SENSITIVE = [:from_port, :to_port]
|
496
1502
|
include Aws::Structure
|
497
1503
|
end
|
498
1504
|
|
@@ -662,6 +1668,94 @@ module Aws::GameLift
|
|
662
1668
|
include Aws::Structure
|
663
1669
|
end
|
664
1670
|
|
1671
|
+
# @!attribute [rw] name
|
1672
|
+
# A descriptive identifier for the container group definition. The
|
1673
|
+
# name value must be unique in an Amazon Web Services Region.
|
1674
|
+
# @return [String]
|
1675
|
+
#
|
1676
|
+
# @!attribute [rw] scheduling_strategy
|
1677
|
+
# The method for deploying the container group across fleet instances.
|
1678
|
+
# A replica container group might have multiple copies on each fleet
|
1679
|
+
# instance. A daemon container group has one copy per fleet instance.
|
1680
|
+
# Default value is `REPLICA`.
|
1681
|
+
# @return [String]
|
1682
|
+
#
|
1683
|
+
# @!attribute [rw] total_memory_limit
|
1684
|
+
# The maximum amount of memory (in MiB) to allocate to the container
|
1685
|
+
# group. All containers in the group share this memory. If you specify
|
1686
|
+
# memory limits for individual containers, set this parameter based on
|
1687
|
+
# the following guidelines. The value must be (1) greater than the sum
|
1688
|
+
# of the soft memory limits for all containers in the group, and (2)
|
1689
|
+
# greater than any individual container's hard memory limit.
|
1690
|
+
# @return [Integer]
|
1691
|
+
#
|
1692
|
+
# @!attribute [rw] total_cpu_limit
|
1693
|
+
# The maximum amount of CPU units to allocate to the container group.
|
1694
|
+
# Set this parameter to an integer value in CPU units (1 vCPU is equal
|
1695
|
+
# to 1024 CPU units). All containers in the group share this memory.
|
1696
|
+
# If you specify CPU limits for individual containers, set this
|
1697
|
+
# parameter based on the following guidelines. The value must be equal
|
1698
|
+
# to or greater than the sum of the CPU limits for all containers in
|
1699
|
+
# the group.
|
1700
|
+
# @return [Integer]
|
1701
|
+
#
|
1702
|
+
# @!attribute [rw] container_definitions
|
1703
|
+
# Definitions for all containers in this group. Each container
|
1704
|
+
# definition identifies the container image and specifies
|
1705
|
+
# configuration settings for the container. See the [ Container fleet
|
1706
|
+
# design guide][1] for container guidelines.
|
1707
|
+
#
|
1708
|
+
#
|
1709
|
+
#
|
1710
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet.html
|
1711
|
+
# @return [Array<Types::ContainerDefinitionInput>]
|
1712
|
+
#
|
1713
|
+
# @!attribute [rw] operating_system
|
1714
|
+
# The platform that is used by containers in the container group
|
1715
|
+
# definition. All containers in a group must run on the same operating
|
1716
|
+
# system.
|
1717
|
+
# @return [String]
|
1718
|
+
#
|
1719
|
+
# @!attribute [rw] tags
|
1720
|
+
# A list of labels to assign to the container group definition
|
1721
|
+
# resource. Tags are developer-defined key-value pairs. Tagging Amazon
|
1722
|
+
# Web Services resources are useful for resource management, access
|
1723
|
+
# management and cost allocation. For more information, see [ Tagging
|
1724
|
+
# Amazon Web Services Resources][1] in the *Amazon Web Services
|
1725
|
+
# General Reference*.
|
1726
|
+
#
|
1727
|
+
#
|
1728
|
+
#
|
1729
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1730
|
+
# @return [Array<Types::Tag>]
|
1731
|
+
#
|
1732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateContainerGroupDefinitionInput AWS API Documentation
|
1733
|
+
#
|
1734
|
+
class CreateContainerGroupDefinitionInput < Struct.new(
|
1735
|
+
:name,
|
1736
|
+
:scheduling_strategy,
|
1737
|
+
:total_memory_limit,
|
1738
|
+
:total_cpu_limit,
|
1739
|
+
:container_definitions,
|
1740
|
+
:operating_system,
|
1741
|
+
:tags)
|
1742
|
+
SENSITIVE = []
|
1743
|
+
include Aws::Structure
|
1744
|
+
end
|
1745
|
+
|
1746
|
+
# @!attribute [rw] container_group_definition
|
1747
|
+
# The properties of the newly created container group definition
|
1748
|
+
# resource. You use this resource to create a container fleet.
|
1749
|
+
# @return [Types::ContainerGroupDefinition]
|
1750
|
+
#
|
1751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateContainerGroupDefinitionOutput AWS API Documentation
|
1752
|
+
#
|
1753
|
+
class CreateContainerGroupDefinitionOutput < Struct.new(
|
1754
|
+
:container_group_definition)
|
1755
|
+
SENSITIVE = []
|
1756
|
+
include Aws::Structure
|
1757
|
+
end
|
1758
|
+
|
665
1759
|
# @!attribute [rw] name
|
666
1760
|
# A descriptive label that is associated with a fleet. Fleet names do
|
667
1761
|
# not need to be unique.
|
@@ -673,17 +1767,18 @@ module Aws::GameLift
|
|
673
1767
|
#
|
674
1768
|
# @!attribute [rw] build_id
|
675
1769
|
# The unique identifier for a custom game server build to be deployed
|
676
|
-
#
|
677
|
-
# build must be uploaded to Amazon GameLift and in `READY`
|
678
|
-
# This fleet property can't be changed after the fleet is
|
1770
|
+
# to a fleet with compute type `EC2`. You can use either the build ID
|
1771
|
+
# or ARN. The build must be uploaded to Amazon GameLift and in `READY`
|
1772
|
+
# status. This fleet property can't be changed after the fleet is
|
1773
|
+
# created.
|
679
1774
|
# @return [String]
|
680
1775
|
#
|
681
1776
|
# @!attribute [rw] script_id
|
682
1777
|
# The unique identifier for a Realtime configuration script to be
|
683
|
-
# deployed
|
684
|
-
# ARN. Scripts must be uploaded to Amazon GameLift prior
|
685
|
-
# the fleet. This fleet property can't be changed after
|
686
|
-
# created.
|
1778
|
+
# deployed to a fleet with compute type `EC2`. You can use either the
|
1779
|
+
# script ID or ARN. Scripts must be uploaded to Amazon GameLift prior
|
1780
|
+
# to creating the fleet. This fleet property can't be changed after
|
1781
|
+
# the fleet is created.
|
687
1782
|
# @return [String]
|
688
1783
|
#
|
689
1784
|
# @!attribute [rw] server_launch_path
|
@@ -712,8 +1807,8 @@ module Aws::GameLift
|
|
712
1807
|
# @return [Array<String>]
|
713
1808
|
#
|
714
1809
|
# @!attribute [rw] ec2_instance_type
|
715
|
-
# The Amazon GameLift-supported Amazon EC2 instance type to use
|
716
|
-
#
|
1810
|
+
# The Amazon GameLift-supported Amazon EC2 instance type to use with
|
1811
|
+
# EC2 and container fleets. Instance type determines the computing
|
717
1812
|
# resources that will be used to host your game servers, including
|
718
1813
|
# CPU, memory, storage, and networking capacity. See [Amazon Elastic
|
719
1814
|
# Compute Cloud Instance Types][1] for detailed descriptions of Amazon
|
@@ -725,11 +1820,20 @@ module Aws::GameLift
|
|
725
1820
|
# @return [String]
|
726
1821
|
#
|
727
1822
|
# @!attribute [rw] ec2_inbound_permissions
|
728
|
-
# The
|
729
|
-
#
|
730
|
-
#
|
731
|
-
#
|
732
|
-
#
|
1823
|
+
# The IP address ranges and port settings that allow inbound traffic
|
1824
|
+
# to access game server processes and other processes on this fleet.
|
1825
|
+
# Set this parameter for EC2 and container fleets. You can leave this
|
1826
|
+
# parameter empty when creating the fleet, but you must call
|
1827
|
+
# UpdateFleetPortSettings to set it before players can connect to game
|
1828
|
+
# sessions. As a best practice, we recommend opening ports for remote
|
1829
|
+
# access only when you need them and closing them when you're
|
1830
|
+
# finished. For Realtime Servers fleets, Amazon GameLift automatically
|
1831
|
+
# sets TCP and UDP ranges.
|
1832
|
+
#
|
1833
|
+
# To manage inbound access for a container fleet, set this parameter
|
1834
|
+
# to the same port numbers that you set for the fleet's connection
|
1835
|
+
# port range. During the life of the fleet, update this parameter to
|
1836
|
+
# control which connection ports are open to inbound traffic.
|
733
1837
|
# @return [Array<Types::IpPermission>]
|
734
1838
|
#
|
735
1839
|
# @!attribute [rw] new_game_session_protection_policy
|
@@ -747,14 +1851,15 @@ module Aws::GameLift
|
|
747
1851
|
# @return [String]
|
748
1852
|
#
|
749
1853
|
# @!attribute [rw] runtime_configuration
|
750
|
-
# Instructions for how to launch and
|
751
|
-
#
|
752
|
-
#
|
753
|
-
#
|
754
|
-
#
|
755
|
-
#
|
756
|
-
#
|
757
|
-
#
|
1854
|
+
# Instructions for how to launch and run server processes on the
|
1855
|
+
# fleet. Set runtime configuration for EC2 fleets and container
|
1856
|
+
# fleets. For an Anywhere fleets, set this parameter only if the fleet
|
1857
|
+
# is running the Amazon GameLift Agent. The runtime configuration
|
1858
|
+
# defines one or more server process configurations. Each server
|
1859
|
+
# process identifies a game executable or Realtime script file and the
|
1860
|
+
# number of processes to run concurrently.
|
1861
|
+
#
|
1862
|
+
# <note markdown="1"> This parameter replaces the parameters `ServerLaunchPath` and
|
758
1863
|
# `ServerLaunchParameters`, which are still supported for backward
|
759
1864
|
# compatibility.
|
760
1865
|
#
|
@@ -854,11 +1959,12 @@ module Aws::GameLift
|
|
854
1959
|
# creating fleets in Amazon Web Services Regions that support multiple
|
855
1960
|
# locations. You can add any Amazon GameLift-supported Amazon Web
|
856
1961
|
# Services Region as a remote location, in the form of an Amazon Web
|
857
|
-
# Services Region code such as `us-west-2
|
858
|
-
# instances in the home Region only, don't
|
1962
|
+
# Services Region code, such as `us-west-2` or Local Zone code. To
|
1963
|
+
# create a fleet with instances in the home Region only, don't set
|
1964
|
+
# this parameter.
|
859
1965
|
#
|
860
|
-
#
|
861
|
-
# location in the request.
|
1966
|
+
# When using this parameter, Amazon GameLift requires you to include
|
1967
|
+
# your home location in the request.
|
862
1968
|
# @return [Array<Types::LocationConfiguration>]
|
863
1969
|
#
|
864
1970
|
# @!attribute [rw] tags
|
@@ -875,10 +1981,20 @@ module Aws::GameLift
|
|
875
1981
|
# @return [Array<Types::Tag>]
|
876
1982
|
#
|
877
1983
|
# @!attribute [rw] compute_type
|
878
|
-
# The type of compute resource used to host your game servers.
|
879
|
-
#
|
880
|
-
#
|
881
|
-
#
|
1984
|
+
# The type of compute resource used to host your game servers.
|
1985
|
+
#
|
1986
|
+
# * `EC2` – The game server build is deployed to Amazon EC2 instances
|
1987
|
+
# for cloud hosting. This is the default setting.
|
1988
|
+
#
|
1989
|
+
# * `CONTAINER` – Container images with your game server build and
|
1990
|
+
# supporting software are deployed to Amazon EC2 instances for cloud
|
1991
|
+
# hosting. With this compute type, you must specify the
|
1992
|
+
# `ContainerGroupsConfiguration` parameter.
|
1993
|
+
#
|
1994
|
+
# * `ANYWHERE` – Game servers or container images with your game
|
1995
|
+
# server and supporting software are deployed to compute resources
|
1996
|
+
# that are provided and managed by you. With this compute type, you
|
1997
|
+
# can also set the `AnywhereConfiguration` parameter.
|
882
1998
|
# @return [String]
|
883
1999
|
#
|
884
2000
|
# @!attribute [rw] anywhere_configuration
|
@@ -887,19 +2003,28 @@ module Aws::GameLift
|
|
887
2003
|
#
|
888
2004
|
# @!attribute [rw] instance_role_credentials_provider
|
889
2005
|
# Prompts Amazon GameLift to generate a shared credentials file for
|
890
|
-
# the IAM role defined in `InstanceRoleArn`. The shared
|
891
|
-
# file is stored on each fleet instance and refreshed as
|
892
|
-
# shared credentials for applications that are deployed
|
893
|
-
# game server executable, if the game server is
|
894
|
-
# SDK version 5.x. For more information about
|
895
|
-
# credentials, see [ Communicate with other Amazon Web
|
896
|
-
# resources from your fleets][1].
|
2006
|
+
# the IAM role that's defined in `InstanceRoleArn`. The shared
|
2007
|
+
# credentials file is stored on each fleet instance and refreshed as
|
2008
|
+
# needed. Use shared credentials for applications that are deployed
|
2009
|
+
# along with the game server executable, if the game server is
|
2010
|
+
# integrated with server SDK version 5.x. For more information about
|
2011
|
+
# using shared credentials, see [ Communicate with other Amazon Web
|
2012
|
+
# Services resources from your fleets][1].
|
897
2013
|
#
|
898
2014
|
#
|
899
2015
|
#
|
900
2016
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html
|
901
2017
|
# @return [String]
|
902
2018
|
#
|
2019
|
+
# @!attribute [rw] container_groups_configuration
|
2020
|
+
# The container groups to deploy to instances in the container fleet
|
2021
|
+
# and other fleet-level configuration settings. Use the
|
2022
|
+
# CreateContainerGroupDefinition action to create container groups. A
|
2023
|
+
# container fleet must have exactly one replica container group, and
|
2024
|
+
# can optionally have one daemon container group. You can't change
|
2025
|
+
# this property after you create the fleet.
|
2026
|
+
# @return [Types::ContainerGroupsConfiguration]
|
2027
|
+
#
|
903
2028
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateFleetInput AWS API Documentation
|
904
2029
|
#
|
905
2030
|
class CreateFleetInput < Struct.new(
|
@@ -925,7 +2050,8 @@ module Aws::GameLift
|
|
925
2050
|
:tags,
|
926
2051
|
:compute_type,
|
927
2052
|
:anywhere_configuration,
|
928
|
-
:instance_role_credentials_provider
|
2053
|
+
:instance_role_credentials_provider,
|
2054
|
+
:container_groups_configuration)
|
929
2055
|
SENSITIVE = []
|
930
2056
|
include Aws::Structure
|
931
2057
|
end
|
@@ -1946,6 +3072,19 @@ module Aws::GameLift
|
|
1946
3072
|
include Aws::Structure
|
1947
3073
|
end
|
1948
3074
|
|
3075
|
+
# @!attribute [rw] name
|
3076
|
+
# The unique identifier for the container group definition to delete.
|
3077
|
+
# You can use either the `Name` or `ARN` value.
|
3078
|
+
# @return [String]
|
3079
|
+
#
|
3080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteContainerGroupDefinitionInput AWS API Documentation
|
3081
|
+
#
|
3082
|
+
class DeleteContainerGroupDefinitionInput < Struct.new(
|
3083
|
+
:name)
|
3084
|
+
SENSITIVE = []
|
3085
|
+
include Aws::Structure
|
3086
|
+
end
|
3087
|
+
|
1949
3088
|
# @!attribute [rw] fleet_id
|
1950
3089
|
# A unique identifier for the fleet to be deleted. You can use either
|
1951
3090
|
# the fleet ID or ARN value.
|
@@ -2215,8 +3354,11 @@ module Aws::GameLift
|
|
2215
3354
|
# @return [String]
|
2216
3355
|
#
|
2217
3356
|
# @!attribute [rw] compute_name
|
2218
|
-
# The
|
2219
|
-
# Anywhere fleet.
|
3357
|
+
# The unique identifier of the compute resource to deregister. For an
|
3358
|
+
# Anywhere fleet compute, use the registered compute name. For a
|
3359
|
+
# container fleet, use the compute name (for example,
|
3360
|
+
# `a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9`)
|
3361
|
+
# or the compute ARN.
|
2220
3362
|
# @return [String]
|
2221
3363
|
#
|
2222
3364
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterComputeInput AWS API Documentation
|
@@ -2302,14 +3444,17 @@ module Aws::GameLift
|
|
2302
3444
|
end
|
2303
3445
|
|
2304
3446
|
# @!attribute [rw] fleet_id
|
2305
|
-
# A unique identifier for the fleet that the compute
|
2306
|
-
#
|
3447
|
+
# A unique identifier for the fleet that the compute belongs to. You
|
3448
|
+
# can use either the fleet ID or ARN value.
|
2307
3449
|
# @return [String]
|
2308
3450
|
#
|
2309
3451
|
# @!attribute [rw] compute_name
|
2310
3452
|
# The unique identifier of the compute resource to retrieve properties
|
2311
3453
|
# for. For an Anywhere fleet compute, use the registered compute name.
|
2312
|
-
# For
|
3454
|
+
# For an EC2 fleet instance, use the instance ID. For a container
|
3455
|
+
# fleet, use the compute name (for example,
|
3456
|
+
# `a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9`)
|
3457
|
+
# or the compute ARN.
|
2313
3458
|
# @return [String]
|
2314
3459
|
#
|
2315
3460
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeComputeInput AWS API Documentation
|
@@ -2333,6 +3478,31 @@ module Aws::GameLift
|
|
2333
3478
|
include Aws::Structure
|
2334
3479
|
end
|
2335
3480
|
|
3481
|
+
# @!attribute [rw] name
|
3482
|
+
# The unique identifier for the container group definition to retrieve
|
3483
|
+
# properties for. You can use either the `Name` or `ARN` value.
|
3484
|
+
# @return [String]
|
3485
|
+
#
|
3486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeContainerGroupDefinitionInput AWS API Documentation
|
3487
|
+
#
|
3488
|
+
class DescribeContainerGroupDefinitionInput < Struct.new(
|
3489
|
+
:name)
|
3490
|
+
SENSITIVE = []
|
3491
|
+
include Aws::Structure
|
3492
|
+
end
|
3493
|
+
|
3494
|
+
# @!attribute [rw] container_group_definition
|
3495
|
+
# The properties of the requested container group definition resource.
|
3496
|
+
# @return [Types::ContainerGroupDefinition]
|
3497
|
+
#
|
3498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeContainerGroupDefinitionOutput AWS API Documentation
|
3499
|
+
#
|
3500
|
+
class DescribeContainerGroupDefinitionOutput < Struct.new(
|
3501
|
+
:container_group_definition)
|
3502
|
+
SENSITIVE = []
|
3503
|
+
include Aws::Structure
|
3504
|
+
end
|
3505
|
+
|
2336
3506
|
# @!attribute [rw] ec2_instance_type
|
2337
3507
|
# Name of an Amazon EC2 instance type that is supported in Amazon
|
2338
3508
|
# GameLift. A fleet instance type determines the computing resources
|
@@ -3406,8 +4576,8 @@ module Aws::GameLift
|
|
3406
4576
|
end
|
3407
4577
|
|
3408
4578
|
# @!attribute [rw] runtime_configuration
|
3409
|
-
# Instructions that describe how server processes
|
3410
|
-
#
|
4579
|
+
# Instructions that describe how server processes are launched and
|
4580
|
+
# maintained on computes in the fleet.
|
3411
4581
|
# @return [Types::RuntimeConfiguration]
|
3412
4582
|
#
|
3413
4583
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeRuntimeConfigurationOutput AWS API Documentation
|
@@ -3894,6 +5064,10 @@ module Aws::GameLift
|
|
3894
5064
|
# Amazon GameLift console.
|
3895
5065
|
# @return [String]
|
3896
5066
|
#
|
5067
|
+
# @!attribute [rw] count
|
5068
|
+
# The number of times that this event occurred.
|
5069
|
+
# @return [Integer]
|
5070
|
+
#
|
3897
5071
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/Event AWS API Documentation
|
3898
5072
|
#
|
3899
5073
|
class Event < Struct.new(
|
@@ -3902,7 +5076,8 @@ module Aws::GameLift
|
|
3902
5076
|
:event_code,
|
3903
5077
|
:message,
|
3904
5078
|
:event_time,
|
3905
|
-
:pre_signed_log_url
|
5079
|
+
:pre_signed_log_url,
|
5080
|
+
:count)
|
3906
5081
|
SENSITIVE = []
|
3907
5082
|
include Aws::Structure
|
3908
5083
|
end
|
@@ -3926,9 +5101,25 @@ module Aws::GameLift
|
|
3926
5101
|
include Aws::Structure
|
3927
5102
|
end
|
3928
5103
|
|
3929
|
-
#
|
5104
|
+
# **This operation has been expanded to use with the Amazon GameLift
|
5105
|
+
# containers feature, which is currently in public preview.**
|
3930
5106
|
#
|
3931
|
-
#
|
5107
|
+
# Describes an Amazon GameLift fleet of game hosting resources.
|
5108
|
+
# Attributes differ based on the fleet's compute type, as follows:
|
5109
|
+
#
|
5110
|
+
# * EC2 fleet attributes identify a `Build` resource (for fleets with
|
5111
|
+
# customer game server builds) or a `Script` resource (for Realtime
|
5112
|
+
# Servers fleets).
|
5113
|
+
#
|
5114
|
+
# * Container fleets have `ContainerGroupsAttributes`, which identify
|
5115
|
+
# the fleet's `ContainerGroupDefinition` resources.
|
5116
|
+
#
|
5117
|
+
# * Amazon GameLift Anywhere fleets have an abbreviated set of
|
5118
|
+
# attributes, because most fleet configurations are set directly on
|
5119
|
+
# the fleet's computes. Attributes include fleet identifiers and
|
5120
|
+
# descriptive properties, creation/termination time, and fleet status.
|
5121
|
+
#
|
5122
|
+
# **Returned by:** DescribeFleetAttributes
|
3932
5123
|
#
|
3933
5124
|
# @!attribute [rw] fleet_id
|
3934
5125
|
# A unique identifier for the fleet.
|
@@ -3948,10 +5139,9 @@ module Aws::GameLift
|
|
3948
5139
|
# @return [String]
|
3949
5140
|
#
|
3950
5141
|
# @!attribute [rw] fleet_type
|
3951
|
-
# Indicates whether
|
3952
|
-
#
|
3953
|
-
#
|
3954
|
-
# property can't be changed after the fleet is created.
|
5142
|
+
# Indicates whether the fleet uses On-Demand or Spot instances. For
|
5143
|
+
# more information, see [ On-Demand versus Spot Instances][1]. This
|
5144
|
+
# fleet property can't be changed after the fleet is created.
|
3955
5145
|
#
|
3956
5146
|
#
|
3957
5147
|
#
|
@@ -3959,10 +5149,12 @@ module Aws::GameLift
|
|
3959
5149
|
# @return [String]
|
3960
5150
|
#
|
3961
5151
|
# @!attribute [rw] instance_type
|
3962
|
-
# The Amazon EC2 instance type that
|
3963
|
-
# of each instance in the fleet
|
3964
|
-
# memory, storage, and networking capacity. See [Amazon
|
3965
|
-
# Compute Cloud Instance Types][1] for detailed descriptions.
|
5152
|
+
# The Amazon EC2 instance type that the fleet uses. Instance type
|
5153
|
+
# determines the computing resources of each instance in the fleet,
|
5154
|
+
# including CPU, memory, storage, and networking capacity. See [Amazon
|
5155
|
+
# Elastic Compute Cloud Instance Types][1] for detailed descriptions.
|
5156
|
+
# This attribute is used with fleets where `ComputeType` is "EC2" or
|
5157
|
+
# "Container".
|
3966
5158
|
#
|
3967
5159
|
#
|
3968
5160
|
#
|
@@ -3994,33 +5186,35 @@ module Aws::GameLift
|
|
3994
5186
|
# Current status of the fleet. Possible fleet statuses include the
|
3995
5187
|
# following:
|
3996
5188
|
#
|
3997
|
-
# *
|
3998
|
-
#
|
5189
|
+
# * NEW -- A new fleet has been defined and desired instances is set
|
5190
|
+
# to 1.
|
3999
5191
|
#
|
4000
|
-
# *
|
4001
|
-
#
|
5192
|
+
# * DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is
|
5193
|
+
# setting up the new fleet, creating new instances with the game
|
4002
5194
|
# build or Realtime script and starting server processes.
|
4003
5195
|
#
|
4004
|
-
# *
|
5196
|
+
# * ACTIVE -- Hosts can now accept game sessions.
|
4005
5197
|
#
|
4006
|
-
# *
|
4007
|
-
#
|
5198
|
+
# * ERROR -- An error occurred when downloading, validating, building,
|
5199
|
+
# or activating the fleet.
|
4008
5200
|
#
|
4009
|
-
# *
|
5201
|
+
# * DELETING -- Hosts are responding to a delete fleet request.
|
4010
5202
|
#
|
4011
|
-
# *
|
5203
|
+
# * TERMINATED -- The fleet no longer exists.
|
4012
5204
|
# @return [String]
|
4013
5205
|
#
|
4014
5206
|
# @!attribute [rw] build_id
|
4015
5207
|
# A unique identifier for the build resource that is deployed on
|
4016
|
-
# instances in this fleet.
|
5208
|
+
# instances in this fleet. This attribute is used with fleets where
|
5209
|
+
# `ComputeType` is "EC2".
|
4017
5210
|
# @return [String]
|
4018
5211
|
#
|
4019
5212
|
# @!attribute [rw] build_arn
|
4020
5213
|
# The Amazon Resource Name ([ARN][1]) associated with the Amazon
|
4021
5214
|
# GameLift build resource that is deployed on instances in this fleet.
|
4022
5215
|
# In a GameLift build ARN, the resource ID matches the `BuildId`
|
4023
|
-
# value.
|
5216
|
+
# value. This attribute is used with fleets where `ComputeType` is
|
5217
|
+
# "EC2".
|
4024
5218
|
#
|
4025
5219
|
#
|
4026
5220
|
#
|
@@ -4029,7 +5223,8 @@ module Aws::GameLift
|
|
4029
5223
|
#
|
4030
5224
|
# @!attribute [rw] script_id
|
4031
5225
|
# A unique identifier for the Realtime script resource that is
|
4032
|
-
# deployed on instances in this fleet.
|
5226
|
+
# deployed on instances in this fleet. This attribute is used with
|
5227
|
+
# fleets where `ComputeType` is "EC2".
|
4033
5228
|
# @return [String]
|
4034
5229
|
#
|
4035
5230
|
# @!attribute [rw] script_arn
|
@@ -4045,7 +5240,7 @@ module Aws::GameLift
|
|
4045
5240
|
# @!attribute [rw] server_launch_path
|
4046
5241
|
# **This parameter is no longer used.** Server launch paths are now
|
4047
5242
|
# defined using the fleet's [RuntimeConfiguration][1] . Requests that
|
4048
|
-
# use this parameter
|
5243
|
+
# use this parameter continue to be valid.
|
4049
5244
|
#
|
4050
5245
|
#
|
4051
5246
|
#
|
@@ -4055,7 +5250,7 @@ module Aws::GameLift
|
|
4055
5250
|
# @!attribute [rw] server_launch_parameters
|
4056
5251
|
# **This parameter is no longer used.** Server launch parameters are
|
4057
5252
|
# now defined using the fleet's runtime configuration . Requests that
|
4058
|
-
# use this parameter
|
5253
|
+
# use this parameter continue to be valid.
|
4059
5254
|
# @return [String]
|
4060
5255
|
#
|
4061
5256
|
# @!attribute [rw] log_paths
|
@@ -4071,7 +5266,8 @@ module Aws::GameLift
|
|
4071
5266
|
#
|
4072
5267
|
# @!attribute [rw] new_game_session_protection_policy
|
4073
5268
|
# The type of game session protection to set on all new instances that
|
4074
|
-
# are started in the fleet.
|
5269
|
+
# are started in the fleet. This attribute is used with fleets where
|
5270
|
+
# `ComputeType` is "EC2" or "Container".
|
4075
5271
|
#
|
4076
5272
|
# * **NoProtection** -- The game session can be terminated during a
|
4077
5273
|
# scale-down event.
|
@@ -4083,7 +5279,8 @@ module Aws::GameLift
|
|
4083
5279
|
# @!attribute [rw] operating_system
|
4084
5280
|
# The operating system of the fleet's computing resources. A fleet's
|
4085
5281
|
# operating system is determined by the OS of the build or script that
|
4086
|
-
# is deployed on this fleet.
|
5282
|
+
# is deployed on this fleet. This attribute is used with fleets where
|
5283
|
+
# `ComputeType` is "EC2" or "Container".
|
4087
5284
|
# @return [String]
|
4088
5285
|
#
|
4089
5286
|
# @!attribute [rw] resource_creation_limit_policy
|
@@ -4101,12 +5298,15 @@ module Aws::GameLift
|
|
4101
5298
|
# Name of a metric group that metrics for this fleet are added to. In
|
4102
5299
|
# Amazon CloudWatch, you can view aggregated metrics for fleets that
|
4103
5300
|
# are in a metric group. A fleet can be included in only one metric
|
4104
|
-
# group at a time.
|
5301
|
+
# group at a time. This attribute is used with fleets where
|
5302
|
+
# `ComputeType` is "EC2" or "Container".
|
4105
5303
|
# @return [Array<String>]
|
4106
5304
|
#
|
4107
5305
|
# @!attribute [rw] stopped_actions
|
4108
5306
|
# A list of fleet activity that has been suspended using
|
4109
|
-
# [StopFleetActions][1]
|
5307
|
+
# [StopFleetActions][1]. This includes fleet auto-scaling. This
|
5308
|
+
# attribute is used with fleets where `ComputeType` is "EC2" or
|
5309
|
+
# "Container".
|
4110
5310
|
#
|
4111
5311
|
#
|
4112
5312
|
#
|
@@ -4121,7 +5321,8 @@ module Aws::GameLift
|
|
4121
5321
|
# Amazon Web Services resources that you own or have access to. For
|
4122
5322
|
# more information about using the role with your game server builds,
|
4123
5323
|
# see [ Communicate with other Amazon Web Services resources from your
|
4124
|
-
# fleets][1].
|
5324
|
+
# fleets][1]. This attribute is used with fleets where `ComputeType`
|
5325
|
+
# is "EC2" or "Container".
|
4125
5326
|
#
|
4126
5327
|
#
|
4127
5328
|
#
|
@@ -4131,13 +5332,7 @@ module Aws::GameLift
|
|
4131
5332
|
# @!attribute [rw] certificate_configuration
|
4132
5333
|
# Determines whether a TLS/SSL certificate is generated for a fleet.
|
4133
5334
|
# This feature must be enabled when creating the fleet. All instances
|
4134
|
-
# in a fleet share the same certificate.
|
4135
|
-
# retrieved by calling the [Amazon GameLift Server SDK][1] operation
|
4136
|
-
# `GetInstanceCertificate`.
|
4137
|
-
#
|
4138
|
-
#
|
4139
|
-
#
|
4140
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html
|
5335
|
+
# in a fleet share the same certificate.
|
4141
5336
|
# @return [Types::CertificateConfiguration]
|
4142
5337
|
#
|
4143
5338
|
# @!attribute [rw] compute_type
|
@@ -4147,8 +5342,12 @@ module Aws::GameLift
|
|
4147
5342
|
# @return [String]
|
4148
5343
|
#
|
4149
5344
|
# @!attribute [rw] anywhere_configuration
|
4150
|
-
#
|
4151
|
-
#
|
5345
|
+
# **This property is used with the Amazon GameLift containers feature,
|
5346
|
+
# which is currently in public preview.** A set of attributes that
|
5347
|
+
# describe the container groups that are deployed on the fleet. These
|
5348
|
+
# attributes are included for fleets with compute type `CONTAINER`
|
5349
|
+
# only. This attribute is used with fleets where `ComputeType` is
|
5350
|
+
# "Container".
|
4152
5351
|
# @return [Types::AnywhereConfiguration]
|
4153
5352
|
#
|
4154
5353
|
# @!attribute [rw] instance_role_credentials_provider
|
@@ -4159,13 +5358,20 @@ module Aws::GameLift
|
|
4159
5358
|
# property is used only when the game server is integrated with the
|
4160
5359
|
# server SDK version 5.x. For more information about using shared
|
4161
5360
|
# credentials, see [ Communicate with other Amazon Web Services
|
4162
|
-
# resources from your fleets][1].
|
5361
|
+
# resources from your fleets][1]. This attribute is used with fleets
|
5362
|
+
# where `ComputeType` is "EC2" or "Container".
|
4163
5363
|
#
|
4164
5364
|
#
|
4165
5365
|
#
|
4166
5366
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html
|
4167
5367
|
# @return [String]
|
4168
5368
|
#
|
5369
|
+
# @!attribute [rw] container_groups_attributes
|
5370
|
+
# A set of properties that describe the container groups that are
|
5371
|
+
# deployed to the fleet. These attributes are included for fleets with
|
5372
|
+
# compute type `CONTAINER`.
|
5373
|
+
# @return [Types::ContainerGroupsAttributes]
|
5374
|
+
#
|
4169
5375
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/FleetAttributes AWS API Documentation
|
4170
5376
|
#
|
4171
5377
|
class FleetAttributes < Struct.new(
|
@@ -4194,19 +5400,18 @@ module Aws::GameLift
|
|
4194
5400
|
:certificate_configuration,
|
4195
5401
|
:compute_type,
|
4196
5402
|
:anywhere_configuration,
|
4197
|
-
:instance_role_credentials_provider
|
5403
|
+
:instance_role_credentials_provider,
|
5404
|
+
:container_groups_attributes)
|
4198
5405
|
SENSITIVE = []
|
4199
5406
|
include Aws::Structure
|
4200
5407
|
end
|
4201
5408
|
|
4202
|
-
# Current resource capacity settings
|
4203
|
-
#
|
4204
|
-
# home Region.
|
4205
|
-
#
|
4206
|
-
# **Related actions**
|
5409
|
+
# Current resource capacity settings for managed EC2 fleets and
|
5410
|
+
# container fleets. For multi-location fleets, location values might
|
5411
|
+
# refer to a fleet's remote location or its home Region.
|
4207
5412
|
#
|
4208
|
-
# [DescribeFleetCapacity][1]
|
4209
|
-
# [UpdateFleetCapacity][3]
|
5413
|
+
# **Returned by:** [DescribeFleetCapacity][1],
|
5414
|
+
# [DescribeFleetLocationCapacity][2], [UpdateFleetCapacity][3]
|
4210
5415
|
#
|
4211
5416
|
#
|
4212
5417
|
#
|
@@ -4230,10 +5435,10 @@ module Aws::GameLift
|
|
4230
5435
|
# @return [String]
|
4231
5436
|
#
|
4232
5437
|
# @!attribute [rw] instance_type
|
4233
|
-
# The Amazon EC2 instance type that is used for
|
4234
|
-
#
|
4235
|
-
#
|
4236
|
-
#
|
5438
|
+
# The Amazon EC2 instance type that is used for instances in a fleet.
|
5439
|
+
# Instance type determines the computing resources in use, including
|
5440
|
+
# CPU, memory, storage, and networking capacity. See [Amazon Elastic
|
5441
|
+
# Compute Cloud Instance Types][1] for detailed descriptions.
|
4237
5442
|
#
|
4238
5443
|
#
|
4239
5444
|
#
|
@@ -4241,10 +5446,10 @@ module Aws::GameLift
|
|
4241
5446
|
# @return [String]
|
4242
5447
|
#
|
4243
5448
|
# @!attribute [rw] instance_counts
|
4244
|
-
#
|
4245
|
-
#
|
4246
|
-
# fleet
|
4247
|
-
# resources is temporarily affected.
|
5449
|
+
# The current number of instances in the fleet, listed by instance
|
5450
|
+
# status. Counts for pending and terminating instances might be
|
5451
|
+
# non-zero if the fleet is adjusting to a scaling event or if access
|
5452
|
+
# to resources is temporarily affected.
|
4248
5453
|
# @return [Types::EC2InstanceCounts]
|
4249
5454
|
#
|
4250
5455
|
# @!attribute [rw] location
|
@@ -4252,6 +5457,12 @@ module Aws::GameLift
|
|
4252
5457
|
# an Amazon Web Services Region code, such as `us-west-2`.
|
4253
5458
|
# @return [String]
|
4254
5459
|
#
|
5460
|
+
# @!attribute [rw] replica_container_group_counts
|
5461
|
+
# **This property is used with the Amazon GameLift containers feature,
|
5462
|
+
# which is currently in public preview.** The number and status of
|
5463
|
+
# replica container groups in a container fleet.
|
5464
|
+
# @return [Types::ReplicaContainerGroupCounts]
|
5465
|
+
#
|
4255
5466
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/FleetCapacity AWS API Documentation
|
4256
5467
|
#
|
4257
5468
|
class FleetCapacity < Struct.new(
|
@@ -4259,7 +5470,8 @@ module Aws::GameLift
|
|
4259
5470
|
:fleet_arn,
|
4260
5471
|
:instance_type,
|
4261
5472
|
:instance_counts,
|
4262
|
-
:location
|
5473
|
+
:location,
|
5474
|
+
:replica_container_group_counts)
|
4263
5475
|
SENSITIVE = []
|
4264
5476
|
include Aws::Structure
|
4265
5477
|
end
|
@@ -4281,9 +5493,7 @@ module Aws::GameLift
|
|
4281
5493
|
|
4282
5494
|
# Current resource utilization statistics in a specified fleet or
|
4283
5495
|
# location. The location value might refer to a fleet's remote location
|
4284
|
-
# or its home
|
4285
|
-
#
|
4286
|
-
# **Related actions**
|
5496
|
+
# or its home region.
|
4287
5497
|
#
|
4288
5498
|
# @!attribute [rw] fleet_id
|
4289
5499
|
# A unique identifier for the fleet associated with the location.
|
@@ -5274,15 +6484,17 @@ module Aws::GameLift
|
|
5274
6484
|
end
|
5275
6485
|
|
5276
6486
|
# @!attribute [rw] fleet_id
|
5277
|
-
# A unique identifier for the fleet that
|
5278
|
-
# you want to connect to. You can use either the fleet ID or ARN
|
6487
|
+
# A unique identifier for the fleet that holds the compute resource
|
6488
|
+
# that you want to connect to. You can use either the fleet ID or ARN
|
5279
6489
|
# value.
|
5280
6490
|
# @return [String]
|
5281
6491
|
#
|
5282
6492
|
# @!attribute [rw] compute_name
|
5283
6493
|
# A unique identifier for the compute resource that you want to
|
5284
|
-
# connect to.
|
5285
|
-
#
|
6494
|
+
# connect to. For an EC2 fleet compute, use the instance ID. For a
|
6495
|
+
# container fleet, use the compute name (for example,
|
6496
|
+
# `a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9`)
|
6497
|
+
# or the compute ARN.
|
5286
6498
|
# @return [String]
|
5287
6499
|
#
|
5288
6500
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAccessInput AWS API Documentation
|
@@ -5295,8 +6507,7 @@ module Aws::GameLift
|
|
5295
6507
|
end
|
5296
6508
|
|
5297
6509
|
# @!attribute [rw] fleet_id
|
5298
|
-
# The ID of the fleet that
|
5299
|
-
# accessed.
|
6510
|
+
# The ID of the fleet that holds the compute resource to be accessed.
|
5300
6511
|
# @return [String]
|
5301
6512
|
#
|
5302
6513
|
# @!attribute [rw] fleet_arn
|
@@ -5332,6 +6543,11 @@ module Aws::GameLift
|
|
5332
6543
|
# (SSM).
|
5333
6544
|
# @return [Types::AwsCredentials]
|
5334
6545
|
#
|
6546
|
+
# @!attribute [rw] target
|
6547
|
+
# (For container fleets only) The instance ID where the compute
|
6548
|
+
# resource is running.
|
6549
|
+
# @return [String]
|
6550
|
+
#
|
5335
6551
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAccessOutput AWS API Documentation
|
5336
6552
|
#
|
5337
6553
|
class GetComputeAccessOutput < Struct.new(
|
@@ -5339,7 +6555,8 @@ module Aws::GameLift
|
|
5339
6555
|
:fleet_arn,
|
5340
6556
|
:compute_name,
|
5341
6557
|
:compute_arn,
|
5342
|
-
:credentials
|
6558
|
+
:credentials,
|
6559
|
+
:target)
|
5343
6560
|
SENSITIVE = [:credentials]
|
5344
6561
|
include Aws::Structure
|
5345
6562
|
end
|
@@ -5350,7 +6567,11 @@ module Aws::GameLift
|
|
5350
6567
|
#
|
5351
6568
|
# @!attribute [rw] compute_name
|
5352
6569
|
# The name of the compute resource you are requesting the
|
5353
|
-
# authentication token for.
|
6570
|
+
# authentication token for. For an Anywhere fleet compute, use the
|
6571
|
+
# registered compute name. For an EC2 fleet instance, use the instance
|
6572
|
+
# ID. For a container fleet, use the compute name (for example,
|
6573
|
+
# `a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9`)
|
6574
|
+
# or the compute ARN.
|
5354
6575
|
# @return [String]
|
5355
6576
|
#
|
5356
6577
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAuthTokenInput AWS API Documentation
|
@@ -5755,12 +6976,13 @@ module Aws::GameLift
|
|
5755
6976
|
end
|
5756
6977
|
|
5757
6978
|
# A range of IP addresses and port settings that allow inbound traffic
|
5758
|
-
# to connect to
|
5759
|
-
#
|
5760
|
-
#
|
5761
|
-
#
|
5762
|
-
#
|
5763
|
-
#
|
6979
|
+
# to connect to processes on an instance in a fleet. Processes are
|
6980
|
+
# assigned an IP address/port number combination, which must fall into
|
6981
|
+
# the fleet's allowed ranges. For container fleets, the port settings
|
6982
|
+
# must use the same port numbers as the fleet's connection ports.
|
6983
|
+
#
|
6984
|
+
# For Realtime Servers fleets, Amazon GameLift automatically opens two
|
6985
|
+
# port ranges, one for TCP messaging and one for UDP.
|
5764
6986
|
#
|
5765
6987
|
# @!attribute [rw] from_port
|
5766
6988
|
# A starting value for a range of allowed port numbers.
|
@@ -5981,7 +7203,11 @@ module Aws::GameLift
|
|
5981
7203
|
# @return [String]
|
5982
7204
|
#
|
5983
7205
|
# @!attribute [rw] location
|
5984
|
-
# The name of a location to retrieve compute resources for.
|
7206
|
+
# The name of a location to retrieve compute resources for. For an
|
7207
|
+
# Amazon GameLift Anywhere fleet, use a custom location. For a
|
7208
|
+
# multi-location EC2 or container fleet, provide a Amazon Web Services
|
7209
|
+
# Region or Local Zone code (for example: `us-west-2` or
|
7210
|
+
# `us-west-2-lax-1`).
|
5985
7211
|
# @return [String]
|
5986
7212
|
#
|
5987
7213
|
# @!attribute [rw] limit
|
@@ -6026,6 +7252,58 @@ module Aws::GameLift
|
|
6026
7252
|
include Aws::Structure
|
6027
7253
|
end
|
6028
7254
|
|
7255
|
+
# @!attribute [rw] scheduling_strategy
|
7256
|
+
# The type of container group definitions to retrieve.
|
7257
|
+
#
|
7258
|
+
# * `DAEMON` -- Daemon container groups run background processes and
|
7259
|
+
# are deployed once per fleet instance.
|
7260
|
+
#
|
7261
|
+
# * `REPLICA` -- Replica container groups run your game server
|
7262
|
+
# application and supporting software. Replica groups might be
|
7263
|
+
# deployed multiple times per fleet instance.
|
7264
|
+
# @return [String]
|
7265
|
+
#
|
7266
|
+
# @!attribute [rw] limit
|
7267
|
+
# The maximum number of results to return. Use this parameter with
|
7268
|
+
# `NextToken` to get results as a set of sequential pages.
|
7269
|
+
# @return [Integer]
|
7270
|
+
#
|
7271
|
+
# @!attribute [rw] next_token
|
7272
|
+
# A token that indicates the start of the next sequential page of
|
7273
|
+
# results. Use the token that is returned with a previous call to this
|
7274
|
+
# operation. To start at the beginning of the result set, do not
|
7275
|
+
# specify a value.
|
7276
|
+
# @return [String]
|
7277
|
+
#
|
7278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListContainerGroupDefinitionsInput AWS API Documentation
|
7279
|
+
#
|
7280
|
+
class ListContainerGroupDefinitionsInput < Struct.new(
|
7281
|
+
:scheduling_strategy,
|
7282
|
+
:limit,
|
7283
|
+
:next_token)
|
7284
|
+
SENSITIVE = []
|
7285
|
+
include Aws::Structure
|
7286
|
+
end
|
7287
|
+
|
7288
|
+
# @!attribute [rw] container_group_definitions
|
7289
|
+
# A result set of container group definitions that match the request.
|
7290
|
+
# @return [Array<Types::ContainerGroupDefinition>]
|
7291
|
+
#
|
7292
|
+
# @!attribute [rw] next_token
|
7293
|
+
# A token that indicates where to resume retrieving results on the
|
7294
|
+
# next call to this operation. If no token is returned, these results
|
7295
|
+
# represent the end of the list.
|
7296
|
+
# @return [String]
|
7297
|
+
#
|
7298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListContainerGroupDefinitionsOutput AWS API Documentation
|
7299
|
+
#
|
7300
|
+
class ListContainerGroupDefinitionsOutput < Struct.new(
|
7301
|
+
:container_group_definitions,
|
7302
|
+
:next_token)
|
7303
|
+
SENSITIVE = []
|
7304
|
+
include Aws::Structure
|
7305
|
+
end
|
7306
|
+
|
6029
7307
|
# @!attribute [rw] build_id
|
6030
7308
|
# A unique identifier for the build to request fleets for. Use this
|
6031
7309
|
# parameter to return only fleets using a specified build. Use either
|
@@ -6038,6 +7316,12 @@ module Aws::GameLift
|
|
6038
7316
|
# Use either the script ID or ARN value.
|
6039
7317
|
# @return [String]
|
6040
7318
|
#
|
7319
|
+
# @!attribute [rw] container_group_definition_name
|
7320
|
+
# The container group definition name to request fleets for. Use this
|
7321
|
+
# parameter to return only fleets that are deployed with the specified
|
7322
|
+
# container group definition.
|
7323
|
+
# @return [String]
|
7324
|
+
#
|
6041
7325
|
# @!attribute [rw] limit
|
6042
7326
|
# The maximum number of results to return. Use this parameter with
|
6043
7327
|
# `NextToken` to get results as a set of sequential pages.
|
@@ -6055,6 +7339,7 @@ module Aws::GameLift
|
|
6055
7339
|
class ListFleetsInput < Struct.new(
|
6056
7340
|
:build_id,
|
6057
7341
|
:script_id,
|
7342
|
+
:container_group_definition_name,
|
6058
7343
|
:limit,
|
6059
7344
|
:next_token)
|
6060
7345
|
SENSITIVE = []
|
@@ -6316,6 +7601,9 @@ module Aws::GameLift
|
|
6316
7601
|
include Aws::Structure
|
6317
7602
|
end
|
6318
7603
|
|
7604
|
+
# **This data type has been expanded to use with the Amazon GameLift
|
7605
|
+
# containers feature, which is currently in public preview.**
|
7606
|
+
#
|
6319
7607
|
# A remote location where a multi-location fleet can deploy game servers
|
6320
7608
|
# for game hosting.
|
6321
7609
|
#
|
@@ -6331,7 +7619,13 @@ module Aws::GameLift
|
|
6331
7619
|
include Aws::Structure
|
6332
7620
|
end
|
6333
7621
|
|
6334
|
-
# Properties of a location
|
7622
|
+
# Properties of a custom location for use in an Amazon GameLift Anywhere
|
7623
|
+
# fleet. This data type is returned in response to a call to
|
7624
|
+
# [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_CreateLocation.html][1].
|
7625
|
+
#
|
7626
|
+
#
|
7627
|
+
#
|
7628
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation.html
|
6335
7629
|
#
|
6336
7630
|
# @!attribute [rw] location_name
|
6337
7631
|
# The location's name.
|
@@ -6825,6 +8119,25 @@ module Aws::GameLift
|
|
6825
8119
|
include Aws::Structure
|
6826
8120
|
end
|
6827
8121
|
|
8122
|
+
# The operation failed because Amazon GameLift has not yet finished
|
8123
|
+
# validating this compute. We recommend attempting 8 to 10 retries over
|
8124
|
+
# 3 to 5 minutes with [exponential backoffs and jitter][1].
|
8125
|
+
#
|
8126
|
+
#
|
8127
|
+
#
|
8128
|
+
# [1]: http://aws.amazon.com/blogs/https:/aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
|
8129
|
+
#
|
8130
|
+
# @!attribute [rw] message
|
8131
|
+
# @return [String]
|
8132
|
+
#
|
8133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/NotReadyException AWS API Documentation
|
8134
|
+
#
|
8135
|
+
class NotReadyException < Struct.new(
|
8136
|
+
:message)
|
8137
|
+
SENSITIVE = []
|
8138
|
+
include Aws::Structure
|
8139
|
+
end
|
8140
|
+
|
6828
8141
|
# The specified game server group has no available game servers to
|
6829
8142
|
# fulfill a `ClaimGameServer` request. Clients can retry such requests
|
6830
8143
|
# immediately or after a waiting period.
|
@@ -7402,6 +8715,46 @@ module Aws::GameLift
|
|
7402
8715
|
include Aws::Structure
|
7403
8716
|
end
|
7404
8717
|
|
8718
|
+
# **This data type is used with the Amazon GameLift containers feature,
|
8719
|
+
# which is currently in public preview.**
|
8720
|
+
#
|
8721
|
+
# The number and status of replica container groups that are deployed
|
8722
|
+
# across a fleet with compute type `CONTAINER`. This information,
|
8723
|
+
# combined with the number of server processes being hosted per
|
8724
|
+
# container group (see `RuntimeConfiguration`), tells you how many game
|
8725
|
+
# sessions the fleet is currently capable of hosting concurrently.
|
8726
|
+
#
|
8727
|
+
# **Returned by:** DescribeFleetCapacity, DescribeFleetLocationCapacity
|
8728
|
+
#
|
8729
|
+
# @!attribute [rw] pending
|
8730
|
+
# The number of container groups that are starting up but have not yet
|
8731
|
+
# registered.
|
8732
|
+
# @return [Integer]
|
8733
|
+
#
|
8734
|
+
# @!attribute [rw] active
|
8735
|
+
# The number of container groups that have active game sessions.
|
8736
|
+
# @return [Integer]
|
8737
|
+
#
|
8738
|
+
# @!attribute [rw] idle
|
8739
|
+
# The number of container groups that have no active game sessions.
|
8740
|
+
# @return [Integer]
|
8741
|
+
#
|
8742
|
+
# @!attribute [rw] terminating
|
8743
|
+
# The number of container groups that are in the process of shutting
|
8744
|
+
# down.
|
8745
|
+
# @return [Integer]
|
8746
|
+
#
|
8747
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ReplicaContainerGroupCounts AWS API Documentation
|
8748
|
+
#
|
8749
|
+
class ReplicaContainerGroupCounts < Struct.new(
|
8750
|
+
:pending,
|
8751
|
+
:active,
|
8752
|
+
:idle,
|
8753
|
+
:terminating)
|
8754
|
+
SENSITIVE = []
|
8755
|
+
include Aws::Structure
|
8756
|
+
end
|
8757
|
+
|
7405
8758
|
# @!attribute [rw] build_id
|
7406
8759
|
# A unique identifier for the build to get credentials for. You can
|
7407
8760
|
# use either the build ID or ARN value.
|
@@ -7577,18 +8930,24 @@ module Aws::GameLift
|
|
7577
8930
|
include Aws::Structure
|
7578
8931
|
end
|
7579
8932
|
|
7580
|
-
#
|
7581
|
-
#
|
7582
|
-
#
|
7583
|
-
#
|
7584
|
-
#
|
7585
|
-
#
|
8933
|
+
# **This data type has been expanded to use with the Amazon GameLift
|
8934
|
+
# containers feature, which is currently in public preview.**
|
8935
|
+
#
|
8936
|
+
# A set of instructions that define the set of server processes to run
|
8937
|
+
# on computes in a fleet. Server processes run either an executable in a
|
8938
|
+
# custom game build or a Realtime Servers script. Amazon GameLift
|
8939
|
+
# launches the processes, manages their life cycle, and replaces them as
|
8940
|
+
# needed. Computes check regularly for an updated runtime configuration.
|
8941
|
+
#
|
8942
|
+
# On a container fleet, the Amazon GameLift Agent uses the runtime
|
8943
|
+
# configuration to manage the lifecycle of server processes in a replica
|
8944
|
+
# container group.
|
7586
8945
|
#
|
7587
|
-
#
|
7588
|
-
# concurrently. To calculate the total number of processes in a
|
7589
|
-
# configuration, add the values of the `ConcurrentExecutions`
|
7590
|
-
# for each server process. Learn more about [ Running Multiple
|
7591
|
-
# on a Fleet][1].
|
8946
|
+
# An Amazon GameLift instance is limited to 50 processes running
|
8947
|
+
# concurrently. To calculate the total number of processes defined in a
|
8948
|
+
# runtime configuration, add the values of the `ConcurrentExecutions`
|
8949
|
+
# parameter for each server process. Learn more about [ Running Multiple
|
8950
|
+
# Processes on a Fleet][1].
|
7592
8951
|
#
|
7593
8952
|
#
|
7594
8953
|
#
|
@@ -7596,13 +8955,13 @@ module Aws::GameLift
|
|
7596
8955
|
#
|
7597
8956
|
# @!attribute [rw] server_processes
|
7598
8957
|
# A collection of server process configurations that identify what
|
7599
|
-
# server processes to run on
|
8958
|
+
# server processes to run on fleet computes.
|
7600
8959
|
# @return [Array<Types::ServerProcess>]
|
7601
8960
|
#
|
7602
8961
|
# @!attribute [rw] max_concurrent_game_session_activations
|
7603
8962
|
# The number of game sessions in status `ACTIVATING` to allow on an
|
7604
|
-
# instance. This setting limits the instance resources
|
7605
|
-
# used for new game activations at any one time.
|
8963
|
+
# instance or container. This setting limits the instance resources
|
8964
|
+
# that can be used for new game activations at any one time.
|
7606
8965
|
# @return [Integer]
|
7607
8966
|
#
|
7608
8967
|
# @!attribute [rw] game_session_activation_timeout_seconds
|
@@ -8048,8 +9407,8 @@ module Aws::GameLift
|
|
8048
9407
|
include Aws::Structure
|
8049
9408
|
end
|
8050
9409
|
|
8051
|
-
# A set of instructions for launching server processes on
|
8052
|
-
#
|
9410
|
+
# A set of instructions for launching server processes on fleet
|
9411
|
+
# computes. Server processes run either an executable in a custom game
|
8053
9412
|
# build or a Realtime Servers script. Server process configurations are
|
8054
9413
|
# part of a fleet's runtime configuration.
|
8055
9414
|
#
|
@@ -8079,7 +9438,7 @@ module Aws::GameLift
|
|
8079
9438
|
#
|
8080
9439
|
# @!attribute [rw] concurrent_executions
|
8081
9440
|
# The number of server processes using this configuration that run
|
8082
|
-
# concurrently on each instance
|
9441
|
+
# concurrently on each instance or container..
|
8083
9442
|
# @return [Integer]
|
8084
9443
|
#
|
8085
9444
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ServerProcess AWS API Documentation
|
@@ -9426,11 +10785,11 @@ module Aws::GameLift
|
|
9426
10785
|
# @return [String]
|
9427
10786
|
#
|
9428
10787
|
# @!attribute [rw] runtime_configuration
|
9429
|
-
# Instructions for launching server processes on
|
9430
|
-
#
|
9431
|
-
#
|
9432
|
-
# of server processes to run
|
9433
|
-
#
|
10788
|
+
# Instructions for launching server processes on fleet computes.
|
10789
|
+
# Server processes run either a custom game build executable or a
|
10790
|
+
# Realtime Servers script. The runtime configuration lists the types
|
10791
|
+
# of server processes to run, how to launch them, and the number of
|
10792
|
+
# processes to run concurrently.
|
9434
10793
|
# @return [Types::RuntimeConfiguration]
|
9435
10794
|
#
|
9436
10795
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateRuntimeConfigurationInput AWS API Documentation
|
@@ -9443,8 +10802,8 @@ module Aws::GameLift
|
|
9443
10802
|
end
|
9444
10803
|
|
9445
10804
|
# @!attribute [rw] runtime_configuration
|
9446
|
-
# The runtime configuration currently in use by
|
9447
|
-
#
|
10805
|
+
# The runtime configuration currently in use by computes in the fleet.
|
10806
|
+
# If the update is successful, all property changes are shown.
|
9448
10807
|
# @return [Types::RuntimeConfiguration]
|
9449
10808
|
#
|
9450
10809
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateRuntimeConfigurationOutput AWS API Documentation
|