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

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::ListTypesInput

Includes:

Structure

Defined in:

lib/aws-sdk-cloudformation/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #deprecated_status ⇒ String

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

• #filters ⇒ Types::TypeFilters

  Filter criteria to use in determining which extensions to return.

• #max_results ⇒ Integer

  The maximum number of results to be returned with a single call.

• #next_token ⇒ String

  If the previous paginated request didn't return all the remaining results, the response object's `NextToken` parameter value is set to a token.

• #provisioning_type ⇒ String

  For resource types, the provisioning behavior of the resource type.

• #type ⇒ String

  The type of extension.

• #visibility ⇒ String

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

Instance Attribute Details

#deprecated_status ⇒ String

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)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4835

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

#filters ⇒ Types::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:

• (Types::TypeFilters)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4835

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

#max_results ⇒ Integer

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)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4835

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

#next_token ⇒ String

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:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4835

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

#provisioning_type ⇒ String

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:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4835

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

#type ⇒ String

The type of extension.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4835

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

#visibility ⇒ String

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:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4835

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