Class: Aws::Route53::Types::ListTrafficPolicyInstancesByPolicyRequest

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

Overview

Note:

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

{
  traffic_policy_id: "TrafficPolicyId", # required
  traffic_policy_version: 1, # required
  hosted_zone_id_marker: "ResourceId",
  traffic_policy_instance_name_marker: "DNSName",
  traffic_policy_instance_type_marker: "SOA", # accepts SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA, DS
  max_items: 1,
}

A complex type that contains the information about the request to list your traffic policy instances.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#hosted_zone_id_markerString

If the value of `IsTruncated` in the previous response was `true`, you have more traffic policy instances. To get more traffic policy instances, submit another `ListTrafficPolicyInstancesByPolicy` request.

For the value of `hostedzoneid`, specify the value of `HostedZoneIdMarker` from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

If the value of `IsTruncated` in the previous response was `false`, there are no more traffic policy instances to get.

Returns:

  • (String)

5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'lib/aws-sdk-route53/types.rb', line 5757

class ListTrafficPolicyInstancesByPolicyRequest < Struct.new(
  :traffic_policy_id,
  :traffic_policy_version,
  :hosted_zone_id_marker,
  :traffic_policy_instance_name_marker,
  :traffic_policy_instance_type_marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#max_itemsInteger

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than `MaxItems` traffic policy instances, the value of the `IsTruncated` element in the response is `true`, and the values of `HostedZoneIdMarker`, `TrafficPolicyInstanceNameMarker`, and `TrafficPolicyInstanceTypeMarker` represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

Returns:

  • (Integer)

5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'lib/aws-sdk-route53/types.rb', line 5757

class ListTrafficPolicyInstancesByPolicyRequest < Struct.new(
  :traffic_policy_id,
  :traffic_policy_version,
  :hosted_zone_id_marker,
  :traffic_policy_instance_name_marker,
  :traffic_policy_instance_type_marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_policy_idString

The ID of the traffic policy for which you want to list traffic policy instances.

Returns:

  • (String)

5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'lib/aws-sdk-route53/types.rb', line 5757

class ListTrafficPolicyInstancesByPolicyRequest < Struct.new(
  :traffic_policy_id,
  :traffic_policy_version,
  :hosted_zone_id_marker,
  :traffic_policy_instance_name_marker,
  :traffic_policy_instance_type_marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_policy_instance_name_markerString

If the value of `IsTruncated` in the previous response was `true`, you have more traffic policy instances. To get more traffic policy instances, submit another `ListTrafficPolicyInstancesByPolicy` request.

For the value of `trafficpolicyinstancename`, specify the value of `TrafficPolicyInstanceNameMarker` from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

If the value of `IsTruncated` in the previous response was `false`, there are no more traffic policy instances to get.

Returns:

  • (String)

5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'lib/aws-sdk-route53/types.rb', line 5757

class ListTrafficPolicyInstancesByPolicyRequest < Struct.new(
  :traffic_policy_id,
  :traffic_policy_version,
  :hosted_zone_id_marker,
  :traffic_policy_instance_name_marker,
  :traffic_policy_instance_type_marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_policy_instance_type_markerString

If the value of `IsTruncated` in the previous response was `true`, you have more traffic policy instances. To get more traffic policy instances, submit another `ListTrafficPolicyInstancesByPolicy` request.

For the value of `trafficpolicyinstancetype`, specify the value of `TrafficPolicyInstanceTypeMarker` from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

If the value of `IsTruncated` in the previous response was `false`, there are no more traffic policy instances to get.

Returns:

  • (String)

5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'lib/aws-sdk-route53/types.rb', line 5757

class ListTrafficPolicyInstancesByPolicyRequest < Struct.new(
  :traffic_policy_id,
  :traffic_policy_version,
  :hosted_zone_id_marker,
  :traffic_policy_instance_name_marker,
  :traffic_policy_instance_type_marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_policy_versionInteger

The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by `TrafficPolicyId`.

Returns:

  • (Integer)

5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
# File 'lib/aws-sdk-route53/types.rb', line 5757

class ListTrafficPolicyInstancesByPolicyRequest < Struct.new(
  :traffic_policy_id,
  :traffic_policy_version,
  :hosted_zone_id_marker,
  :traffic_policy_instance_name_marker,
  :traffic_policy_instance_type_marker,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end