Package software.amazon.awssdk.services.cloudformation.model

Class ListTypesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest
software.amazon.awssdk.services.cloudformation.model.ListTypesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListTypesRequest.Builder,ListTypesRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListTypesRequest extends CloudFormationRequest implements ToCopyableBuilder<ListTypesRequest.Builder,ListTypesRequest>

  • Method Details

    • visibility

      public final Visibility visibility()

      The scope at which the extensions are visible and usable in CloudFormation operations.

      Valid values include:

      • PRIVATE: Extensions that are visible and usable within this account and Region. This includes:

        • Private extensions you have registered in this account and Region.

        • Public extensions that you have activated in this account and Region.

      • PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services and third-party publishers.

      The default is PRIVATE.

      If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

      Returns:
      The scope at which the extensions are visible and usable in CloudFormation operations.

      Valid values include:

      • PRIVATE: Extensions that are visible and usable within this account and Region. This includes:

        • Private extensions you have registered in this account and Region.

        • Public extensions that you have activated in this account and Region.

      • PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services and third-party publishers.

      The default is PRIVATE.

      See Also:

    • visibilityAsString

      public final String visibilityAsString()

      The scope at which the extensions are visible and usable in CloudFormation operations.

      Valid values include:

      • PRIVATE: Extensions that are visible and usable within this account and Region. This includes:

        • Private extensions you have registered in this account and Region.

        • Public extensions that you have activated in this account and Region.

      • PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services and third-party publishers.

      The default is PRIVATE.

      If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

      Returns:
      The scope at which the extensions are visible and usable in CloudFormation operations.

      Valid values include:

      • PRIVATE: Extensions that are visible and usable within this account and Region. This includes:

        • Private extensions you have registered in this account and Region.

        • Public extensions that you have activated in this account and Region.

      • PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services and third-party publishers.

      The default is PRIVATE.

      See Also:

    • provisioningType

      public final ProvisioningType provisioningType()

      For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

      Valid values include:

      • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

      • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

      • NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.

      The default is FULLY_MUTABLE.

      If the service returns an enum value that is not available in the current SDK version, provisioningType will return ProvisioningType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from provisioningTypeAsString().

      Returns:
      For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

      Valid values include:

      • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

      • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

      • NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.

      The default is FULLY_MUTABLE.

      See Also:

    • provisioningTypeAsString

      public final String provisioningTypeAsString()

      For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

      Valid values include:

      • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

      • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

      • NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.

      The default is FULLY_MUTABLE.

      If the service returns an enum value that is not available in the current SDK version, provisioningType will return ProvisioningType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from provisioningTypeAsString().

      Returns:
      For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

      Valid values include:

      • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

      • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

      • NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.

      The default is FULLY_MUTABLE.

      See Also:

    • deprecatedStatus

      public final DeprecatedStatus deprecatedStatus()

      The deprecation status of the extension that you want to get summary information about.

      Valid values include:

      • LIVE: The extension is registered for use in CloudFormation operations.

      • DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

      If the service returns an enum value that is not available in the current SDK version, deprecatedStatus will return DeprecatedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deprecatedStatusAsString().

      Returns:
      The deprecation status of the extension that you want to get summary information about.

      Valid values include:

      • LIVE: The extension is registered for use in CloudFormation operations.

      • DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

      See Also:

    • deprecatedStatusAsString

      public final String deprecatedStatusAsString()

      The deprecation status of the extension that you want to get summary information about.

      Valid values include:

      • LIVE: The extension is registered for use in CloudFormation operations.

      • DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

      If the service returns an enum value that is not available in the current SDK version, deprecatedStatus will return DeprecatedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deprecatedStatusAsString().

      Returns:
      The deprecation status of the extension that you want to get summary information about.

      Valid values include:

      • LIVE: The extension is registered for use in CloudFormation operations.

      • DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

      See Also:

    • type

      public final RegistryType type()

      The type of extension.

      If the service returns an enum value that is not available in the current SDK version, type will return RegistryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of extension.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of extension.

      If the service returns an enum value that is not available in the current SDK version, type will return RegistryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of extension.
      See Also:

    • filters

      public final TypeFilters filters()

      Filter criteria to use in determining which extensions to return.

      Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.

      Returns:
      Filter criteria to use in determining which extensions to return.

      Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

      Returns:
      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    • nextToken

      public final String nextToken()

      The token for the next set of items to return. (You received this token from a previous call.)

      Returns:
      The token for the next set of items to return. (You received this token from a previous call.)

    • toBuilder

      public ListTypesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListTypesRequest.Builder,ListTypesRequest>
      Specified by:
      toBuilder in class CloudFormationRequest

    • builder

      public static ListTypesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListTypesRequest.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