Class ListResourcesRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListResourcesRequest.Builder,ListResourcesRequest>

@Generated("software.amazon.awssdk:codegen") public final class ListResourcesRequest extends CloudControlRequest implements ToCopyableBuilder<ListResourcesRequest.Builder,ListResourcesRequest>
  • Method Details

    • typeName

      public final String typeName()

      The name of the resource type.

      Returns:
      The name of the resource type.
    • typeVersionId

      public final String typeVersionId()

      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:
      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.
    • roleArn

      public final String roleArn()

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

    • nextToken

      public final String nextToken()

      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:
      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.
    • maxResults

      public final Integer maxResults()

      Reserved.

      Returns:
      Reserved.
    • resourceModel

      public final String resourceModel()

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

      Returns:
      The resource model to use to select the resources to return.
    • toBuilder

      public ListResourcesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListResourcesRequest.Builder,ListResourcesRequest>
      Specified by:
      toBuilder in class CloudControlRequest
    • builder

      public static ListResourcesRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ListResourcesRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo