Class: Aws::CloudFormation::Types::ListTypesInput

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

Overview

Note:

When making an API call, you may pass ListTypesInput data as a hash:

{
  visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
  provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
  deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
  type: "RESOURCE", # accepts RESOURCE, MODULE
  filters: {
    category: "REGISTERED", # accepts REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES
    publisher_id: "PublisherId",
    type_name_prefix: "TypeNamePrefix",
  },
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deprecated_statusString

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:

  • (String)

5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
# File 'lib/aws-sdk-cloudformation/types.rb', line 5264

class ListTypesInput < Struct.new(
  :visibility,
  :provisioning_type,
  :deprecated_status,
  :type,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filtersTypes::TypeFilters

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:


5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
# File 'lib/aws-sdk-cloudformation/types.rb', line 5264

class ListTypesInput < Struct.new(
  :visibility,
  :provisioning_type,
  :deprecated_status,
  :type,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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:

  • (Integer)

5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
# File 'lib/aws-sdk-cloudformation/types.rb', line 5264

class ListTypesInput < Struct.new(
  :visibility,
  :provisioning_type,
  :deprecated_status,
  :type,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  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)

5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
# File 'lib/aws-sdk-cloudformation/types.rb', line 5264

class ListTypesInput < Struct.new(
  :visibility,
  :provisioning_type,
  :deprecated_status,
  :type,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#provisioning_typeString

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 does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

  • `NON_PROVISIONABLE`: The resource type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

The default is `FULLY_MUTABLE`.

Returns:

  • (String)

5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
# File 'lib/aws-sdk-cloudformation/types.rb', line 5264

class ListTypesInput < Struct.new(
  :visibility,
  :provisioning_type,
  :deprecated_status,
  :type,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of extension.

Returns:

  • (String)

5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
# File 'lib/aws-sdk-cloudformation/types.rb', line 5264

class ListTypesInput < Struct.new(
  :visibility,
  :provisioning_type,
  :deprecated_status,
  :type,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#visibilityString

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 account. This includes extensions from Amazon, as well as third-party publishers.

The default is `PRIVATE`.

Returns:

  • (String)

5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
# File 'lib/aws-sdk-cloudformation/types.rb', line 5264

class ListTypesInput < Struct.new(
  :visibility,
  :provisioning_type,
  :deprecated_status,
  :type,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end