Class: Aws::CloudControlApi::Types::ListResourcesInput

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

Overview

Constant Summary collapse

SENSITIVE =
[:resource_model]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

Reserved.

Returns:

  • (Integer)


613
614
615
616
617
618
619
620
621
622
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 613

class ListResourcesInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :next_token,
  :max_results,
  :resource_model)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#next_tokenString

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (String)


613
614
615
616
617
618
619
620
621
622
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 613

class ListResourcesInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :next_token,
  :max_results,
  :resource_model)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#resource_modelString

The resource model to use to select the resources to return.

Returns:

  • (String)


613
614
615
616
617
618
619
620
621
622
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 613

class ListResourcesInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :next_token,
  :max_results,
  :resource_model)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

Returns:

  • (String)


613
614
615
616
617
618
619
620
621
622
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 613

class ListResourcesInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :next_token,
  :max_results,
  :resource_model)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#type_nameString

The name of the resource type.

Returns:

  • (String)


613
614
615
616
617
618
619
620
621
622
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 613

class ListResourcesInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :next_token,
  :max_results,
  :resource_model)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#type_version_idString

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

Returns:

  • (String)


613
614
615
616
617
618
619
620
621
622
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 613

class ListResourcesInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :next_token,
  :max_results,
  :resource_model)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end