You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Route53::Types::ListResourceRecordSetsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb

Overview

Note:

When making an API call, you may pass ListResourceRecordSetsRequest data as a hash:

{
  hosted_zone_id: "ResourceId", # required
  start_record_name: "DNSName",
  start_record_type: "SOA", # accepts SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA
  start_record_identifier: "ResourceRecordSetIdentifier",
  max_items: 1,
}

A request for the resource record sets that are associated with a specified hosted zone.

Instance Attribute Summary collapse

Instance Attribute Details

#hosted_zone_idString

The ID of the hosted zone that contains the resource record sets that you want to list.

Returns:

  • (String)


3347
3348
3349
3350
3351
3352
3353
3354
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 3347

class ListResourceRecordSetsRequest < Struct.new(
  :hosted_zone_id,
  :start_record_name,
  :start_record_type,
  :start_record_identifier,
  :max_items)
  include Aws::Structure
end

#max_itemsInteger

(Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets.

Returns:

  • (Integer)


3347
3348
3349
3350
3351
3352
3353
3354
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 3347

class ListResourceRecordSetsRequest < Struct.new(
  :hosted_zone_id,
  :start_record_name,
  :start_record_type,
  :start_record_identifier,
  :max_items)
  include Aws::Structure
end

#start_record_identifierString

Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

Returns:

  • (String)


3347
3348
3349
3350
3351
3352
3353
3354
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 3347

class ListResourceRecordSetsRequest < Struct.new(
  :hosted_zone_id,
  :start_record_name,
  :start_record_type,
  :start_record_identifier,
  :max_items)
  include Aws::Structure
end

#start_record_nameString

The first name in the lexicographic ordering of resource record sets that you want to list.

Returns:

  • (String)


3347
3348
3349
3350
3351
3352
3353
3354
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 3347

class ListResourceRecordSetsRequest < Struct.new(
  :hosted_zone_id,
  :start_record_name,
  :start_record_type,
  :start_record_identifier,
  :max_items)
  include Aws::Structure
end

#start_record_typeString

The type of resource record set to begin the record listing from.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geo, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

Values for alias resource record sets:

  • CloudFront distribution: A or AAAA

  • Elastic Beanstalk environment that has a regionalized subdomain: A

  • ELB load balancer: A | AAAA

  • Amazon S3 bucket: A

  • Another resource record set in this hosted zone: The type of the resource record set that the alias references.

Constraint: Specifying type without specifying name returns an InvalidInput error.

Returns:

  • (String)


3347
3348
3349
3350
3351
3352
3353
3354
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 3347

class ListResourceRecordSetsRequest < Struct.new(
  :hosted_zone_id,
  :start_record_name,
  :start_record_type,
  :start_record_identifier,
  :max_items)
  include Aws::Structure
end