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

NAME

Paws::CloudFormation::TypeSummary

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::CloudFormation::TypeSummary object:

$service_obj->Method(Att1 => { DefaultVersionId => $value, ..., TypeName => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::TypeSummary object:

$result = $service_obj->Method(...);
$result->Att1->DefaultVersionId

DESCRIPTION

Contains summary information about the specified CloudFormation extension.

ATTRIBUTES

DefaultVersionId => Str

The ID of the default version of the extension. The default version is used when the extension version is not specified.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).

To set the default version of an extension, use SetTypeDefaultVersion .

Description => Str

The description of the extension.

IsActivated => Bool

Whether or not the extension is activated for this account and region.

This applies only to third-party public extensions. Extensions published by Amazon are activated by default.

LastUpdated => Str

When the specified extension version was registered. This applies only to:

  • Private extensions you have registered in your account. For more information, see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).

  • Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html).

For all other extension types, CloudFormation returns null.

LatestPublicVersion => Str

For public extensions that have been activated for this account and region, the latest version of the public extension that is available. For any extensions other than activated third-arty extensions, CloudFormation returns null.

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extention in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto) in the CloudFormation User Guide.

OriginalTypeName => Str

For public extensions that have been activated for this account and region, the type name of the public extension.

If you specified a TypeNameAlias when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias) in the CloudFormation User Guide.

PublicVersionNumber => Str

For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and region.

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extention in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto) in the CloudFormation User Guide.

PublisherId => Str

The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon do not return a publisher ID.

PublisherIdentity => Str

The service used to verify the publisher identity.

For more information, see Registering your account to publish CloudFormation extensions (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) in the CFN-CLI User Guide for Extension Development.

PublisherName => Str

The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.

Type => Str

The kind of extension.

TypeArn => Str

The Amazon Resource Name (ARN) of the extension.

TypeName => Str

The name of the extension.

If you specified a TypeNameAlias when you activate this extension (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) in your account and region, CloudFormation considers that alias as the type name.

SEE ALSO

This class forms part of Paws, describing an object used 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