Class: MintPress::Aws::Lightsail::Region

Inherits:

Object

• Object
• MintPress::Aws::Lightsail::Region

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

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

Properties (Read/Write)

• #availability_zones ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::AvailabilityZone]
  'The Availability Zones.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Lightsail::Region"
  • orig_name ⇒ 'availability_zones'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/region.rb', line 19
  
  property :availability_zones, disposition: :attribute, description: 'The Availability Zones.', source: "MintPress::Aws::Lightsail::Region", orig_name: 'availability_zones', type: [MintPress::Aws::Lightsail::AvailabilityZone], array: false, hash: true

• #continent_code ⇒ [String]
  'The continent code (e.g., NA, meaning North America).'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Lightsail::Region"
  • orig_name ⇒ 'continent_code'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/region.rb', line 20
  
  property :continent_code, disposition: :attribute, description: 'The continent code (e.g., NA, meaning North America).', source: "MintPress::Aws::Lightsail::Region", orig_name: 'continent_code', type: [String]

• #description ⇒ [String]
  'The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Lightsail::Region"
  • orig_name ⇒ 'description'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/region.rb', line 21
  
  property :description, disposition: :attribute, description: 'The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).', source: "MintPress::Aws::Lightsail::Region", orig_name: 'description', type: [String]

• #display_name ⇒ [String]
  'The display name (e.g., Ohio).'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Lightsail::Region"
  • orig_name ⇒ 'display_name'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/region.rb', line 22
  
  property :display_name, disposition: :attribute, description: 'The display name (e.g., Ohio).', source: "MintPress::Aws::Lightsail::Region", orig_name: 'display_name', type: [String]

• #name ⇒ [String]
  'The region name (e.g., us-east-2).'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Lightsail::Region"
  • orig_name ⇒ 'name'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/region.rb', line 23
  
  property :name, disposition: :attribute, description: 'The region name (e.g., us-east-2).', source: "MintPress::Aws::Lightsail::Region", orig_name: 'name', type: [String]

• #relational_database_availability_zones ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::AvailabilityZone]
  'The Availability Zones for databases.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Lightsail::Region"
  • orig_name ⇒ 'relational_database_availability_zones'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/region.rb', line 24
  
  property :relational_database_availability_zones, disposition: :attribute, description: 'The Availability Zones for databases.', source: "MintPress::Aws::Lightsail::Region", orig_name: 'relational_database_availability_zones', type: [MintPress::Aws::Lightsail::AvailabilityZone], array: false, hash: true

• #include_availability_zones ⇒ [TrueClass,FalseClass]
  'A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., us-east-2a.'
  Property Attributes
  • get_regions_prop ⇒ 'include_availability_zones'
  • read_only ⇒ false
  • source ⇒ "get_regions"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/region.rb', line 25
  
  property :include_availability_zones, get_regions_prop: 'include_availability_zones', type: [TrueClass,FalseClass], read_only: false, source: "get_regions", description: 'A Boolean value indicating whether to also include Availability Zones
  in your get regions request. Availability Zones are indicated with a
  letter: e.g., us-east-2a.'

• #include_relational_database_availability_zones ⇒ [TrueClass,FalseClass]
  'A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (e.g., us-east-2a).'
  Property Attributes
  • get_regions_prop ⇒ 'include_relational_database_availability_zones'
  • read_only ⇒ false
  • source ⇒ "get_regions"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/region.rb', line 28
  
  property :include_relational_database_availability_zones, get_regions_prop: 'include_relational_database_availability_zones', type: [TrueClass,FalseClass], read_only: false, source: "get_regions", description: 'A Boolean value indicating whether to also include Availability Zones
  for databases in your get regions request. Availability Zones are
  indicated with a letter (e.g., us-east-2a).'

• #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/lightsail/region.rb', line 34
  
  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/lightsail/region.rb', line 37
  
  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

• #get ⇒ 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

#get ⇒ Object