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

Class: Aws::ECS::Types::Attribute

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

Overview

Note:

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

{
  name: "String", # required
  value: "String",
  target_type: "container-instance", # accepts container-instance
  target_id: "String",
}

An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.

Returns:

  • (String)


113
114
115
116
117
118
119
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 113

class Attribute < Struct.new(
  :name,
  :value,
  :target_type,
  :target_id)
  include Aws::Structure
end

#target_idString

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

Returns:

  • (String)


113
114
115
116
117
118
119
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 113

class Attribute < Struct.new(
  :name,
  :value,
  :target_type,
  :target_id)
  include Aws::Structure
end

#target_typeString

The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.

Returns:

  • (String)


113
114
115
116
117
118
119
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 113

class Attribute < Struct.new(
  :name,
  :value,
  :target_type,
  :target_id)
  include Aws::Structure
end

#valueString

The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.

Returns:

  • (String)


113
114
115
116
117
118
119
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 113

class Attribute < Struct.new(
  :name,
  :value,
  :target_type,
  :target_id)
  include Aws::Structure
end