NAME

Paws::Synthetics::Canary

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Synthetics::Canary object:

  $service_obj->Method(Att1 => { ArtifactS3Location => $value, ..., VpcConfig => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Synthetics::Canary object:

  $result = $service_obj->Method(...);
  $result->Att1->ArtifactS3Location

DESCRIPTION

This structure contains all information about one canary in your account.

ATTRIBUTES

ArtifactS3Location => Str

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Code => Paws::Synthetics::CanaryCodeOutput

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions (https://docs.aws.amazon.com/lambda/latest/dg/lambda-api-permissions-ref.html).

ExecutionRoleArn => Str

The ARN of the IAM role used to run the canary. This role must include "lambda.amazonaws.com" as a principal in the trust policy.

FailureRetentionPeriodInDays => Int

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

Id => Str

The unique ID of this canary.

Name => Str

The name of the canary.

RunConfig => Paws::Synthetics::CanaryRunConfigOutput

RuntimeVersion => Str

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