Class: MintPress::Aws::RDS::CustomAvailabilityZone

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

Properties (Read/Write)

  • #custom_availability_zone_name ⇒ [String]
    'The name of the custom AZ.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::CustomAvailabilityZone"
    • orig_name ⇒ 'custom_availability_zone_name'
    • create_custom_availability_zone_prop ⇒ 'custom_availability_zone_name'
    • read_only ⇒ false
    

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

property :custom_availability_zone_name, disposition: :attribute, description: 'The name of the custom AZ.', source: "MintPress::Aws::RDS::CustomAvailabilityZone", orig_name: 'custom_availability_zone_name', type: [String], create_custom_availability_zone_prop: 'custom_availability_zone_name', read_only: false
  • #custom_availability_zone_status ⇒ [String]
    'The status of the custom AZ.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::CustomAvailabilityZone"
    • orig_name ⇒ 'custom_availability_zone_status'
    

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

property :custom_availability_zone_status, disposition: :attribute, description: 'The status of the custom AZ.', source: "MintPress::Aws::RDS::CustomAvailabilityZone", orig_name: 'custom_availability_zone_status', type: [String]
  • #vpn_details ⇒ [MintPress::Aws::RDS::VpnDetail] (Default Value: MintPress::Aws::RDS::VpnDetail.new)
    'Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::CustomAvailabilityZone"
    • orig_name ⇒ 'vpn_details'
    • default ⇒ MintPress::Aws::RDS::VpnDetail.new
    

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

property :vpn_details, disposition: :attribute, description: 'Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.', source: "MintPress::Aws::RDS::CustomAvailabilityZone", orig_name: 'vpn_details', type: [MintPress::Aws::RDS::VpnDetail], default: MintPress::Aws::RDS::VpnDetail.new
  • #new_vpn_tunnel_name ⇒ [String]
    'The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster. Specify this parameter only if ExistingVpnId isn"t specified.'
    Property Attributes
    • create_custom_availability_zone_prop ⇒ 'new_vpn_tunnel_name'
    • read_only ⇒ false
    • source ⇒ "create_custom_availability_zone"
    

26
27
28
29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/custom_availability_zone.rb', line 26

property :new_vpn_tunnel_name, create_custom_availability_zone_prop: 'new_vpn_tunnel_name', type: [String], read_only: false, source: "create_custom_availability_zone", description: 'The name of a new VPN tunnel between the Amazon RDS website and the
VMware vSphere cluster.

Specify this parameter only if ExistingVpnId isn"t specified.'
  • #vpn_tunnel_originator_ip ⇒ [String]
    'The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic. Specify this parameter only if ExistingVpnId isn"t specified.'
    Property Attributes
    • create_custom_availability_zone_prop ⇒ 'vpn_tunnel_originator_ip'
    • read_only ⇒ false
    • source ⇒ "create_custom_availability_zone"
    

30
31
32
33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/custom_availability_zone.rb', line 30

property :vpn_tunnel_originator_ip, create_custom_availability_zone_prop: 'vpn_tunnel_originator_ip', type: [String], read_only: false, source: "create_custom_availability_zone", description: 'The IP address of network traffic from your on-premises data center. A
custom AZ receives the network traffic.

Specify this parameter only if ExistingVpnId isn"t specified.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'A filter that specifies one or more custom AZs to describe.'
    Property Attributes
    • describe_custom_availability_zones_prop ⇒ 'filters'
    • source ⇒ "describe_custom_availability_zones"
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/custom_availability_zone.rb', line 34

property :filters, describe_custom_availability_zones_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_custom_availability_zones", description: 'A filter that specifies one or more custom AZs to describe.', hash: true
  • #max_records ⇒ [Integer]
    'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
    Property Attributes
    • describe_custom_availability_zones_prop ⇒ 'max_records'
    • source ⇒ "describe_custom_availability_zones"
    

35
36
37
38
39
40
41
42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/custom_availability_zone.rb', line 35

property :max_records, describe_custom_availability_zones_prop: 'max_records', type: [Integer], source: "describe_custom_availability_zones", description: 'The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so you can retrieve
the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.'
    Property Attributes
    • source ⇒ "describe_custom_availability_zones"
    • orig_name ⇒ 'custom_availability_zone_id'
    • delete_custom_availability_zone_prop ⇒ 'custom_availability_zone_id'
    • read_only ⇒ false
    • describe_custom_availability_zones_prop ⇒ 'custom_availability_zone_id'
    • default ⇒ Proc.new { self.name }
    

43
44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/custom_availability_zone.rb', line 43

property :id, description: 'The custom AZ identifier. If this parameter is specified, information
from only the specific custom AZ is returned.', source: "describe_custom_availability_zones", orig_name: 'custom_availability_zone_id', type: [String], delete_custom_availability_zone_prop: 'custom_availability_zone_id', read_only: false, describe_custom_availability_zones_prop: 'custom_availability_zone_id', array: false, hash: false, default: Proc.new { self.name }
  • #existing_vpn ⇒ [String]
    'The ID of an existing virtual private network (VPN) between the Amazon RDS website and the VMware vSphere cluster.'
    Property Attributes
    • create_custom_availability_zone_prop ⇒ 'existing_vpn_id'
    • read_only ⇒ false
    • source ⇒ "create_custom_availability_zone"
    

45
46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/custom_availability_zone.rb', line 45

property :existing_vpn, create_custom_availability_zone_prop: 'existing_vpn_id', type: [String], read_only: false, source: "create_custom_availability_zone", description: 'The ID of an existing virtual private network (VPN) between the Amazon
RDS website and the VMware vSphere cluster.'
  • #name ⇒ String

    Property Attributes 
    

47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/custom_availability_zone.rb', line 47

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 
    

51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/custom_availability_zone.rb', line 51

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
    

54
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/custom_availability_zone.rb', line 54

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

Returns a new instance of CustomAvailabilityZone.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object