« blib/lib/Paws/Synthetics/UntagResourceResponse.pm
↑ Summary
blib/lib/Paws/Synthetics/UpdateCanaryResponse.pm »
| 1 | |||
| 2 | package Paws::Synthetics::UpdateCanary; | ||
| 3 | use Moose; | ||
| 4 | has Code => (is => 'ro', isa => 'Paws::Synthetics::CanaryCodeInput'); | ||
| 5 | has ExecutionRoleArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has FailureRetentionPeriodInDays => (is => 'ro', isa => 'Int'); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name', required => 1); | ||
| 8 | has RunConfig => (is => 'ro', isa => 'Paws::Synthetics::CanaryRunConfigInput'); | ||
| 9 | has RuntimeVersion => (is => 'ro', isa => 'Str'); | ||
| 10 | has Schedule => (is => 'ro', isa => 'Paws::Synthetics::CanaryScheduleInput'); | ||
| 11 | has SuccessRetentionPeriodInDays => (is => 'ro', isa => 'Int'); | ||
| 12 | has VpcConfig => (is => 'ro', isa => 'Paws::Synthetics::VpcConfigInput'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateCanary'); | ||
| 17 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/canary/{name}'); | ||
| 18 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Synthetics::UpdateCanaryResponse'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::Synthetics::UpdateCanary - Arguments for method UpdateCanary on L<Paws::Synthetics> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method UpdateCanary on the | ||
| 31 | L<Synthetics|Paws::Synthetics> service. Use the attributes of this class | ||
| 32 | as arguments to method UpdateCanary. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateCanary. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $synthetics = Paws->service('Synthetics'); | ||
| 39 | my $UpdateCanaryResponse = $synthetics->UpdateCanary( | ||
| 40 | Name => 'MyCanaryName', | ||
| 41 | Code => { | ||
| 42 | Handler => 'MyString', # min: 1, max: 1024 | ||
| 43 | S3Bucket => 'MyString', # min: 1, max: 1024 | ||
| 44 | S3Key => 'MyString', # min: 1, max: 1024 | ||
| 45 | S3Version => 'MyString', # min: 1, max: 1024 | ||
| 46 | ZipFile => 'BlobBlob', # min: 1, max: 10000000; OPTIONAL | ||
| 47 | }, # OPTIONAL | ||
| 48 | ExecutionRoleArn => 'MyRoleArn', # OPTIONAL | ||
| 49 | FailureRetentionPeriodInDays => 1, # OPTIONAL | ||
| 50 | RunConfig => { | ||
| 51 | ActiveTracing => 1, # OPTIONAL | ||
| 52 | EnvironmentVariables => | ||
| 53 | { 'MyEnvironmentVariableName' => 'MyEnvironmentVariableValue', } | ||
| 54 | , # OPTIONAL | ||
| 55 | MemoryInMB => 1, # min: 960, max: 3008; OPTIONAL | ||
| 56 | TimeoutInSeconds => 1, # min: 3, max: 840; OPTIONAL | ||
| 57 | }, # OPTIONAL | ||
| 58 | RuntimeVersion => 'MyString', # OPTIONAL | ||
| 59 | Schedule => { | ||
| 60 | Expression => 'MyString', # min: 1, max: 1024 | ||
| 61 | DurationInSeconds => 1, # max: 31622400; OPTIONAL | ||
| 62 | }, # OPTIONAL | ||
| 63 | SuccessRetentionPeriodInDays => 1, # OPTIONAL | ||
| 64 | VpcConfig => { | ||
| 65 | SecurityGroupIds => [ 'MySecurityGroupId', ... ], # max: 5; OPTIONAL | ||
| 66 | SubnetIds => [ 'MySubnetId', ... ], # max: 16; OPTIONAL | ||
| 67 | }, # OPTIONAL | ||
| 68 | ); | ||
| 69 | |||
| 70 | 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. | ||
| 71 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/synthetics/UpdateCanary> | ||
| 72 | |||
| 73 | =head1 ATTRIBUTES | ||
| 74 | |||
| 75 | |||
| 76 | =head2 Code => L<Paws::Synthetics::CanaryCodeInput> | ||
| 77 | |||
| 78 | A structure that includes the entry point from which the canary should | ||
| 79 | start running your script. If the script is stored in an S3 bucket, the | ||
| 80 | bucket name, key, and version are also included. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 ExecutionRoleArn => Str | ||
| 85 | |||
| 86 | The ARN of the IAM role to be used to run the canary. This role must | ||
| 87 | already exist, and must include C<lambda.amazonaws.com> as a principal | ||
| 88 | in the trust policy. The role must also have the following permissions: | ||
| 89 | |||
| 90 | =over | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<s3:PutObject> | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<s3:GetBucketLocation> | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | C<s3:ListAllMyBuckets> | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | C<cloudwatch:PutMetricData> | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | C<logs:CreateLogGroup> | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | C<logs:CreateLogStream> | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | C<logs:CreateLogStream> | ||
| 119 | |||
| 120 | =back | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 FailureRetentionPeriodInDays => Int | ||
| 126 | |||
| 127 | The number of days to retain data about failed runs of this canary. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 B<REQUIRED> Name => Str | ||
| 132 | |||
| 133 | The name of the canary that you want to update. To find the names of | ||
| 134 | your canaries, use DescribeCanaries | ||
| 135 | (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html). | ||
| 136 | |||
| 137 | You cannot change the name of a canary that has already been created. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 RunConfig => L<Paws::Synthetics::CanaryRunConfigInput> | ||
| 142 | |||
| 143 | A structure that contains the timeout value that is used for each | ||
| 144 | individual run of the canary. | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head2 RuntimeVersion => Str | ||
| 149 | |||
| 150 | Specifies the runtime version to use for the canary. For a list of | ||
| 151 | valid runtime versions and for more information about runtime versions, | ||
| 152 | see Canary Runtime Versions | ||
| 153 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 Schedule => L<Paws::Synthetics::CanaryScheduleInput> | ||
| 158 | |||
| 159 | A structure that contains information about how often the canary is to | ||
| 160 | run, and when these runs are to stop. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head2 SuccessRetentionPeriodInDays => Int | ||
| 165 | |||
| 166 | The number of days to retain data about successful runs of this canary. | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 VpcConfig => L<Paws::Synthetics::VpcConfigInput> | ||
| 171 | |||
| 172 | If this canary is to test an endpoint in a VPC, this structure contains | ||
| 173 | information about the subnet and security groups of the VPC endpoint. | ||
| 174 | For more information, see Running a Canary in a VPC | ||
| 175 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html). | ||
| 176 | |||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | =head1 SEE ALSO | ||
| 181 | |||
| 182 | This class forms part of L<Paws>, documenting arguments for method UpdateCanary in L<Paws::Synthetics> | ||
| 183 | |||
| 184 | =head1 BUGS and CONTRIBUTIONS | ||
| 185 | |||
| 186 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 187 | |||
| 188 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 189 | |||
| 190 | =cut | ||
| 191 |