Class: MintPress::Aws::ECS::CapacityProvider

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

Properties (Read/Write)

  • #auto_scaling_group_provider ⇒ [MintPress::Aws::ECS::AutoScalingGroupProviderUpdate] (Default Value: MintPress::Aws::ECS::AutoScalingGroupProviderUpdate.new)
    'The name of the capacity provider to update.'
    Property Attributes
    • source ⇒ "update_capacity_provider"
    • orig_name ⇒ 'auto_scaling_group_provider'
    • default ⇒ MintPress::Aws::ECS::AutoScalingGroupProviderUpdate.new
    • create_capacity_provider_prop ⇒ 'auto_scaling_group_provider'
    • read_only ⇒ false
    • update_capacity_provider_prop ⇒ 'auto_scaling_group_provider'
    

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

property :auto_scaling_group_provider, description: 'The name of the capacity provider to update.', source: "update_capacity_provider", orig_name: 'auto_scaling_group_provider', type: [MintPress::Aws::ECS::AutoScalingGroupProviderUpdate], default: MintPress::Aws::ECS::AutoScalingGroupProviderUpdate.new, create_capacity_provider_prop: 'auto_scaling_group_provider', read_only: false, update_capacity_provider_prop: 'auto_scaling_group_provider'
  • #capacity_provider_arn ⇒ [String]
    'The Amazon Resource Name (ARN) that identifies the capacity provider.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::CapacityProvider"
    • orig_name ⇒ 'capacity_provider_arn'
    

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

property :capacity_provider_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) that identifies the capacity provider.', source: "MintPress::Aws::ECS::CapacityProvider", orig_name: 'capacity_provider_arn', type: [String]
  • #name ⇒ [String]
    'An object representing the parameters to update for the Auto Scaling group capacity provider.'
    Property Attributes
    • source ⇒ "update_capacity_provider"
    • orig_name ⇒ 'name'
    • create_capacity_provider_prop ⇒ 'name'
    • read_only ⇒ false
    • update_capacity_provider_prop ⇒ 'name'
    

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

property :name, description: 'An object representing the parameters to update for the Auto Scaling
group capacity provider.', source: "update_capacity_provider", orig_name: 'name', type: [String], create_capacity_provider_prop: 'name', read_only: false, update_capacity_provider_prop: 'name'
  • #status ⇒ [String]
    'The current status of the capacity provider.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::CapacityProvider"
    • orig_name ⇒ 'status'
    

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

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

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

property :tags, disposition: :attribute, description: 'The metadata that you apply to the capacity provider to help you categorize and organize it.', source: "MintPress::Aws::ECS::CapacityProvider", orig_name: 'tags', type: [MintPress::Aws::ECS::Tag], array: false, create_capacity_provider_prop: 'tags', read_only: false, hash: true
  • #update_status ⇒ [String]
    'The update status of the capacity provider.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::CapacityProvider"
    • orig_name ⇒ 'update_status'
    

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

property :update_status, disposition: :attribute, description: 'The update status of the capacity provider.', source: "MintPress::Aws::ECS::CapacityProvider", orig_name: 'update_status', type: [String]
  • #update_status_reason ⇒ [String]
    'The update status reason.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::CapacityProvider"
    • orig_name ⇒ 'update_status_reason'
    

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

property :update_status_reason, disposition: :attribute, description: 'The update status reason.', source: "MintPress::Aws::ECS::CapacityProvider", orig_name: 'update_status_reason', type: [String]
  • #capacity_provider ⇒ [String]
    'The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.'
    Property Attributes
    • delete_capacity_provider_prop ⇒ 'capacity_provider'
    • read_only ⇒ false
    • source ⇒ "delete_capacity_provider"
    

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

property :capacity_provider, delete_capacity_provider_prop: 'capacity_provider', type: [String], read_only: false, source: "delete_capacity_provider", description: 'The short name or full Amazon Resource Name (ARN) of the capacity
provider to delete.'
  • #capacity_providers ⇒ Array of ⇒ [String]
    'The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.'
    Property Attributes
    • describe_capacity_providers_prop ⇒ 'capacity_providers'
    • source ⇒ "describe_capacity_providers"
    

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

property :capacity_providers, describe_capacity_providers_prop: 'capacity_providers', type: [String], array: true, source: "describe_capacity_providers", description: 'The short name or full Amazon Resource Name (ARN) of one or more
capacity providers. Up to 100 capacity providers can be described in
an action.'
  • #include ⇒ Array of ⇒ [String]
    'Specifies whether or not you want to see the resource tags for the capacity provider. 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_capacity_providers_prop ⇒ 'include'
    • source ⇒ "describe_capacity_providers"
    

38
39
40
41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/capacity_provider.rb', line 38

property :include, describe_capacity_providers_prop: 'include', type: [String], array: true, source: "describe_capacity_providers", description: 'Specifies whether or not you want to see the resource tags for the
capacity provider. If TAGS is specified, the tags are included in
the response. If this field is omitted, tags are not included in the
response.'
  • #max_results ⇒ [Integer]
    'The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders 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 DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.'
    Property Attributes
    • describe_capacity_providers_prop ⇒ 'max_results'
    • source ⇒ "describe_capacity_providers"
    

42
43
44
45
46
47
48
49
50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/capacity_provider.rb', line 42

property :max_results, describe_capacity_providers_prop: 'max_results', type: [Integer], source: "describe_capacity_providers", description: 'The maximum number of account setting results returned by
DescribeCapacityProviders in paginated output. When this parameter
is used, DescribeCapacityProviders 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 DescribeCapacityProviders request with the returned
nextToken value. This value can be between 1 and 10. If this
parameter is not used, then DescribeCapacityProviders returns up to
10 results and a nextToken value if applicable.'
  • #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 
    

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

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
    

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

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

Returns a new instance of CapacityProvider.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#update ⇒ Object