Class: MintPress::Aws::ECS::Cluster

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

Properties (Read/Write)

  • #active_services_count ⇒ [Integer]
    'The number of services that are running on the cluster in an ACTIVE state.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'active_services_count'
    

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

property :active_services_count, disposition: :attribute, description: 'The number of services that are running on the cluster in an ACTIVE state.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'active_services_count', type: [Integer]
  • #attachments ⇒ Hash of ⇒ [MintPress::Aws::ECS::Attachment]
    'The resources attached to a cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'attachments'
    

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

property :attachments, disposition: :attribute, description: 'The resources attached to a cluster.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'attachments', type: [MintPress::Aws::ECS::Attachment], array: false, hash: true
  • #attachments_status ⇒ [String]
    'The status of the capacity providers associated with the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'attachments_status'
    

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

property :attachments_status, disposition: :attribute, description: 'The status of the capacity providers associated with the cluster.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'attachments_status', type: [String]
  • #capacity_providers ⇒ Array of ⇒ [String]
    'The capacity providers associated with the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'capacity_providers'
    • create_cluster_prop ⇒ 'capacity_providers'
    • read_only ⇒ false
    

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

property :capacity_providers, disposition: :attribute, description: 'The capacity providers associated with the cluster.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'capacity_providers', type: [String], array: true, create_cluster_prop: 'capacity_providers', read_only: false
  • #cluster_arn ⇒ [String]
    'The Amazon Resource Name (ARN) that identifies the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'cluster_arn'
    

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

property :cluster_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) that identifies the cluster.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'cluster_arn', type: [String]
  • #cluster_name ⇒ [String] (Default Value: Proc.new { self.name })
    'A user-generated string that you use to identify your cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'cluster_name'
    • create_cluster_prop ⇒ 'cluster_name'
    • read_only ⇒ false
    • default ⇒ Proc.new { self.name }
    

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

property :cluster_name, disposition: :attribute, description: 'A user-generated string that you use to identify your cluster.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'cluster_name', type: [String], create_cluster_prop: 'cluster_name', read_only: false, default: Proc.new { self.name }
  • #default_capacity_provider_strategy ⇒ Array of ⇒ [MintPress::Aws::ECS::CapacityProviderStrategyItem]
    'The default capacity provider strategy for the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'default_capacity_provider_strategy'
    • create_cluster_prop ⇒ 'default_capacity_provider_strategy'
    • read_only ⇒ false
    

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

property :default_capacity_provider_strategy, disposition: :attribute, description: 'The default capacity provider strategy for the cluster.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'default_capacity_provider_strategy', type: [MintPress::Aws::ECS::CapacityProviderStrategyItem], array: true, create_cluster_prop: 'default_capacity_provider_strategy', read_only: false
  • #pending_tasks_count ⇒ [Integer]
    'The number of tasks in the cluster that are in the PENDING state.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'pending_tasks_count'
    

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

property :pending_tasks_count, disposition: :attribute, description: 'The number of tasks in the cluster that are in the PENDING state.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'pending_tasks_count', type: [Integer]
  • #registered_container_instances_count ⇒ [Integer]
    'The number of container instances registered into the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'registered_container_instances_count'
    

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

property :registered_container_instances_count, disposition: :attribute, description: 'The number of container instances registered into the cluster.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'registered_container_instances_count', type: [Integer]
  • #running_tasks_count ⇒ [Integer]
    'The number of tasks in the cluster that are in the RUNNING state.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'running_tasks_count'
    

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

property :running_tasks_count, disposition: :attribute, description: 'The number of tasks in the cluster that are in the RUNNING state.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'running_tasks_count', type: [Integer]
  • #settings ⇒ Hash of ⇒ [MintPress::Aws::ECS::ClusterSetting]
    'The settings for the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'settings'
    • create_cluster_prop ⇒ 'settings'
    • read_only ⇒ false
    

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

property :settings, disposition: :attribute, description: 'The settings for the cluster.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'settings', type: [MintPress::Aws::ECS::ClusterSetting], array: false, create_cluster_prop: 'settings', read_only: false, hash: true
  • #statistics ⇒ Hash of ⇒ [MintPress::Aws::ECS::KeyValuePair]
    'Additional information about your clusters that are separated by launch type, including:.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'statistics'
    

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

property :statistics, disposition: :attribute, description: 'Additional information about your clusters that are separated by launch type, including:.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'statistics', type: [MintPress::Aws::ECS::KeyValuePair], array: false, hash: true
  • #status ⇒ [String]
    'The status of the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'status'
    

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

property :status, disposition: :attribute, description: 'The status of the cluster.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'status', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::ECS::Tag]
    'The metadata that you apply to the cluster to help you categorize and organize them.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Cluster"
    • orig_name ⇒ 'tags'
    • create_cluster_prop ⇒ 'tags'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The metadata that you apply to the cluster to help you categorize and organize them.', source: "MintPress::Aws::ECS::Cluster", orig_name: 'tags', type: [MintPress::Aws::ECS::Tag], array: false, create_cluster_prop: 'tags', read_only: false, hash: true
  • #cluster ⇒ [String]
    'The short name or full Amazon Resource Name (ARN) of the cluster to delete.'
    Property Attributes
    • delete_cluster_prop ⇒ 'cluster'
    • read_only ⇒ false
    • source ⇒ "delete_cluster"
    

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

property :cluster, delete_cluster_prop: 'cluster', type: [String], read_only: false, source: "delete_cluster", description: 'The short name or full Amazon Resource Name (ARN) of the cluster to
delete.'
  • #clusters ⇒ Array of ⇒ [String]
    'A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.'
    Property Attributes
    • describe_clusters_prop ⇒ 'clusters'
    • source ⇒ "describe_clusters"
    

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

property :clusters, describe_clusters_prop: 'clusters', type: [String], array: true, source: "describe_clusters", description: 'A list of up to 100 cluster names or full cluster Amazon Resource Name
(ARN) entries. If you do not specify a cluster, the default cluster is
assumed.'
  • #include ⇒ Array of ⇒ [String]
    'Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included. If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included. If SETTINGS is specified, the settings for the cluster are included. If STATISTICS is specified, the following additional information, separated by launch type, is included: runningEC2TasksCount runningFargateTasksCount pendingEC2TasksCount pendingFargateTasksCount activeEC2ServiceCount activeFargateServiceCount drainingEC2ServiceCount drainingFargateServiceCount If TAGS is specified, the metadata tags associated with the cluster are included.'
    Property Attributes
    • describe_clusters_prop ⇒ 'include'
    • source ⇒ "describe_clusters"
    

47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/cluster.rb', line 47

property :include, describe_clusters_prop: 'include', type: [String], array: true, source: "describe_clusters", description: 'Whether to include additional information about your clusters in the
response. If this field is omitted, the attachments, statistics, and
tags are not included.

If ATTACHMENTS is specified, the attachments for the container
instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information,
separated by launch type, is included:


runningEC2TasksCount
runningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount



If TAGS is specified, the metadata tags associated with the cluster
are included.'
  • #max_results ⇒ [Integer]
    'The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters 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 ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.'
    Property Attributes
    • list_clusters_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "list_clusters"
    

73
74
75
76
77
78
79
80
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/cluster.rb', line 73

property :max_results, list_clusters_prop: 'max_results', type: [Integer], read_only: false, source: "list_clusters", description: 'The maximum number of cluster results returned by ListClusters in
paginated output. When this parameter is used, ListClusters 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 ListClusters request with the returned
nextToken value. This value can be between 1 and 100. If this
parameter is not used, then ListClusters returns up to 100 results
and a nextToken value if applicable.'
  • #name ⇒ [String]

    Property Attributes 
    

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

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 
    

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

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
    

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

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 = {}) ⇒ Cluster

Returns a new instance of Cluster.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#list ⇒ Object