« blib/lib/Paws/CloudFormation/AccountLimit.pm
↑ Summary
blib/lib/Paws/CloudFormation/ActivateTypeOutput.pm »
| 1 | |||
| 2 | package Paws::CloudFormation::ActivateType; | ||
| 3 | use Moose; | ||
| 4 | has AutoUpdate => (is => 'ro', isa => 'Bool'); | ||
| 5 | has ExecutionRoleArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has LoggingConfig => (is => 'ro', isa => 'Paws::CloudFormation::LoggingConfig'); | ||
| 7 | has MajorVersion => (is => 'ro', isa => 'Int'); | ||
| 8 | has PublicTypeArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has PublisherId => (is => 'ro', isa => 'Str'); | ||
| 10 | has Type => (is => 'ro', isa => 'Str'); | ||
| 11 | has TypeName => (is => 'ro', isa => 'Str'); | ||
| 12 | has TypeNameAlias => (is => 'ro', isa => 'Str'); | ||
| 13 | has VersionBump => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ActivateType'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::ActivateTypeOutput'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ActivateTypeResult'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::CloudFormation::ActivateType - Arguments for method ActivateType on L<Paws::CloudFormation> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method ActivateType on the | ||
| 31 | L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class | ||
| 32 | as arguments to method ActivateType. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ActivateType. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $cloudformation = Paws->service('CloudFormation'); | ||
| 39 | my $ActivateTypeOutput = $cloudformation->ActivateType( | ||
| 40 | AutoUpdate => 1, # OPTIONAL | ||
| 41 | ExecutionRoleArn => 'MyRoleArn', # OPTIONAL | ||
| 42 | LoggingConfig => { | ||
| 43 | LogGroupName => 'MyLogGroupName', # min: 1, max: 512 | ||
| 44 | LogRoleArn => 'MyRoleArn', # min: 1, max: 256 | ||
| 45 | |||
| 46 | }, # OPTIONAL | ||
| 47 | MajorVersion => 1, # OPTIONAL | ||
| 48 | PublicTypeArn => 'MyThirdPartyTypeArn', # OPTIONAL | ||
| 49 | PublisherId => 'MyPublisherId', # OPTIONAL | ||
| 50 | Type => 'RESOURCE', # OPTIONAL | ||
| 51 | TypeName => 'MyTypeName', # OPTIONAL | ||
| 52 | TypeNameAlias => 'MyTypeName', # OPTIONAL | ||
| 53 | VersionBump => 'MAJOR', # OPTIONAL | ||
| 54 | ); | ||
| 55 | |||
| 56 | # Results: | ||
| 57 | my $Arn = $ActivateTypeOutput->Arn; | ||
| 58 | |||
| 59 | # Returns a L<Paws::CloudFormation::ActivateTypeOutput> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/ActivateType> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 AutoUpdate => Bool | ||
| 68 | |||
| 69 | Whether to automatically update the extension in this account and | ||
| 70 | region when a new I<minor> version is published by the extension | ||
| 71 | publisher. Major versions released by the publisher must be manually | ||
| 72 | updated. | ||
| 73 | |||
| 74 | The default is C<true>. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 ExecutionRoleArn => Str | ||
| 79 | |||
| 80 | The name of the IAM execution role to use to activate the extension. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 LoggingConfig => L<Paws::CloudFormation::LoggingConfig> | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 MajorVersion => Int | ||
| 91 | |||
| 92 | The major version of this extension you want to activate, if multiple | ||
| 93 | major versions are available. The default is the latest major version. | ||
| 94 | CloudFormation uses the latest available I<minor> version of the major | ||
| 95 | version selected. | ||
| 96 | |||
| 97 | You can specify C<MajorVersion> or C<VersionBump>, but not both. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 PublicTypeArn => Str | ||
| 102 | |||
| 103 | The Amazon Resource Number (ARN) of the public extension. | ||
| 104 | |||
| 105 | Conditional: You must specify C<PublicTypeArn>, or C<TypeName>, | ||
| 106 | C<Type>, and C<PublisherId>. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 PublisherId => Str | ||
| 111 | |||
| 112 | The ID of the extension publisher. | ||
| 113 | |||
| 114 | Conditional: You must specify C<PublicTypeArn>, or C<TypeName>, | ||
| 115 | C<Type>, and C<PublisherId>. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 Type => Str | ||
| 120 | |||
| 121 | The extension type. | ||
| 122 | |||
| 123 | Conditional: You must specify C<PublicTypeArn>, or C<TypeName>, | ||
| 124 | C<Type>, and C<PublisherId>. | ||
| 125 | |||
| 126 | Valid values are: C<"RESOURCE">, C<"MODULE"> | ||
| 127 | |||
| 128 | =head2 TypeName => Str | ||
| 129 | |||
| 130 | The name of the extension. | ||
| 131 | |||
| 132 | Conditional: You must specify C<PublicTypeArn>, or C<TypeName>, | ||
| 133 | C<Type>, and C<PublisherId>. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 TypeNameAlias => Str | ||
| 138 | |||
| 139 | An alias to assign to the public extension, in this account and region. | ||
| 140 | If you specify an alias for the extension, CloudFormation treats the | ||
| 141 | alias as the extension type name within this account and region. You | ||
| 142 | must use the alias to refer to the extension in your templates, API | ||
| 143 | calls, and CloudFormation console. | ||
| 144 | |||
| 145 | An extension alias must be unique within a given account and region. | ||
| 146 | You can activate the same public resource multiple times in the same | ||
| 147 | account and region, using different type name aliases. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head2 VersionBump => Str | ||
| 152 | |||
| 153 | Manually updates a previously-activated type to a new major or minor | ||
| 154 | version, if available. You can also use this parameter to update the | ||
| 155 | value of C<AutoUpdate>. | ||
| 156 | |||
| 157 | =over | ||
| 158 | |||
| 159 | =item * | ||
| 160 | |||
| 161 | C<MAJOR>: CloudFormation updates the extension to the newest major | ||
| 162 | version, if one is available. | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | C<MINOR>: CloudFormation updates the extension to the newest minor | ||
| 167 | version, if one is available. | ||
| 168 | |||
| 169 | =back | ||
| 170 | |||
| 171 | |||
| 172 | Valid values are: C<"MAJOR">, C<"MINOR"> | ||
| 173 | |||
| 174 | |||
| 175 | =head1 SEE ALSO | ||
| 176 | |||
| 177 | This class forms part of L<Paws>, documenting arguments for method ActivateType in L<Paws::CloudFormation> | ||
| 178 | |||
| 179 | =head1 BUGS and CONTRIBUTIONS | ||
| 180 | |||
| 181 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 182 | |||
| 183 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 184 | |||
| 185 | =cut | ||
| 186 |