« blib/lib/Paws/CloudFormation/TypeFilters.pm
↑ Summary
blib/lib/Paws/CloudFormation/TypeVersionSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::TypeSummary; | ||
| 3 | use Moose; | ||
| 4 | has DefaultVersionId => (is => 'ro', isa => 'Str'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has IsActivated => (is => 'ro', isa => 'Bool'); | ||
| 7 | has LastUpdated => (is => 'ro', isa => 'Str'); | ||
| 8 | has LatestPublicVersion => (is => 'ro', isa => 'Str'); | ||
| 9 | has OriginalTypeName => (is => 'ro', isa => 'Str'); | ||
| 10 | has PublicVersionNumber => (is => 'ro', isa => 'Str'); | ||
| 11 | has PublisherId => (is => 'ro', isa => 'Str'); | ||
| 12 | has PublisherIdentity => (is => 'ro', isa => 'Str'); | ||
| 13 | has PublisherName => (is => 'ro', isa => 'Str'); | ||
| 14 | has Type => (is => 'ro', isa => 'Str'); | ||
| 15 | has TypeArn => (is => 'ro', isa => 'Str'); | ||
| 16 | has TypeName => (is => 'ro', isa => 'Str'); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::CloudFormation::TypeSummary | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::CloudFormation::TypeSummary object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { DefaultVersionId => $value, ..., TypeName => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::TypeSummary object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->DefaultVersionId | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Contains summary information about the specified CloudFormation | ||
| 49 | extension. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 DefaultVersionId => Str | ||
| 55 | |||
| 56 | The ID of the default version of the extension. The default version is | ||
| 57 | used when the extension version is not specified. | ||
| 58 | |||
| 59 | This applies only to private extensions you have registered in your | ||
| 60 | account. For public extensions, both those provided by Amazon and | ||
| 61 | published by third parties, CloudFormation returns C<null>. For more | ||
| 62 | information, see RegisterType | ||
| 63 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). | ||
| 64 | |||
| 65 | To set the default version of an extension, use C< | ||
| 66 | SetTypeDefaultVersion >. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Description => Str | ||
| 70 | |||
| 71 | The description of the extension. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 IsActivated => Bool | ||
| 75 | |||
| 76 | Whether or not the extension is activated for this account and region. | ||
| 77 | |||
| 78 | This applies only to third-party public extensions. Extensions | ||
| 79 | published by Amazon are activated by default. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 LastUpdated => Str | ||
| 83 | |||
| 84 | When the specified extension version was registered. This applies only | ||
| 85 | to: | ||
| 86 | |||
| 87 | =over | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | Private extensions you have registered in your account. For more | ||
| 92 | information, see RegisterType | ||
| 93 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | Public extensions you have activated in your account with auto-update | ||
| 98 | specified. For more information, see ActivateType | ||
| 99 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html). | ||
| 100 | |||
| 101 | =back | ||
| 102 | |||
| 103 | For all other extension types, CloudFormation returns C<null>. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 LatestPublicVersion => Str | ||
| 107 | |||
| 108 | For public extensions that have been activated for this account and | ||
| 109 | region, the latest version of the public extension I<that is | ||
| 110 | available>. For any extensions other than activated third-arty | ||
| 111 | extensions, CloudFormation returns C<null>. | ||
| 112 | |||
| 113 | How you specified C<AutoUpdate> when enabling the extension affects | ||
| 114 | whether CloudFormation automatically updates the extention in this | ||
| 115 | account and region when a new version is released. For more | ||
| 116 | information, see Setting CloudFormation to automatically use new | ||
| 117 | versions of extensions | ||
| 118 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto) | ||
| 119 | in the I<CloudFormation User Guide>. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 OriginalTypeName => Str | ||
| 123 | |||
| 124 | For public extensions that have been activated for this account and | ||
| 125 | region, the type name of the public extension. | ||
| 126 | |||
| 127 | If you specified a C<TypeNameAlias> when enabling the extension in this | ||
| 128 | account and region, CloudFormation treats that alias as the extension's | ||
| 129 | type name within the account and region, not the type name of the | ||
| 130 | public extension. For more information, see Specifying aliases to refer | ||
| 131 | to extensions | ||
| 132 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias) | ||
| 133 | in the I<CloudFormation User Guide>. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 PublicVersionNumber => Str | ||
| 137 | |||
| 138 | For public extensions that have been activated for this account and | ||
| 139 | region, the version of the public extension to be used for | ||
| 140 | CloudFormation operations in this account and region. | ||
| 141 | |||
| 142 | How you specified C<AutoUpdate> when enabling the extension affects | ||
| 143 | whether CloudFormation automatically updates the extention in this | ||
| 144 | account and region when a new version is released. For more | ||
| 145 | information, see Setting CloudFormation to automatically use new | ||
| 146 | versions of extensions | ||
| 147 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto) | ||
| 148 | in the I<CloudFormation User Guide>. | ||
| 149 | |||
| 150 | |||
| 151 | =head2 PublisherId => Str | ||
| 152 | |||
| 153 | The ID of the extension publisher, if the extension is published by a | ||
| 154 | third party. Extensions published by Amazon do not return a publisher | ||
| 155 | ID. | ||
| 156 | |||
| 157 | |||
| 158 | =head2 PublisherIdentity => Str | ||
| 159 | |||
| 160 | The service used to verify the publisher identity. | ||
| 161 | |||
| 162 | For more information, see Registering your account to publish | ||
| 163 | CloudFormation extensions | ||
| 164 | (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) | ||
| 165 | in the I< CFN-CLI User Guide for Extension Development>. | ||
| 166 | |||
| 167 | |||
| 168 | =head2 PublisherName => Str | ||
| 169 | |||
| 170 | The publisher name, as defined in the public profile for that publisher | ||
| 171 | in the service used to verify the publisher identity. | ||
| 172 | |||
| 173 | |||
| 174 | =head2 Type => Str | ||
| 175 | |||
| 176 | The kind of extension. | ||
| 177 | |||
| 178 | |||
| 179 | =head2 TypeArn => Str | ||
| 180 | |||
| 181 | The Amazon Resource Name (ARN) of the extension. | ||
| 182 | |||
| 183 | |||
| 184 | =head2 TypeName => Str | ||
| 185 | |||
| 186 | The name of the extension. | ||
| 187 | |||
| 188 | If you specified a C<TypeNameAlias> when you activate this extension | ||
| 189 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) | ||
| 190 | in your account and region, CloudFormation considers that alias as the | ||
| 191 | type name. | ||
| 192 | |||
| 193 | |||
| 194 | |||
| 195 | =head1 SEE ALSO | ||
| 196 | |||
| 197 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 198 | |||
| 199 | =head1 BUGS and CONTRIBUTIONS | ||
| 200 | |||
| 201 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 202 | |||
| 203 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 204 | |||
| 205 | =cut | ||
| 206 |