/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CloudFormation::ListTypes

NAME

Paws::CloudFormation::ListTypes - Arguments for method ListTypes on Paws::CloudFormation

DESCRIPTION

This class represents the parameters used for calling the method ListTypes on the AWS CloudFormation service. Use the attributes of this class as arguments to method ListTypes.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTypes.

SYNOPSIS

my $cloudformation = Paws->service('CloudFormation');
my $ListTypesOutput = $cloudformation->ListTypes(
  DeprecatedStatus => 'LIVE',    # OPTIONAL
  Filters          => {
    Category => 'REGISTERED'
    ,    # values: REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES; OPTIONAL
    PublisherId    => 'MyPublisherId',       # min: 1, max: 40; OPTIONAL
    TypeNamePrefix => 'MyTypeNamePrefix',    # min: 1, max: 204; OPTIONAL
  },    # OPTIONAL
  MaxResults       => 1,                      # OPTIONAL
  NextToken        => 'MyNextToken',          # OPTIONAL
  ProvisioningType => 'NON_PROVISIONABLE',    # OPTIONAL
  Type             => 'RESOURCE',             # OPTIONAL
  Visibility       => 'PUBLIC',               # OPTIONAL
);

# Results:
my $NextToken     = $ListTypesOutput->NextToken;
my $TypeSummaries = $ListTypesOutput->TypeSummaries;

# Returns a L<Paws::CloudFormation::ListTypesOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cloudformation/ListTypes

ATTRIBUTES

DeprecatedStatus => Str

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.

Valid values are: "LIVE", "DEPRECATED"

Filters => Paws::CloudFormation::TypeFilters

Filter criteria to use in determining which extensions to return.

If you specify a filter, CloudFormation ignores any specified Visibility value when returning the list of types.

MaxResults => Int

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 => Str

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.

ProvisioningType => Str

For resource types, the provisioning behavior of the resource type. AWS 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.

Valid values are: "NON_PROVISIONABLE", "IMMUTABLE", "FULLY_MUTABLE"

Type => Str

The type of extension.

Valid values are: "RESOURCE", "MODULE"

Visibility => Str

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.

Valid values are: "PUBLIC", "PRIVATE"

SEE ALSO

This class forms part of Paws, documenting arguments for method ListTypes in Paws::CloudFormation

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues