Class: MintPress::Aws::ECS::ContainerInstance

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb

Properties (Read/Write)

  • #agent_connected ⇒ [TrueClass,FalseClass]
    'This parameter returns true if the agent is connected to Amazon ECS.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'agent_connected'
    

25
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 25

property :agent_connected, disposition: :attribute, description: 'This parameter returns true if the agent is connected to Amazon ECS.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'agent_connected', type: [TrueClass,FalseClass]
  • #agent_update_status ⇒ [String]
    'The status of the most recent agent update.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'agent_update_status'
    

26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 26

property :agent_update_status, disposition: :attribute, description: 'The status of the most recent agent update.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'agent_update_status', type: [String]
  • #attachments ⇒ Hash of ⇒ [MintPress::Aws::ECS::Attachment]
    'The resources attached to a container instance, such as elastic network interfaces.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'attachments'
    

27
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 27

property :attachments, disposition: :attribute, description: 'The resources attached to a container instance, such as elastic network interfaces.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'attachments', type: [MintPress::Aws::ECS::Attachment], array: false, hash: true
  • #attributes ⇒ Hash of ⇒ [MintPress::Aws::ECS::Attribute]
    'The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'attributes'
    

28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 28

property :attributes, disposition: :attribute, description: 'The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'attributes', type: [MintPress::Aws::ECS::Attribute], array: false, hash: true
  • #capacity_provider_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The capacity provider associated with the container instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'capacity_provider_name'
    • default ⇒ Proc.new { self.name }
    

29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 29

property :capacity_provider_name, disposition: :attribute, description: 'The capacity provider associated with the container instance.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'capacity_provider_name', type: [String], default: Proc.new { self.name }
  • #container_instance_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the container instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'container_instance_arn'
    

30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 30

property :container_instance_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the container instance.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'container_instance_arn', type: [String]
  • #pending_tasks_count ⇒ [Integer]
    'The number of tasks on the container instance that are in the PENDING status.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'pending_tasks_count'
    

31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 31

property :pending_tasks_count, disposition: :attribute, description: 'The number of tasks on the container instance that are in the PENDING status.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'pending_tasks_count', type: [Integer]
  • #registered_at ⇒ [Time]
    'The Unix timestamp for when the container instance was registered.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'registered_at'
    

32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 32

property :registered_at, disposition: :attribute, description: 'The Unix timestamp for when the container instance was registered.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'registered_at', type: [Time]
  • #registered_resources ⇒ Hash of ⇒ [MintPress::Aws::ECS::Resource]
    'For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'registered_resources'
    

33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 33

property :registered_resources, disposition: :attribute, description: 'For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'registered_resources', type: [MintPress::Aws::ECS::Resource], array: false, hash: true
  • #remaining_resources ⇒ Hash of ⇒ [MintPress::Aws::ECS::Resource]
    'For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'remaining_resources'
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 34

property :remaining_resources, disposition: :attribute, description: 'For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'remaining_resources', type: [MintPress::Aws::ECS::Resource], array: false, hash: true
  • #running_tasks_count ⇒ [Integer]
    'The number of tasks on the container instance that are in the RUNNING status.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'running_tasks_count'
    

35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 35

property :running_tasks_count, disposition: :attribute, description: 'The number of tasks on the container instance that are in the RUNNING status.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'running_tasks_count', type: [Integer]
  • #status ⇒ [String]
    'The status of the container instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'status'
    • list_container_instances_prop ⇒ 'status'
    • read_only ⇒ false
    

36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 36

property :status, disposition: :attribute, description: 'The status of the container instance.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'status', type: [String], list_container_instances_prop: 'status', read_only: false
  • #status_reason ⇒ [String]
    'The reason that the container instance reached its current status.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'status_reason'
    

37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 37

property :status_reason, disposition: :attribute, description: 'The reason that the container instance reached its current status.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'status_reason', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::ECS::Tag]
    'The metadata that you apply to the container instance to help you categorize and organize them.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'tags'
    

38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 38

property :tags, disposition: :attribute, description: 'The metadata that you apply to the container instance to help you categorize and organize them.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'tags', type: [MintPress::Aws::ECS::Tag], array: false, hash: true
  • #version ⇒ [Integer]
    'The version counter for the container instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'version'
    

39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 39

property :version, disposition: :attribute, description: 'The version counter for the container instance.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'version', type: [Integer]
  • #version_info ⇒ [MintPress::Aws::ECS::VersionInfo] (Default Value: MintPress::Aws::ECS::VersionInfo.new)
    'The version information for the Amazon ECS container agent and Docker daemon running on the container instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'version_info'
    • default ⇒ MintPress::Aws::ECS::VersionInfo.new
    

40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 40

property :version_info, disposition: :attribute, description: 'The version information for the Amazon ECS container agent and Docker daemon running on the container instance.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'version_info', type: [MintPress::Aws::ECS::VersionInfo], default: MintPress::Aws::ECS::VersionInfo.new
  • #cluster ⇒ [String]
    'The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.'
    Property Attributes
    • describe_container_instances_prop ⇒ 'cluster'
    • source ⇒ "list_container_instances"
    • list_container_instances_prop ⇒ 'cluster'
    • read_only ⇒ false
    

41
42
43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 41

property :cluster, describe_container_instances_prop: 'cluster', type: [String], source: "list_container_instances", description: 'The short name or full Amazon Resource Name (ARN) of the cluster that
hosts the container instances to list. If you do not specify a
cluster, the default cluster is assumed.', list_container_instances_prop: 'cluster', read_only: false
  • #container_instances ⇒ Array of ⇒ [String]
    'A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.'
    Property Attributes
    • describe_container_instances_prop ⇒ 'container_instances'
    • source ⇒ "describe_container_instances"
    

44
45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 44

property :container_instances, describe_container_instances_prop: 'container_instances', type: [String], array: true, source: "describe_container_instances", description: 'A list of up to 100 container instance IDs or full Amazon Resource
Name (ARN) entries.'
  • #include ⇒ Array of ⇒ [String]
    'Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.'
    Property Attributes
    • describe_container_instances_prop ⇒ 'include'
    • source ⇒ "describe_container_instances"
    

46
47
48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 46

property :include, describe_container_instances_prop: 'include', type: [String], array: true, source: "describe_container_instances", description: 'Specifies whether you want to see the resource tags for the container
instance. If TAGS is specified, the tags are included in the
response. If this field is omitted, tags are not included in the
response.'
  • #filter ⇒ [String]
    'You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.'
    Property Attributes
    • list_container_instances_prop ⇒ 'filter'
    • read_only ⇒ false
    • source ⇒ "list_container_instances"
    

50
51
52
53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 50

property :filter, list_container_instances_prop: 'filter', type: [String], read_only: false, source: "list_container_instances", description: 'You can filter the results of a ListContainerInstances operation
with cluster query language statements. For more information, see
Cluster Query Language in the Amazon Elastic Container Service
Developer Guide.'
  • #max_results ⇒ [Integer]
    'The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.'
    Property Attributes
    • list_container_instances_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "list_container_instances"
    

54
55
56
57
58
59
60
61
62
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 54

property :max_results, list_container_instances_prop: 'max_results', type: [Integer], read_only: false, source: "list_container_instances", description: 'The maximum number of container instance results returned by
ListContainerInstances in paginated output. When this parameter is
used, ListContainerInstances only returns maxResults results in a
single page along with a nextToken response element. The remaining
results of the initial request can be seen by sending another
ListContainerInstances request with the returned nextToken value.
This value can be between 1 and 100. If this parameter is not used,
then ListContainerInstances returns up to 100 results and a
nextToken value if applicable.'
  • #ec2_instance ⇒ [String]
    'The EC2 instance ID of the container instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::ContainerInstance"
    • orig_name ⇒ 'ec2_instance_id'
    

63
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 63

property :ec2_instance, disposition: :attribute, description: 'The EC2 instance ID of the container instance.', source: "MintPress::Aws::ECS::ContainerInstance", orig_name: 'ec2_instance_id', type: [String]
  • #name ⇒ [String]

    Property Attributes 
    

64
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 64

property :name, type: [String]
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

68
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 68

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

71
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instance.rb', line 71

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ ContainerInstance

Returns a new instance of ContainerInstance.

Instance Method Details

#describe ⇒ Object

#list ⇒ Object