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

Class: Aws::GameLift::Types::CreateAliasInput

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 CreateAliasInput data as a hash:

{
  name: "NonBlankAndLengthConstraintString", # required
  description: "NonZeroAndMaxString",
  routing_strategy: { # required
    type: "SIMPLE", # accepts SIMPLE, TERMINAL
    fleet_id: "FleetId",
    message: "FreeText",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A human-readable description of the alias.

Returns:

  • (String)


377
378
379
380
381
382
383
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 377

class CreateAliasInput < Struct.new(
  :name,
  :description,
  :routing_strategy,
  :tags)
  include Aws::Structure
end

#nameString

A descriptive label that is associated with an alias. Alias names do not need to be unique.

Returns:

  • (String)


377
378
379
380
381
382
383
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 377

class CreateAliasInput < Struct.new(
  :name,
  :description,
  :routing_strategy,
  :tags)
  include Aws::Structure
end

#routing_strategyTypes::RoutingStrategy

The routing configuration, including routing type and fleet target, for the alias.



377
378
379
380
381
382
383
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 377

class CreateAliasInput < Struct.new(
  :name,
  :description,
  :routing_strategy,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:



377
378
379
380
381
382
383
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 377

class CreateAliasInput < Struct.new(
  :name,
  :description,
  :routing_strategy,
  :tags)
  include Aws::Structure
end