You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

When making an API call, you may pass UpdateFleetAttributesInput data as a hash:

{
  fleet_id: "FleetId", # required
  name: "NonZeroAndMaxString",
  description: "NonZeroAndMaxString",
  new_game_session_protection_policy: "NoProtection", # accepts NoProtection, FullProtection
  resource_creation_limit_policy: {
    new_game_sessions_per_creator: 1,
    policy_period_in_minutes: 1,
  },
  metric_groups: ["MetricGroup"],
}

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

Human-readable description of a fleet.

Returns:

  • (String)


5922
5923
5924
5925
5926
5927
5928
5929
5930
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5922

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

#fleet_idString

Unique identifier for a fleet to update attribute metadata for.

Returns:

  • (String)


5922
5923
5924
5925
5926
5927
5928
5929
5930
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5922

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

#metric_groupsArray<String>

Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

Returns:

  • (Array<String>)


5922
5923
5924
5925
5926
5927
5928
5929
5930
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5922

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

#nameString

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

Returns:

  • (String)


5922
5923
5924
5925
5926
5927
5928
5929
5930
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5922

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

#new_game_session_protection_policyString

Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances 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.

Returns:

  • (String)


5922
5923
5924
5925
5926
5927
5928
5929
5930
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5922

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

#resource_creation_limit_policyTypes::ResourceCreationLimitPolicy

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



5922
5923
5924
5925
5926
5927
5928
5929
5930
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5922

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