Class: Aws::GameLift::Types::UpdateFleetAttributesInput

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::UpdateFleetAttributesInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #anywhere_configuration ⇒ Types::AnywhereConfiguration

  Amazon GameLift Anywhere configuration options.

• #description ⇒ String

  A human-readable description of a fleet.

• #fleet_id ⇒ String

  A unique identifier for the fleet to update attribute metadata for.

• #metric_groups ⇒ Array<String>

  The name of a metric group to add this fleet to.

• #name ⇒ String

  A descriptive label that is associated with a fleet.

• #new_game_session_protection_policy ⇒ String

  The game session protection policy to apply to all new game sessions created in this fleet.

• #resource_creation_limit_policy ⇒ Types::ResourceCreationLimitPolicy

  Policy settings that limit the number of game sessions an individual player can create over a span of time.

Instance Attribute Details

#anywhere_configuration ⇒ Types::AnywhereConfiguration

Amazon GameLift Anywhere configuration options.

Returns:

• (Types::AnywhereConfiguration)

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

class UpdateFleetAttributesInput < Struct.new(
  :fleet_id,
  :name,
  :description,
  :new_game_session_protection_policy,
  :resource_creation_limit_policy,
  :metric_groups,
  :anywhere_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A human-readable description of a fleet.

Returns:

• (String)

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

class UpdateFleetAttributesInput < Struct.new(
  :fleet_id,
  :name,
  :description,
  :new_game_session_protection_policy,
  :resource_creation_limit_policy,
  :metric_groups,
  :anywhere_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#fleet_id ⇒ String

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

Returns:

• (String)

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

class UpdateFleetAttributesInput < Struct.new(
  :fleet_id,
  :name,
  :description,
  :new_game_session_protection_policy,
  :resource_creation_limit_policy,
  :metric_groups,
  :anywhere_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#metric_groups ⇒ Array<String>

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Returns:

• (Array<String>)

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

class UpdateFleetAttributesInput < Struct.new(
  :fleet_id,
  :name,
  :description,
  :new_game_session_protection_policy,
  :resource_creation_limit_policy,
  :metric_groups,
  :anywhere_configuration)
  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 'lib/aws-sdk-gamelift/types.rb', line 11336

class UpdateFleetAttributesInput < Struct.new(
  :fleet_id,
  :name,
  :description,
  :new_game_session_protection_policy,
  :resource_creation_limit_policy,
  :metric_groups,
  :anywhere_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#new_game_session_protection_policy ⇒ String

The game session protection policy to apply to all new game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions using [UpdateGameSession].

• 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.

[1]: docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html

Returns:

• (String)

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

class UpdateFleetAttributesInput < Struct.new(
  :fleet_id,
  :name,
  :description,
  :new_game_session_protection_policy,
  :resource_creation_limit_policy,
  :metric_groups,
  :anywhere_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#resource_creation_limit_policy ⇒ Types::ResourceCreationLimitPolicy

Policy settings that limit the number of game sessions an individual player can create over a span of time.

Returns:

• (Types::ResourceCreationLimitPolicy)

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

class UpdateFleetAttributesInput < Struct.new(
  :fleet_id,
  :name,
  :description,
  :new_game_session_protection_policy,
  :resource_creation_limit_policy,
  :metric_groups,
  :anywhere_configuration)
  SENSITIVE = []
  include Aws::Structure
end