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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:resource_model]

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

Reserved.

Returns:

  • (Integer) 


698
699
700
701
702
703
704
705
706
707
 
# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 698

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_token ⇒ String

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) 


698
699
700
701
702
703
704
705
706
707
 
# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 698

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_model ⇒ String

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

Returns:

  • (String) 


698
699
700
701
702
703
704
705
706
707
 
# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 698

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_arn ⇒ String

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*.

[1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html [2]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions

Returns:

  • (String) 


698
699
700
701
702
703
704
705
706
707
 
# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 698

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_name ⇒ String

The name of the resource type.

Returns:

  • (String) 


698
699
700
701
702
703
704
705
706
707
 
# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 698

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_id ⇒ String

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) 


698
699
700
701
702
703
704
705
706
707
 
# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 698

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