Class: MintPress::Aws::EC2::InstanceCredit

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

Properties (Read/Write)

  • #cpu_credits ⇒ [String]
    'The credit option for CPU usage of the instance.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::InstanceCredit"
    • orig_name ⇒ 'cpu_credits'
    • modify_instance_credit_specification_prop ⇒ 'instance_credits.cpu_credits'
    

20
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_credit.rb', line 20

property :cpu_credits, disposition: :attribute, description: 'The credit option for CPU usage of the instance.', source: "MintPress::Aws::EC2::InstanceCredit", orig_name: 'cpu_credits', type: [String], modify_instance_credit_specification_prop: 'instance_credits.cpu_credits'
  • #dry_run ⇒ [TrueClass,FalseClass]
    'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
    Property Attributes
    • describe_instance_credit_specifications_prop ⇒ 'dry_run'
    • source ⇒ "modify_instance_credit_specification"
    • modify_instance_credit_specification_prop ⇒ 'dry_run'
    • read_only ⇒ false
    

21
22
23
24
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_credit.rb', line 21

property :dry_run, describe_instance_credit_specifications_prop: 'dry_run', type: [TrueClass,FalseClass], source: "modify_instance_credit_specification", description: 'Checks whether you have the required permissions for the action,
without actually making the request, and provides an error response.
If you have the required permissions, the error response is
DryRunOperation. Otherwise, it is UnauthorizedOperation.', modify_instance_credit_specification_prop: 'dry_run', read_only: false
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. instance-id - The ID of the instance. ^'
    Property Attributes
    • describe_instance_credit_specifications_prop ⇒ 'filters'
    • source ⇒ "describe_instance_credit_specifications"
    

25
26
27
28
29
30
31
32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_credit.rb', line 25

property :filters, describe_instance_credit_specifications_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_instance_credit_specifications", description: 'The filters.


instance-id - The ID of the instance.



^', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.'
    Property Attributes
    • describe_instance_credit_specifications_prop ⇒ 'max_results'
    • source ⇒ "describe_instance_credit_specifications"
    

33
34
35
36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_credit.rb', line 33

property :max_results, describe_instance_credit_specifications_prop: 'max_results', type: [Integer], source: "describe_instance_credit_specifications", description: 'The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned NextToken
value. This value can be between 5 and 1000. You cannot specify this
parameter and the instance IDs parameter in the same call.'
  • #client_token ⇒ [String]
    'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
    Property Attributes
    • modify_instance_credit_specification_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "modify_instance_credit_specification"
    

37
38
39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_credit.rb', line 37

property :client_token, modify_instance_credit_specification_prop: 'client_token', type: [String], read_only: false, source: "modify_instance_credit_specification", description: 'A unique, case-sensitive token that you provide to ensure idempotency
of your modification request. For more information, see Ensuring
Idempotency.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The instance IDs. Default: Describes all your instances. Constraints: Maximum 1000 explicitly specified instance IDs.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_instance_credit_specifications"
    • orig_name ⇒ 'instance_id'
    • modify_instance_credit_specification_prop ⇒ 'instance_credits.instance_id'
    • describe_instance_credit_specifications_prop ⇒ 'instance_ids'
    • default ⇒ Proc.new { self.name }
    

40
41
42
43
44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_credit.rb', line 40

property :id, disposition: :attribute, description: 'The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 1000 explicitly specified instance IDs.', source: "describe_instance_credit_specifications", orig_name: 'instance_id', type: [String], modify_instance_credit_specification_prop: 'instance_credits.instance_id', array: false, hash: false, describe_instance_credit_specifications_prop: 'instance_ids', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_credit.rb', line 49

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
    

52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance_credit.rb', line 52

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

Returns a new instance of InstanceCredit.

Instance Method Details

#describe ⇒ Object

#modify ⇒ Object