blib/lib/Paws/SSMContacts/CreateContact.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SSMContacts::CreateContact;
3 use Moose;
4 has Alias => (is => 'ro', isa => 'Str', required => 1);
5 has DisplayName => (is => 'ro', isa => 'Str');
6 has IdempotencyToken => (is => 'ro', isa => 'Str');
7 has Plan => (is => 'ro', isa => 'Paws::SSMContacts::Plan', required => 1);
8 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SSMContacts::Tag]');
9 has Type => (is => 'ro', isa => 'Str', required => 1);
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateContact');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSMContacts::CreateContactResult');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::SSMContacts::CreateContact - Arguments for method CreateContact on L<Paws::SSMContacts>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method CreateContact on the
27 L<AWS Systems Manager Incident Manager Contacts|Paws::SSMContacts> service. Use the attributes of this class
28 as arguments to method CreateContact.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateContact.
31  
32 =head1 SYNOPSIS
33  
34 my $ssm-contacts = Paws->service('SSMContacts');
35 my $CreateContactResult = $ssm -contacts->CreateContact(
36 Alias => 'MyContactAlias',
37 Plan => {
38 Stages => [
39 {
40 DurationInMinutes => 1, # max: 30
41 Targets => [
42 {
43 ChannelTargetInfo => {
44 ContactChannelId => 'MySsmContactsArn', # min: 1, max: 2048
45 RetryIntervalInMinutes => 1, # max: 60; OPTIONAL
46 }, # OPTIONAL
47 ContactTargetInfo => {
48 IsEssential => 1,
49 ContactId => 'MySsmContactsArn', # min: 1, max: 2048
50 }, # OPTIONAL
51 },
52 ...
53 ],
54  
55 },
56 ...
57 ],
58  
59 },
60 Type => 'PERSONAL',
61 DisplayName => 'MyContactName', # OPTIONAL
62 IdempotencyToken => 'MyIdempotencyToken', # OPTIONAL
63 Tags => [
64 {
65 Key => 'MyTagKey', # min: 1, max: 128; OPTIONAL
66 Value => 'MyTagValue', # min: 1, max: 256; OPTIONAL
67 },
68 ...
69 ], # OPTIONAL
70 );
71  
72 # Results:
73 my $ContactArn = $CreateContactResult->ContactArn;
74  
75 # Returns a L<Paws::SSMContacts::CreateContactResult> object.
76  
77 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.
78 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts/CreateContact>
79  
80 =head1 ATTRIBUTES
81  
82  
83 =head2 B<REQUIRED> Alias => Str
84  
85 The short name to quickly identify a contact or escalation plan. The
86 contact alias must be unique and identifiable.
87  
88  
89  
90 =head2 DisplayName => Str
91  
92 The full name of the contact or escalation plan.
93  
94  
95  
96 =head2 IdempotencyToken => Str
97  
98 A token ensuring that the action is called only once with the specified
99 details.
100  
101  
102  
103 =head2 B<REQUIRED> Plan => L<Paws::SSMContacts::Plan>
104  
105 A list of stages. A contact has an engagement plan with stages that
106 contact specified contact channels. An escalation plan uses stages that
107 contact specified contacts.
108  
109  
110  
111 =head2 Tags => ArrayRef[L<Paws::SSMContacts::Tag>]
112  
113 Adds a tag to the target. You can only tag resources created in the
114 first Region of your replication set.
115  
116  
117  
118 =head2 B<REQUIRED> Type => Str
119  
120 To create an escalation plan use C<ESCALATION>. To create a contact use
121 C<PERSONAL>.
122  
123 Valid values are: C<"PERSONAL">, C<"ESCALATION">
124  
125  
126 =head1 SEE ALSO
127  
128 This class forms part of L<Paws>, documenting arguments for method CreateContact in L<Paws::SSMContacts>
129  
130 =head1 BUGS and CONTRIBUTIONS
131  
132 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
133  
134 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
135  
136 =cut
137