« blib/lib/Paws/CloudFormation/SetTypeDefaultVersionOutput.pm
↑ Summary
blib/lib/Paws/CloudFormation/StackDriftInformation.pm »
| 1 | |||
| 2 | package Paws::CloudFormation::SignalResource; | ||
| 3 | use Moose; | ||
| 4 | has LogicalResourceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has StackName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Status => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has UniqueId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SignalResource'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudFormation::SignalResource - Arguments for method SignalResource on L<Paws::CloudFormation> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method SignalResource on the | ||
| 25 | L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class | ||
| 26 | as arguments to method SignalResource. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SignalResource. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $cloudformation = Paws->service('CloudFormation'); | ||
| 33 | $cloudformation->SignalResource( | ||
| 34 | LogicalResourceId => 'MyLogicalResourceId', | ||
| 35 | StackName => 'MyStackNameOrId', | ||
| 36 | Status => 'SUCCESS', | ||
| 37 | UniqueId => 'MyResourceSignalUniqueId', | ||
| 38 | |||
| 39 | ); | ||
| 40 | |||
| 41 | 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. | ||
| 42 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/SignalResource> | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> LogicalResourceId => Str | ||
| 48 | |||
| 49 | The logical ID of the resource that you want to signal. The logical ID | ||
| 50 | is the name of the resource that given in the template. | ||
| 51 | |||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> StackName => Str | ||
| 55 | |||
| 56 | The stack name or unique stack ID that includes the resource that you | ||
| 57 | want to signal. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> Status => Str | ||
| 62 | |||
| 63 | The status of the signal, which is either success or failure. A failure | ||
| 64 | signal causes AWS CloudFormation to immediately fail the stack creation | ||
| 65 | or update. | ||
| 66 | |||
| 67 | Valid values are: C<"SUCCESS">, C<"FAILURE"> | ||
| 68 | |||
| 69 | =head2 B<REQUIRED> UniqueId => Str | ||
| 70 | |||
| 71 | A unique ID of the signal. When you signal Amazon EC2 instances or Auto | ||
| 72 | Scaling groups, specify the instance ID that you are signaling as the | ||
| 73 | unique ID. If you send multiple signals to a single resource (such as | ||
| 74 | signaling a wait condition), each signal requires a different unique | ||
| 75 | ID. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, documenting arguments for method SignalResource in L<Paws::CloudFormation> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 |