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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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][1

in the *Amazon Elastic Container Service Developer

Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name of the attribute. The `name` must contain between 1 and 128 characters and name may contain letters (uppercase and lowercase), numbers, hyphens, underscores, forward slashes, back slashes, or periods.

Returns:

  • (String)

127
128
129
130
131
132
133
134
# File 'lib/aws-sdk-ecs/types.rb', line 127

class Attribute < Struct.new(
  :name,
  :value,
  :target_type,
  :target_id)
  SENSITIVE = []
  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)

127
128
129
130
131
132
133
134
# File 'lib/aws-sdk-ecs/types.rb', line 127

class Attribute < Struct.new(
  :name,
  :value,
  :target_type,
  :target_id)
  SENSITIVE = []
  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)

127
128
129
130
131
132
133
134
# File 'lib/aws-sdk-ecs/types.rb', line 127

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

#valueString

The value of the attribute. The `value` must contain between 1 and 128 characters and may contain letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, back slashes, colons, or spaces. The value cannot contain any leading or trailing whitespace.

Returns:

  • (String)

127
128
129
130
131
132
133
134
# File 'lib/aws-sdk-ecs/types.rb', line 127

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