Class: MintPress::Aws::EC2::Region

Inherits:

Object

• Object
• MintPress::Aws::EC2::Region

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/region.rb

Properties (Read/Write)

• #endpoint ⇒ [String]
  'The Region service endpoint.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::EC2::Region"
  • orig_name ⇒ 'endpoint'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/region.rb', line 18
  
  property :endpoint, disposition: :attribute, description: 'The Region service endpoint.', source: "MintPress::Aws::EC2::Region", orig_name: 'endpoint', type: [String]

• #opt_in_status ⇒ [String]
  'The Region opt-in status.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::EC2::Region"
  • orig_name ⇒ 'opt_in_status'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/region.rb', line 19
  
  property :opt_in_status, disposition: :attribute, description: 'The Region opt-in status.', source: "MintPress::Aws::EC2::Region", orig_name: 'opt_in_status', type: [String]

• #region_name ⇒ [String] (Default Value: Proc.new { self.name })
  'The name of the Region.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::EC2::Region"
  • orig_name ⇒ 'region_name'
  • default ⇒ Proc.new { self.name }

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/region.rb', line 20
  
  property :region_name, disposition: :attribute, description: 'The name of the Region.', source: "MintPress::Aws::EC2::Region", orig_name: 'region_name', type: [String], default: Proc.new { self.name }

• #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
  'The filters. endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com). opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in). region-name - The name of the Region (for example, us-east-1).'
  Property Attributes
  • describe_regions_prop ⇒ 'filters'
  • source ⇒ "describe_regions"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/region.rb', line 21
  
  property :filters, describe_regions_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_regions", description: 'The filters.
  
  
  endpoint - The endpoint of the Region (for example,
  ec2.us-east-1.amazonaws.com).
  opt-in-status - The opt-in status of the Region
  (opt-in-not-required | opted-in | not-opted-in).
  region-name - The name of the Region (for example, us-east-1).', hash: true

• #region_names ⇒ Array of ⇒ [String]
  'The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.'
  Property Attributes
  • describe_regions_prop ⇒ 'region_names'
  • source ⇒ "describe_regions"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/region.rb', line 29
  
  property :region_names, describe_regions_prop: 'region_names', type: [String], array: true, source: "describe_regions", description: 'The names of the Regions. You can specify any Regions, whether they
  are enabled and disabled for your account.'

• #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_regions_prop ⇒ 'dry_run'
  • source ⇒ "describe_regions"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/region.rb', line 31
  
  property :dry_run, describe_regions_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_regions", 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.'

• #all_regions ⇒ [TrueClass,FalseClass]
  'Indicates whether to display all Regions, including Regions that are disabled for your account.'
  Property Attributes
  • describe_regions_prop ⇒ 'all_regions'
  • source ⇒ "describe_regions"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/region.rb', line 35
  
  property :all_regions, describe_regions_prop: 'all_regions', type: [TrueClass,FalseClass], source: "describe_regions", description: 'Indicates whether to display all Regions, including Regions that are
  disabled for your account.'

• #name ⇒ [String]
  
  Property Attributes

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/region.rb', line 37
  
  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

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/region.rb', line 41
  
  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

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/region.rb', line 44
  
  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

• #describe ⇒ Object
• #initialize(opts = {}) ⇒ Region constructor
  A new instance of Region.

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

Returns a new instance of Region.

Instance Method Details

#describe ⇒ Object