/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Synthetics::UpdateCanary

NAME

Paws::Synthetics::UpdateCanary - Arguments for method UpdateCanary on Paws::Synthetics

DESCRIPTION

This class represents the parameters used for calling the method UpdateCanary on the Synthetics service. Use the attributes of this class as arguments to method UpdateCanary.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateCanary.

SYNOPSIS

my $synthetics = Paws->service('Synthetics');
my $UpdateCanaryResponse = $synthetics->UpdateCanary(
  Name => 'MyCanaryName',
  Code => {
    Handler   => 'MyString',    # min: 1, max: 1024
    S3Bucket  => 'MyString',    # min: 1, max: 1024
    S3Key     => 'MyString',    # min: 1, max: 1024
    S3Version => 'MyString',    # min: 1, max: 1024
    ZipFile   => 'BlobBlob',    # min: 1, max: 10000000; OPTIONAL
  },    # OPTIONAL
  ExecutionRoleArn             => 'MyRoleArn',    # OPTIONAL
  FailureRetentionPeriodInDays => 1,              # OPTIONAL
  RunConfig                    => {
    ActiveTracing        => 1,                    # OPTIONAL
    EnvironmentVariables =>
      { 'MyEnvironmentVariableName' => 'MyEnvironmentVariableValue', }
    ,                                             # OPTIONAL
    MemoryInMB       => 1,    # min: 960, max: 3008; OPTIONAL
    TimeoutInSeconds => 1,    # min: 3, max: 840; OPTIONAL
  },    # OPTIONAL
  RuntimeVersion => 'MyString',    # OPTIONAL
  Schedule       => {
    Expression        => 'MyString',    # min: 1, max: 1024
    DurationInSeconds => 1,             # max: 31622400; OPTIONAL
  },    # OPTIONAL
  SuccessRetentionPeriodInDays => 1,    # OPTIONAL
  VpcConfig                    => {
    SecurityGroupIds => [ 'MySecurityGroupId', ... ],    # max: 5; OPTIONAL
    SubnetIds        => [ 'MySubnetId',        ... ],    # max: 16; OPTIONAL
  },    # OPTIONAL
);

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/synthetics/UpdateCanary

ATTRIBUTES

Code => Paws::Synthetics::CanaryCodeInput

A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.

ExecutionRoleArn => Str

The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

  • s3:PutObject

  • s3:GetBucketLocation

  • s3:ListAllMyBuckets

  • cloudwatch:PutMetricData

  • logs:CreateLogGroup

  • logs:CreateLogStream

  • logs:CreateLogStream

FailureRetentionPeriodInDays => Int

The number of days to retain data about failed runs of this canary.

REQUIRED Name => Str

The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html).

You cannot change the name of a canary that has already been created.

RunConfig => Paws::Synthetics::CanaryRunConfigInput

A structure that contains the timeout value that is used for each individual run of the canary.

RuntimeVersion => Str

Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html).

Schedule => Paws::Synthetics::CanaryScheduleInput

A structure that contains information about how often the canary is to run, and when these runs are to stop.

SuccessRetentionPeriodInDays => Int

The number of days to retain data about successful runs of this canary.

VpcConfig => Paws::Synthetics::VpcConfigInput

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html).

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateCanary in Paws::Synthetics

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues