« blib/lib/Paws/SSM/MaintenanceWindowLambdaParameters.pm
↑ Summary
blib/lib/Paws/SSM/MaintenanceWindowStepFunctionsParameters.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SSM::MaintenanceWindowRunCommandParameters; | ||
| 3 | use Moose; | ||
| 4 | has CloudWatchOutputConfig => (is => 'ro', isa => 'Paws::SSM::CloudWatchOutputConfig'); | ||
| 5 | has Comment => (is => 'ro', isa => 'Str'); | ||
| 6 | has DocumentHash => (is => 'ro', isa => 'Str'); | ||
| 7 | has DocumentHashType => (is => 'ro', isa => 'Str'); | ||
| 8 | has DocumentVersion => (is => 'ro', isa => 'Str'); | ||
| 9 | has NotificationConfig => (is => 'ro', isa => 'Paws::SSM::NotificationConfig'); | ||
| 10 | has OutputS3BucketName => (is => 'ro', isa => 'Str'); | ||
| 11 | has OutputS3KeyPrefix => (is => 'ro', isa => 'Str'); | ||
| 12 | has Parameters => (is => 'ro', isa => 'Paws::SSM::Parameters'); | ||
| 13 | has ServiceRoleArn => (is => 'ro', isa => 'Str'); | ||
| 14 | has TimeoutSeconds => (is => 'ro', isa => 'Int'); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::SSM::MaintenanceWindowRunCommandParameters | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::SSM::MaintenanceWindowRunCommandParameters object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { CloudWatchOutputConfig => $value, ..., TimeoutSeconds => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::MaintenanceWindowRunCommandParameters object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->CloudWatchOutputConfig | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | The parameters for a RUN_COMMAND task type. | ||
| 47 | |||
| 48 | For information about specifying and updating task parameters, see | ||
| 49 | RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask. | ||
| 50 | |||
| 51 | C<LoggingInfo> has been deprecated. To specify an S3 bucket to contain | ||
| 52 | logs, instead use the C<OutputS3BucketName> and C<OutputS3KeyPrefix> | ||
| 53 | options in the C<TaskInvocationParameters> structure. For information | ||
| 54 | about how Systems Manager handles these options for the supported | ||
| 55 | maintenance window task types, see | ||
| 56 | MaintenanceWindowTaskInvocationParameters. | ||
| 57 | |||
| 58 | C<TaskParameters> has been deprecated. To specify parameters to pass to | ||
| 59 | a task when it runs, instead use the C<Parameters> option in the | ||
| 60 | C<TaskInvocationParameters> structure. For information about how | ||
| 61 | Systems Manager handles these options for the supported maintenance | ||
| 62 | window task types, see MaintenanceWindowTaskInvocationParameters. | ||
| 63 | |||
| 64 | For Run Command tasks, Systems Manager uses specified values for | ||
| 65 | C<TaskParameters> and C<LoggingInfo> only if no values are specified | ||
| 66 | for C<TaskInvocationParameters>. | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 CloudWatchOutputConfig => L<Paws::SSM::CloudWatchOutputConfig> | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 Comment => Str | ||
| 77 | |||
| 78 | Information about the commands to run. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 DocumentHash => Str | ||
| 82 | |||
| 83 | The SHA-256 or SHA-1 hash created by the system when the document was | ||
| 84 | created. SHA-1 hashes have been deprecated. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 DocumentHashType => Str | ||
| 88 | |||
| 89 | SHA-256 or SHA-1. SHA-1 hashes have been deprecated. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 DocumentVersion => Str | ||
| 93 | |||
| 94 | The SSM document version to use in the request. You can specify | ||
| 95 | $DEFAULT, $LATEST, or a specific version number. If you run commands by | ||
| 96 | using the AWS CLI, then you must escape the first two options by using | ||
| 97 | a backslash. If you specify a version number, then you don't need to | ||
| 98 | use the backslash. For example: | ||
| 99 | |||
| 100 | --document-version "\$DEFAULT" | ||
| 101 | |||
| 102 | --document-version "\$LATEST" | ||
| 103 | |||
| 104 | --document-version "3" | ||
| 105 | |||
| 106 | |||
| 107 | =head2 NotificationConfig => L<Paws::SSM::NotificationConfig> | ||
| 108 | |||
| 109 | Configurations for sending notifications about command status changes | ||
| 110 | on a per-instance basis. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 OutputS3BucketName => Str | ||
| 114 | |||
| 115 | The name of the S3 bucket. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 OutputS3KeyPrefix => Str | ||
| 119 | |||
| 120 | The S3 bucket subfolder. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 Parameters => L<Paws::SSM::Parameters> | ||
| 124 | |||
| 125 | The parameters for the RUN_COMMAND task execution. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 ServiceRoleArn => Str | ||
| 129 | |||
| 130 | The ARN of the IAM service role to use to publish Amazon Simple | ||
| 131 | Notification Service (Amazon SNS) notifications for maintenance window | ||
| 132 | Run Command tasks. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 TimeoutSeconds => Int | ||
| 136 | |||
| 137 | If this time is reached and the command has not already started | ||
| 138 | running, it doesn't run. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head1 SEE ALSO | ||
| 143 | |||
| 144 | This class forms part of L<Paws>, describing an object used in L<Paws::SSM> | ||
| 145 | |||
| 146 | =head1 BUGS and CONTRIBUTIONS | ||
| 147 | |||
| 148 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 149 | |||
| 150 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 151 | |||
| 152 | =cut | ||
| 153 |