Class: Aws::Shield::Types::ListResourcesInProtectionGroupRequest

Inherits:

Struct

• Object
• Struct
• Aws::Shield::Types::ListResourcesInProtectionGroupRequest

Defined in:

gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_results ⇒ Integer

  The greatest number of objects that you want Shield Advanced to return to the list request.

• #next_token ⇒ String

  When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response.

• #protection_group_id ⇒ String

  The name of the protection group.

Instance Attribute Details

#max_results ⇒ Integer

The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.

The default setting is 20.

Returns:

• (Integer)

# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 1481

class ListResourcesInProtectionGroupRequest < Struct.new(
  :protection_group_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

On your first call to a list operation, leave this setting empty.

Returns:

• (String)

# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 1481

class ListResourcesInProtectionGroupRequest < Struct.new(
  :protection_group_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#protection_group_id ⇒ String

The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Returns:

• (String)

# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 1481

class ListResourcesInProtectionGroupRequest < Struct.new(
  :protection_group_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end