Class: MintPress::Aws::EC2::AvailabilityZone

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

Properties (Read/Write)

  • #group_name ⇒ [String]
    'For Availability Zones, this parameter has the same value as the Region name.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::AvailabilityZone"
    • orig_name ⇒ 'group_name'
    

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

property :group_name, disposition: :attribute, description: 'For Availability Zones, this parameter has the same value as the Region name.', source: "MintPress::Aws::EC2::AvailabilityZone", orig_name: 'group_name', type: [String]
  • #messages ⇒ Array of ⇒ [MintPress::Aws::EC2::AvailabilityZoneMessage]
    'Any messages about the Availability Zone, Local Zone, or Wavelength Zone.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::AvailabilityZone"
    • orig_name ⇒ 'messages'
    

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

property :messages, disposition: :attribute, description: 'Any messages about the Availability Zone, Local Zone, or Wavelength Zone.', source: "MintPress::Aws::EC2::AvailabilityZone", orig_name: 'messages', type: [MintPress::Aws::EC2::AvailabilityZoneMessage], array: true
  • #network_border_group ⇒ [String]
    'The name of the network border group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::AvailabilityZone"
    • orig_name ⇒ 'network_border_group'
    

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

property :network_border_group, disposition: :attribute, description: 'The name of the network border group.', source: "MintPress::Aws::EC2::AvailabilityZone", orig_name: 'network_border_group', type: [String]
  • #opt_in_status ⇒ [String]
    'For Availability Zones, this parameter always has the value of opt-in-not-required.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::AvailabilityZone"
    • orig_name ⇒ 'opt_in_status'
    

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

property :opt_in_status, disposition: :attribute, description: 'For Availability Zones, this parameter always has the value of opt-in-not-required.', source: "MintPress::Aws::EC2::AvailabilityZone", orig_name: 'opt_in_status', type: [String]
  • #parent_zone_name ⇒ [String]
    'The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::AvailabilityZone"
    • orig_name ⇒ 'parent_zone_name'
    

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

property :parent_zone_name, disposition: :attribute, description: 'The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.', source: "MintPress::Aws::EC2::AvailabilityZone", orig_name: 'parent_zone_name', type: [String]
  • #region_name ⇒ [String]
    'The name of the Region.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::AvailabilityZone"
    • orig_name ⇒ 'region_name'
    

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

property :region_name, disposition: :attribute, description: 'The name of the Region.', source: "MintPress::Aws::EC2::AvailabilityZone", orig_name: 'region_name', type: [String]
  • #state ⇒ [String]
    'The state of the Availability Zone, Local Zone, or Wavelength Zone.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::AvailabilityZone"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The state of the Availability Zone, Local Zone, or Wavelength Zone.', source: "MintPress::Aws::EC2::AvailabilityZone", orig_name: 'state', type: [String]
  • #zone_name ⇒ [String]
    'The name of the Availability Zone, Local Zone, or Wavelength Zone.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::AvailabilityZone"
    • orig_name ⇒ 'zone_name'
    

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

property :zone_name, disposition: :attribute, description: 'The name of the Availability Zone, Local Zone, or Wavelength Zone.', source: "MintPress::Aws::EC2::AvailabilityZone", orig_name: 'zone_name', type: [String]
  • #zone_type ⇒ [String]
    'The type of zone.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::AvailabilityZone"
    • orig_name ⇒ 'zone_type'
    

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

property :zone_type, disposition: :attribute, description: 'The type of zone.', source: "MintPress::Aws::EC2::AvailabilityZone", orig_name: 'zone_type', type: [String]
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1). message - The Zone message. opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required). parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls. parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls. region-name - The name of the Region for the Zone (for example, us-east-1). state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available | information | impaired | unavailable). zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1). zone-type - The type of zone, for example, local-zone. zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1). zone-type - The type of zone, for example, local-zone.'
    Property Attributes
    • describe_availability_zones_prop ⇒ 'filters'
    • source ⇒ "describe_availability_zones"
    

28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/availability_zone.rb', line 28

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


group-name - For Availability Zones, use the Region name. For
Local Zones, use the name of the group associated with the Local
Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the
name of the group associated with the Wavelength Zone (for example,
us-east-1-wl1-bos-wlz-1).
message - The Zone message.
opt-in-status - The opt-in status (opted-in, and not-opted-in
| opt-in-not-required).
parent-zoneID - The ID of the zone that handles some of the Local
Zone and Wavelength Zone control plane operations, such as API
calls.
parent-zoneName - The ID of the zone that handles some of the
Local Zone and Wavelength Zone control plane operations, such as API
calls.
region-name - The name of the Region for the Zone (for example,
us-east-1).
state - The state of the Availability Zone, the Local Zone, or the
Wavelength Zone (available | information | impaired |
unavailable).
zone-id - The ID of the Availability Zone (for example,
use1-az1), the Local Zone (for example, usw2-lax1-az1), or the
Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
zone-name - The name of the Availability Zone (for example,
us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or
the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.', hash: true
  • #zone_names ⇒ Array of ⇒ [String]
    'The names of the Availability Zones, Local Zones, and Wavelength Zones.'
    Property Attributes
    • describe_availability_zones_prop ⇒ 'zone_names'
    • source ⇒ "describe_availability_zones"
    

58
59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/availability_zone.rb', line 58

property :zone_names, describe_availability_zones_prop: 'zone_names', type: [String], array: true, source: "describe_availability_zones", description: 'The names of the Availability Zones, Local Zones, and Wavelength
Zones.'
  • #all_availability_zones ⇒ [TrueClass,FalseClass]
    'Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status. If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.'
    Property Attributes
    • describe_availability_zones_prop ⇒ 'all_availability_zones'
    • source ⇒ "describe_availability_zones"
    

60
61
62
63
64
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/availability_zone.rb', line 60

property :all_availability_zones, describe_availability_zones_prop: 'all_availability_zones', type: [TrueClass,FalseClass], source: "describe_availability_zones", description: 'Include all Availability Zones, Local Zones, and Wavelength Zones
regardless of your opt-in status.

If you do not use this parameter, the results include only the zones
for the Regions where you have chosen the option to opt in.'
  • #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_availability_zones_prop ⇒ 'dry_run'
    • source ⇒ "describe_availability_zones"
    

65
66
67
68
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/availability_zone.rb', line 65

property :dry_run, describe_availability_zones_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_availability_zones", 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.'
  • #parent_zone ⇒ [String]
    'The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::AvailabilityZone"
    • orig_name ⇒ 'parent_zone_id'
    

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

property :parent_zone, disposition: :attribute, description: 'The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.', source: "MintPress::Aws::EC2::AvailabilityZone", orig_name: 'parent_zone_id', type: [String]
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The IDs of the Availability Zones, Local Zones, and Wavelength Zones.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_availability_zones"
    • orig_name ⇒ 'zone_id'
    • describe_availability_zones_prop ⇒ 'zone_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, disposition: :attribute, description: 'The IDs of the Availability Zones, Local Zones, and Wavelength Zones.', source: "describe_availability_zones", orig_name: 'zone_id', type: [String], array: false, hash: false, describe_availability_zones_prop: 'zone_ids', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of AvailabilityZone.

Instance Method Details

#describe ⇒ Object