Class: MintPress::Aws::ECS::ContainerInstancesState

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

Properties (Read/Write)

  • #cluster ⇒ [String]
    'The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.'

    Property Attributes
    • update_container_instances_state_prop'cluster'
    • read_onlyfalse
    • source"update_container_instances_state"
    
    
    17
    18
    19
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instances_state.rb', line 17
    
    property :cluster, update_container_instances_state_prop: 'cluster', type: [String], read_only: false, source: "update_container_instances_state", description: 'The short name or full Amazon Resource Name (ARN) of the cluster that
    hosts the container instance to update. If you do not specify a
    cluster, the default cluster is assumed.'
  • #container_instances ⇒ Array of ⇒ [String]
    'A list of container instance IDs or full ARN entries.'

    Property Attributes
    • update_container_instances_state_prop'container_instances'
    • read_onlyfalse
    • source"update_container_instances_state"
    
    
    20
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instances_state.rb', line 20
    
    property :container_instances, update_container_instances_state_prop: 'container_instances', type: [String], array: true, read_only: false, source: "update_container_instances_state", description: 'A list of container instance IDs or full ARN entries.'
  • #status ⇒ [String]
    'The container instance state with which to update the container instance. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but will be unable to update the container instance state.'

    Property Attributes
    • update_container_instances_state_prop'status'
    • read_onlyfalse
    • source"update_container_instances_state"
    
    
    21
    22
    23
    24
    25
    26
    27
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instances_state.rb', line 21
    
    property :status, update_container_instances_state_prop: 'status', type: [String], read_only: false, source: "update_container_instances_state", description: 'The container instance state with which to update the container
    instance. The only valid values for this action are ACTIVE and
    DRAINING. A container instance can only be updated to DRAINING
    status once it has reached an ACTIVE state. If a container instance
    is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state
    you can describe the container instance but will be unable to update
    the container instance state.'
  • #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
    
    
    31
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instances_state.rb', line 31
    
    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
    • defaultMintPress::InfrastructureAws::AwsPlatform.new
    
    
    34
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/container_instances_state.rb', line 34
    
    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 = {}) ⇒ ContainerInstancesState

Returns a new instance of ContainerInstancesState.

Instance Method Details

#updateObject