Class: MintPress::Aws::Route53::HostedZonesByName

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

Properties (Read/Write)

  • #dns_name ⇒ [String] (Default Value: Proc.new { self.name })
    'For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don"t include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current AWS account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.'
    Property Attributes
    • list_hosted_zones_by_name_prop ⇒ 'dns_name'
    • read_only ⇒ false
    • source ⇒ "list_hosted_zones_by_name"
    • default ⇒ Proc.new { self.name }
    

18
19
20
21
22
23
24
25
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/hosted_zones_by_name.rb', line 18

property :dns_name, list_hosted_zones_by_name_prop: 'dns_name', type: [String], read_only: false, source: "list_hosted_zones_by_name", description: 'For your first request to ListHostedZonesByName, include
the dnsname parameter only if you want to specify the name of the
first hosted zone in the response. If you don"t include the dnsname
parameter, Amazon Route 53 returns all of the hosted zones that were
created by the current AWS account, in ASCII order. For subsequent
requests, include both dnsname and hostedzoneid parameters. For
dnsname, specify the value of NextDNSName from the previous
response.', default: Proc.new { self.name }
  • #max_items ⇒ [Integer]
    'The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.'
    Property Attributes
    • list_hosted_zones_by_name_prop ⇒ 'max_items'
    • read_only ⇒ false
    • source ⇒ "list_hosted_zones_by_name"
    

26
27
28
29
30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/hosted_zones_by_name.rb', line 26

property :max_items, list_hosted_zones_by_name_prop: 'max_items', type: [Integer], read_only: false, source: "list_hosted_zones_by_name", description: 'The maximum number of hosted zones to be included in the response body
for this request. If you have more than maxitems hosted zones, then
the value of the IsTruncated element in the response is true, and
the values of NextDNSName and NextHostedZoneId specify the first
hosted zone in the next group of maxitems hosted zones.'
  • #hosted_zone ⇒ [MintPress::Aws::Route53::HostedZone]
    'For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter. If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of hostedzoneid, specify the value of the NextHostedZoneId element from the previous response.'
    Property Attributes
    • list_hosted_zones_by_name_prop ⇒ 'hosted_zone_id'
    • read_only ⇒ false
    • source ⇒ "list_hosted_zones_by_name"
    • from ⇒ String
    

31
32
33
34
35
36
37
38
39
40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/hosted_zones_by_name.rb', line 31

property :hosted_zone, list_hosted_zones_by_name_prop: 'hosted_zone_id', type: [MintPress::Aws::Route53::HostedZone], read_only: false, source: "list_hosted_zones_by_name", description: 'For your first request to ListHostedZonesByName, do not
include the hostedzoneid parameter.

If you have more hosted zones than the value of maxitems,
ListHostedZonesByName returns only the first maxitems hosted
zones. To get the next group of maxitems hosted zones, submit
another request to ListHostedZonesByName and include both dnsname
and hostedzoneid parameters. For the value of hostedzoneid,
specify the value of the NextHostedZoneId element from the previous
response.', from: String
  • #name ⇒ [String]

    Property Attributes 
    

41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/hosted_zones_by_name.rb', line 41

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 
    

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

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
    

48
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/hosted_zones_by_name.rb', line 48

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

Returns a new instance of HostedZonesByName.

Instance Method Details

#list ⇒ Object