« blib/lib/Paws/SSMIncidents/CreateReplicationSetOutput.pm
↑ Summary
blib/lib/Paws/SSMIncidents/CreateResponsePlanOutput.pm »
| 1 | |||
| 2 | package Paws::SSMIncidents::CreateResponsePlan; | ||
| 3 | use Moose; | ||
| 4 | has Actions => (is => 'ro', isa => 'ArrayRef[Paws::SSMIncidents::Action]', traits => ['NameInRequest'], request_name => 'actions'); | ||
| 5 | has ChatChannel => (is => 'ro', isa => 'Paws::SSMIncidents::ChatChannel', traits => ['NameInRequest'], request_name => 'chatChannel'); | ||
| 6 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 7 | has DisplayName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'displayName'); | ||
| 8 | has Engagements => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'engagements'); | ||
| 9 | has IncidentTemplate => (is => 'ro', isa => 'Paws::SSMIncidents::IncidentTemplate', traits => ['NameInRequest'], request_name => 'incidentTemplate', required => 1); | ||
| 10 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name', required => 1); | ||
| 11 | has Tags => (is => 'ro', isa => 'Paws::SSMIncidents::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateResponsePlan'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/createResponsePlan'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSMIncidents::CreateResponsePlanOutput'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::SSMIncidents::CreateResponsePlan - Arguments for method CreateResponsePlan on L<Paws::SSMIncidents> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateResponsePlan on the | ||
| 30 | L<AWS Systems Manager Incident Manager|Paws::SSMIncidents> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateResponsePlan. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateResponsePlan. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $ssm-incidents = Paws->service('SSMIncidents'); | ||
| 38 | my $CreateResponsePlanOutput = $ssm -incidents->CreateResponsePlan( | ||
| 39 | IncidentTemplate => { | ||
| 40 | Impact => 1, # min: 1, max: 5 | ||
| 41 | Title => 'MyIncidentTitle', # max: 200 | ||
| 42 | DedupeString => 'MyDedupeString', # max: 1000; OPTIONAL | ||
| 43 | NotificationTargets => [ | ||
| 44 | { | ||
| 45 | SnsTopicArn => 'MyArn', # max: 1000; OPTIONAL | ||
| 46 | }, | ||
| 47 | ... | ||
| 48 | ], # max: 10; OPTIONAL | ||
| 49 | Summary => 'MyIncidentSummary', # max: 4000; OPTIONAL | ||
| 50 | }, | ||
| 51 | Name => 'MyResponsePlanName', | ||
| 52 | Actions => [ | ||
| 53 | { | ||
| 54 | SsmAutomation => { | ||
| 55 | DocumentName => 'MySsmAutomationDocumentNameString', | ||
| 56 | RoleArn => 'MyRoleArn', # max: 1000 | ||
| 57 | DocumentVersion => | ||
| 58 | 'MySsmAutomationDocumentVersionString', # max: 128; OPTIONAL | ||
| 59 | Parameters => { | ||
| 60 | 'MySsmParametersKeyString' => [ | ||
| 61 | 'MySsmParameterValuesMemberString', ... # max: 512 | ||
| 62 | ], # key: min: 1, max: 50, value: max: 100 | ||
| 63 | }, # min: 1, max: 200; OPTIONAL | ||
| 64 | TargetAccount => 'RESPONSE_PLAN_OWNER_ACCOUNT' | ||
| 65 | , # values: RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT; OPTIONAL | ||
| 66 | }, # OPTIONAL | ||
| 67 | }, | ||
| 68 | ... | ||
| 69 | ], # OPTIONAL | ||
| 70 | ChatChannel => { | ||
| 71 | ChatbotSns => [ | ||
| 72 | 'MySnsArn', ... # max: 1000 | ||
| 73 | ], # min: 1, max: 5; OPTIONAL | ||
| 74 | Empty => { | ||
| 75 | |||
| 76 | }, # OPTIONAL | ||
| 77 | }, # OPTIONAL | ||
| 78 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 79 | DisplayName => 'MyResponsePlanDisplayName', # OPTIONAL | ||
| 80 | Engagements => [ | ||
| 81 | 'MySsmContactsArn', ... # max: 2048 | ||
| 82 | ], # OPTIONAL | ||
| 83 | Tags => { | ||
| 84 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 85 | }, # OPTIONAL | ||
| 86 | ); | ||
| 87 | |||
| 88 | # Results: | ||
| 89 | my $Arn = $CreateResponsePlanOutput->Arn; | ||
| 90 | |||
| 91 | # Returns a L<Paws::SSMIncidents::CreateResponsePlanOutput> object. | ||
| 92 | |||
| 93 | 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. | ||
| 94 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm-incidents/CreateResponsePlan> | ||
| 95 | |||
| 96 | =head1 ATTRIBUTES | ||
| 97 | |||
| 98 | |||
| 99 | =head2 Actions => ArrayRef[L<Paws::SSMIncidents::Action>] | ||
| 100 | |||
| 101 | The actions that the response plan starts at the beginning of an | ||
| 102 | incident. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 ChatChannel => L<Paws::SSMIncidents::ChatChannel> | ||
| 107 | |||
| 108 | The AWS Chatbot chat channel used for collaboration during an incident. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 ClientToken => Str | ||
| 113 | |||
| 114 | A token ensuring that the action is called only once with the specified | ||
| 115 | details. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 DisplayName => Str | ||
| 120 | |||
| 121 | The long format of the response plan name. This field can contain | ||
| 122 | spaces. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 Engagements => ArrayRef[Str|Undef] | ||
| 127 | |||
| 128 | The contacts and escalation plans that the response plan engages during | ||
| 129 | an incident. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 B<REQUIRED> IncidentTemplate => L<Paws::SSMIncidents::IncidentTemplate> | ||
| 134 | |||
| 135 | Details used to create an incident when using this response plan. | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 B<REQUIRED> Name => Str | ||
| 140 | |||
| 141 | The short format name of the response plan. Can't include spaces. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 Tags => L<Paws::SSMIncidents::TagMap> | ||
| 146 | |||
| 147 | A list of tags that you are adding to the response plan. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head1 SEE ALSO | ||
| 153 | |||
| 154 | This class forms part of L<Paws>, documenting arguments for method CreateResponsePlan in L<Paws::SSMIncidents> | ||
| 155 | |||
| 156 | =head1 BUGS and CONTRIBUTIONS | ||
| 157 | |||
| 158 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 159 | |||
| 160 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 161 | |||
| 162 | =cut | ||
| 163 |