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

Interface ListTypesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudFormationRequest.Builder, CopyableBuilder<ListTypesRequest.Builder,ListTypesRequest>, SdkBuilder<ListTypesRequest.Builder,ListTypesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListTypesRequest
public static interface ListTypesRequest.Builder extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<ListTypesRequest.Builder,ListTypesRequest>

  • Method Details

    • visibility

      ListTypesRequest.Builder visibility(String 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, in addition to third-party publishers.

      The default is PRIVATE.

      Parameters:
      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, in addition to third-party publishers.

      The default is PRIVATE.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • visibility

      ListTypesRequest.Builder visibility(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, in addition to third-party publishers.

      The default is PRIVATE.

      Parameters:
      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, in addition to third-party publishers.

      The default is PRIVATE.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • provisioningType

      ListTypesRequest.Builder provisioningType(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • provisioningType

      ListTypesRequest.Builder provisioningType(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deprecatedStatus

      ListTypesRequest.Builder deprecatedStatus(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deprecatedStatus

      ListTypesRequest.Builder deprecatedStatus(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      ListTypesRequest.Builder type(String type)

      The type of extension.

      Parameters:
      type - The type of extension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      ListTypesRequest.Builder type(RegistryType type)

      The type of extension.

      Parameters:
      type - The type of extension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • filters

      ListTypesRequest.Builder filters(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      default ListTypesRequest.Builder filters(Consumer<TypeFilters.Builder> 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.

      This is a convenience method that creates an instance of the TypeFilters.Builder avoiding the need to create one manually via TypeFilters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(TypeFilters).

      Parameters:
      filters - a consumer that will call methods on TypeFilters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      ListTypesRequest.Builder maxResults(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListTypesRequest.Builder nextToken(String nextToken)

      If the previous paginated request didn't return all 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.

      Parameters:
      nextToken - If the previous paginated request didn't return all 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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListTypesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListTypesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.