File Coverage

blib/lib/Paws/CloudFormation/SignalResource.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CloudFormation::SignalResource;
3 1     1   795 use Moose;
  1         3  
  1         11  
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 1     1   11409 use MooseX::ClassAttribute;
  1         5  
  1         13  
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 Paws::CloudFormation
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method SignalResource on the
25             AWS 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             As an example:
31              
32             $service_obj->SignalResource(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 B<REQUIRED> LogicalResourceId => Str
40              
41             The logical ID of the resource that you want to signal. The logical ID
42             is the name of the resource that given in the template.
43              
44              
45              
46             =head2 B<REQUIRED> StackName => Str
47              
48             The stack name or unique stack ID that includes the resource that you
49             want to signal.
50              
51              
52              
53             =head2 B<REQUIRED> Status => Str
54              
55             The status of the signal, which is either success or failure. A failure
56             signal causes AWS CloudFormation to immediately fail the stack creation
57             or update.
58              
59             Valid values are: C<"SUCCESS">, C<"FAILURE">
60              
61             =head2 B<REQUIRED> UniqueId => Str
62              
63             A unique ID of the signal. When you signal Amazon EC2 instances or Auto
64             Scaling groups, specify the instance ID that you are signaling as the
65             unique ID. If you send multiple signals to a single resource (such as
66             signaling a wait condition), each signal requires a different unique
67             ID.
68              
69              
70              
71              
72             =head1 SEE ALSO
73              
74             This class forms part of L<Paws>, documenting arguments for method SignalResource in L<Paws::CloudFormation>
75              
76             =head1 BUGS and CONTRIBUTIONS
77              
78             The source code is located here: https://github.com/pplu/aws-sdk-perl
79              
80             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
81              
82             =cut
83