« blib/lib/Paws/CloudFormation/SetStackPolicy.pm
↑ Summary
blib/lib/Paws/CloudFormation/SetTypeConfigurationOutput.pm »
| 1 | |||
| 2 | package Paws::CloudFormation::SetTypeConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Configuration => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ConfigurationAlias => (is => 'ro', isa => 'Str'); | ||
| 6 | has Type => (is => 'ro', isa => 'Str'); | ||
| 7 | has TypeArn => (is => 'ro', isa => 'Str'); | ||
| 8 | has TypeName => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetTypeConfiguration'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::SetTypeConfigurationOutput'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'SetTypeConfigurationResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CloudFormation::SetTypeConfiguration - Arguments for method SetTypeConfiguration on L<Paws::CloudFormation> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method SetTypeConfiguration on the | ||
| 26 | L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class | ||
| 27 | as arguments to method SetTypeConfiguration. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetTypeConfiguration. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $cloudformation = Paws->service('CloudFormation'); | ||
| 34 | my $SetTypeConfigurationOutput = $cloudformation->SetTypeConfiguration( | ||
| 35 | Configuration => 'MyTypeConfiguration', | ||
| 36 | ConfigurationAlias => 'MyTypeConfigurationAlias', # OPTIONAL | ||
| 37 | Type => 'RESOURCE', # OPTIONAL | ||
| 38 | TypeArn => 'MyTypeArn', # OPTIONAL | ||
| 39 | TypeName => 'MyTypeName', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $ConfigurationArn = $SetTypeConfigurationOutput->ConfigurationArn; | ||
| 44 | |||
| 45 | # Returns a L<Paws::CloudFormation::SetTypeConfigurationOutput> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/SetTypeConfiguration> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> Configuration => Str | ||
| 54 | |||
| 55 | The configuration data for the extension, in this account and region. | ||
| 56 | |||
| 57 | The configuration data must be formatted as JSON, and validate against | ||
| 58 | the schema returned in the C<ConfigurationSchema> response element of | ||
| 59 | API_DescribeType. For more information, see Defining account-level | ||
| 60 | configuration data for an extension | ||
| 61 | (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration) | ||
| 62 | in the I<CloudFormation CLI User Guide>. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 ConfigurationAlias => Str | ||
| 67 | |||
| 68 | An alias by which to refer to this extension configuration data. | ||
| 69 | |||
| 70 | Conditional: Specifying a configuration alias is required when setting | ||
| 71 | a configuration for a resource type extension. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Type => Str | ||
| 76 | |||
| 77 | The type of extension. | ||
| 78 | |||
| 79 | Conditional: You must specify C<ConfigurationArn>, or C<Type> and | ||
| 80 | C<TypeName>. | ||
| 81 | |||
| 82 | Valid values are: C<"RESOURCE">, C<"MODULE"> | ||
| 83 | |||
| 84 | =head2 TypeArn => Str | ||
| 85 | |||
| 86 | The Amazon Resource Name (ARN) for the extension, in this account and | ||
| 87 | region. | ||
| 88 | |||
| 89 | For public extensions, this will be the ARN assigned when you activate | ||
| 90 | the type | ||
| 91 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) | ||
| 92 | in this account and region. For private extensions, this will be the | ||
| 93 | ARN assigned when you register the type | ||
| 94 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) | ||
| 95 | in this account and region. | ||
| 96 | |||
| 97 | Do not include the extension versions suffix at the end of the ARN. You | ||
| 98 | can set the configuration for an extension, but not for a specific | ||
| 99 | extension version. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 TypeName => Str | ||
| 104 | |||
| 105 | The name of the extension. | ||
| 106 | |||
| 107 | Conditional: You must specify C<ConfigurationArn>, or C<Type> and | ||
| 108 | C<TypeName>. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head1 SEE ALSO | ||
| 114 | |||
| 115 | This class forms part of L<Paws>, documenting arguments for method SetTypeConfiguration in L<Paws::CloudFormation> | ||
| 116 | |||
| 117 | =head1 BUGS and CONTRIBUTIONS | ||
| 118 | |||
| 119 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 120 | |||
| 121 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 122 | |||
| 123 | =cut | ||
| 124 |