Class: MintPress::Aws::ECS::TaskDefinitionFamily

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

Properties (Read/Write)

  • #family_prefix ⇒ [String]
    'The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.'
    Property Attributes
    • list_task_definition_families_prop ⇒ 'family_prefix'
    • read_only ⇒ false
    • source ⇒ "list_task_definition_families"
    

17
18
19
20
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition_family.rb', line 17

property :family_prefix, list_task_definition_families_prop: 'family_prefix', type: [String], read_only: false, source: "list_task_definition_families", description: 'The familyPrefix is a string that is used to filter the results of
ListTaskDefinitionFamilies. If you specify a familyPrefix, only
task definition family names that begin with the familyPrefix string
are returned.'
  • #status ⇒ [String]
    'The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.'
    Property Attributes
    • list_task_definition_families_prop ⇒ 'status'
    • read_only ⇒ false
    • source ⇒ "list_task_definition_families"
    

21
22
23
24
25
26
27
28
29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition_family.rb', line 21

property :status, list_task_definition_families_prop: 'status', type: [String], read_only: false, source: "list_task_definition_families", description: 'The task definition family status with which to filter the
ListTaskDefinitionFamilies results. By default, both ACTIVE and
INACTIVE task definition families are listed. If this parameter is
set to ACTIVE, only task definition families that have an ACTIVE
task definition revision are returned. If this parameter is set to
INACTIVE, only task definition families that do not have any
ACTIVE task definition revisions are returned. If you paginate the
resulting output, be sure to keep the status value constant in each
subsequent request.'
  • #max_results ⇒ [Integer]
    'The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.'
    Property Attributes
    • list_task_definition_families_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "list_task_definition_families"
    

30
31
32
33
34
35
36
37
38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition_family.rb', line 30

property :max_results, list_task_definition_families_prop: 'max_results', type: [Integer], read_only: false, source: "list_task_definition_families", description: 'The maximum number of task definition family results returned by
ListTaskDefinitionFamilies in paginated output. When this parameter
is used, ListTaskDefinitions 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
ListTaskDefinitionFamilies request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not
used, then ListTaskDefinitionFamilies returns up to 100 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 
    

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

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
    

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

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

Returns a new instance of TaskDefinitionFamily.

Instance Method Details

#list ⇒ Object