Class: Aws::GameLift::Types::FleetAttributes

Inherits:

Struct

Object
Struct
Aws::GameLift::Types::FleetAttributes

show all

Defined in:: gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Describes an Amazon GameLift fleet of game hosting resources. Attributes differ based on the fleet's compute type, as follows:

EC2 fleet attributes identify a Build resource (for fleets with customer game server builds) or a Script resource (for Realtime Servers fleets).
Container fleets have ContainerGroupsAttributes, which identify the fleet's ContainerGroupDefinition resources.
Amazon GameLift Anywhere fleets have an abbreviated set of attributes, because most fleet configurations are set directly on the fleet's computes. Attributes include fleet identifiers and descriptive properties, creation/termination time, and fleet status.

Returned by: DescribeFleetAttributes

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#anywhere_configuration ⇒ Types::AnywhereConfiguration
This property is used with the Amazon GameLift containers feature, which is currently in public preview. A set of attributes that describe the container groups that are deployed on the fleet.
#build_arn ⇒ String
The Amazon Resource Name ([ARN][1]) associated with the Amazon GameLift build resource that is deployed on instances in this fleet.
#build_id ⇒ String
A unique identifier for the build resource that is deployed on instances in this fleet.
#certificate_configuration ⇒ Types::CertificateConfiguration
Determines whether a TLS/SSL certificate is generated for a fleet.
#compute_type ⇒ String
The type of compute resource used to host your game servers.
#container_groups_attributes ⇒ Types::ContainerGroupsAttributes
A set of properties that describe the container groups that are deployed to the fleet.
#creation_time ⇒ Time
A time stamp indicating when this data object was created.
#description ⇒ String
A human-readable description of the fleet.
#fleet_arn ⇒ String
The Amazon Resource Name ([ARN][1]) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it.
#fleet_id ⇒ String
A unique identifier for the fleet.
#fleet_type ⇒ String
Indicates whether the fleet uses On-Demand or Spot instances.
#instance_role_arn ⇒ String
A unique identifier for an IAM role with access permissions to other Amazon Web Services services.
#instance_role_credentials_provider ⇒ String
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn.
#instance_type ⇒ String
The Amazon EC2 instance type that the fleet uses.
#log_paths ⇒ Array<String>
This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server API ProcessReady() logParameters.
#metric_groups ⇒ Array<String>
Name of a metric group that metrics for this fleet are added to.
#name ⇒ String
A descriptive label that is associated with a fleet.
#new_game_session_protection_policy ⇒ String
The type of game session protection to set on all new instances that are started in the fleet.
#operating_system ⇒ String
The operating system of the fleet's computing resources.
#resource_creation_limit_policy ⇒ Types::ResourceCreationLimitPolicy
A policy that puts limits on the number of game sessions that a player can create within a specified span of time.
#script_arn ⇒ String
The Amazon Resource Name ([ARN][1]) associated with the GameLift script resource that is deployed on instances in this fleet.
#script_id ⇒ String
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
#server_launch_parameters ⇒ String
This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration .
#server_launch_path ⇒ String
This parameter is no longer used. Server launch paths are now defined using the fleet's [RuntimeConfiguration][1] .
#status ⇒ String
Current status of the fleet.
#stopped_actions ⇒ Array<String>
A list of fleet activity that has been suspended using [StopFleetActions][1].
#termination_time ⇒ Time
A time stamp indicating when this data object was terminated.

Instance Attribute Details

#anywhere_configuration ⇒ `Types::AnywhereConfiguration`

This property is used with the Amazon GameLift containers feature, which is currently in public preview. A set of attributes that describe the container groups that are deployed on the fleet. These attributes are included for fleets with compute type CONTAINER only. This attribute is used with fleets where ComputeType is "Container".

Returns:

(Types::AnywhereConfiguration)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#build_arn ⇒ `String`

The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value. This attribute is used with fleets where ComputeType is "EC2".

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#build_id ⇒ `String`

A unique identifier for the build resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2".

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_configuration ⇒ `Types::CertificateConfiguration`

Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate.

Returns:

(Types::CertificateConfiguration)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#compute_type ⇒ `String`

The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#container_groups_attributes ⇒ `Types::ContainerGroupsAttributes`

A set of properties that describe the container groups that are deployed to the fleet. These attributes are included for fleets with compute type CONTAINER.

Returns:

(Types::ContainerGroupsAttributes)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ `Time`

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

(Time)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A human-readable description of the fleet.

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#fleet_arn ⇒ `String`

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#fleet_id ⇒ `String`

A unique identifier for the fleet.

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#fleet_type ⇒ `String`

Indicates whether the fleet uses On-Demand or Spot instances. For more information, see On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#instance_role_arn ⇒ `String`

A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets. This attribute is used with fleets where ComputeType is "EC2" or "Container".

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#instance_role_credentials_provider ⇒ `String`

Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets. This attribute is used with fleets where ComputeType is "EC2" or "Container".

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ `String`

The Amazon EC2 instance type that the fleet uses. Instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions. This attribute is used with fleets where ComputeType is "EC2" or "Container".

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#log_paths ⇒ `Array<String>`

This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

Returns:

(Array<String>)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#metric_groups ⇒ `Array<String>`

Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time. This attribute is used with fleets where ComputeType is "EC2" or "Container".

Returns:

(Array<String>)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#new_game_session_protection_policy ⇒ `String`

The type of game session protection to set on all new instances that are started in the fleet. This attribute is used with fleets where ComputeType is "EC2" or "Container".

NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#operating_system ⇒ `String`

The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet. This attribute is used with fleets where ComputeType is "EC2" or "Container".

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#resource_creation_limit_policy ⇒ `Types::ResourceCreationLimitPolicy`

A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.

The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.

Returns:

(Types::ResourceCreationLimitPolicy)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#script_arn ⇒ `String`

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#script_id ⇒ `String`

A unique identifier for the Realtime script resource that is deployed on instances in this fleet. This attribute is used with fleets where ComputeType is "EC2".

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#server_launch_parameters ⇒ `String`

This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration . Requests that use this parameter continue to be valid.

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#server_launch_path ⇒ `String`

This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter continue to be valid.

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

Current status of the fleet. Possible fleet statuses include the following:

NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.

Returns:

(String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#stopped_actions ⇒ `Array<String>`

A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling. This attribute is used with fleets where ComputeType is "EC2" or "Container".

Returns:

(Array<String>)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#termination_time ⇒ `Time`

A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

(Time)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5377

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :fleet_type,
  :instance_type,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :build_arn,
  :script_id,
  :script_arn,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups,
  :stopped_actions,
  :instance_role_arn,
  :certificate_configuration,
  :compute_type,
  :anywhere_configuration,
  :instance_role_credentials_provider,
  :container_groups_attributes)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::GameLift::Types::FleetAttributes

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#anywhere_configuration ⇒ Types::AnywhereConfiguration

#build_arn ⇒ String

#build_id ⇒ String

#certificate_configuration ⇒ Types::CertificateConfiguration

#compute_type ⇒ String

#container_groups_attributes ⇒ Types::ContainerGroupsAttributes

#creation_time ⇒ Time

#description ⇒ String

#fleet_arn ⇒ String

#fleet_id ⇒ String

#fleet_type ⇒ String

#instance_role_arn ⇒ String

#instance_role_credentials_provider ⇒ String

#instance_type ⇒ String

#log_paths ⇒ Array<String>

#metric_groups ⇒ Array<String>

#name ⇒ String

#new_game_session_protection_policy ⇒ String

#operating_system ⇒ String

#resource_creation_limit_policy ⇒ Types::ResourceCreationLimitPolicy

#script_arn ⇒ String

#script_id ⇒ String

#server_launch_parameters ⇒ String

#server_launch_path ⇒ String

#status ⇒ String

#stopped_actions ⇒ Array<String>

#termination_time ⇒ Time

#anywhere_configuration ⇒ `Types::AnywhereConfiguration`

#build_arn ⇒ `String`

#build_id ⇒ `String`

#certificate_configuration ⇒ `Types::CertificateConfiguration`

#compute_type ⇒ `String`

#container_groups_attributes ⇒ `Types::ContainerGroupsAttributes`

#creation_time ⇒ `Time`

#description ⇒ `String`

#fleet_arn ⇒ `String`

#fleet_id ⇒ `String`

#fleet_type ⇒ `String`

#instance_role_arn ⇒ `String`

#instance_role_credentials_provider ⇒ `String`

#instance_type ⇒ `String`

#log_paths ⇒ `Array<String>`

#metric_groups ⇒ `Array<String>`

#name ⇒ `String`

#new_game_session_protection_policy ⇒ `String`

#operating_system ⇒ `String`

#resource_creation_limit_policy ⇒ `Types::ResourceCreationLimitPolicy`

#script_arn ⇒ `String`

#script_id ⇒ `String`

#server_launch_parameters ⇒ `String`

#server_launch_path ⇒ `String`

#status ⇒ `String`

#stopped_actions ⇒ `Array<String>`

#termination_time ⇒ `Time`