Canary

public struct Canary : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let artifactS3Location: String?

  • Undocumented

    Declaration

    Swift

    public let code: 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.

    Declaration

    Swift

    public let engineArn: String?

  • 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.

    Declaration

    Swift

    public let executionRoleArn: String?

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

    Declaration

    Swift

    public let failureRetentionPeriodInDays: Int?
  • id

    The unique ID of this canary.

    Declaration

    Swift

    public let id: String?

  • The name of the canary.

    Declaration

    Swift

    public let name: String?

  • Undocumented

    Declaration

    Swift

    public let runConfig: CanaryRunConfigOutput?

  • Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0. For more information about runtime versions, see Canary Runtime Versions.

    Declaration

    Swift

    public let runtimeVersion: String?

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

    Declaration

    Swift

    public let schedule: CanaryScheduleOutput?

  • A structure that contains information about the canary’s status.

    Declaration

    Swift

    public let status: CanaryStatus?

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

    Declaration

    Swift

    public let successRetentionPeriodInDays: Int?

  • The list of key-value pairs that are associated with the canary.

    Declaration

    Swift

    public let tags: [String : String]?

  • A structure that contains information about when the canary was created, modified, and most recently run.

    Declaration

    Swift

    public let timeline: CanaryTimeline?

  • Undocumented

    Declaration

    Swift

    public let vpcConfig: VpcConfigOutput?

  • Undocumented

    Declaration

    Swift

    public init(artifactS3Location: String? = nil, code: CanaryCodeOutput? = nil, engineArn: String? = nil, executionRoleArn: String? = nil, failureRetentionPeriodInDays: Int? = nil, id: String? = nil, name: String? = nil, runConfig: CanaryRunConfigOutput? = nil, runtimeVersion: String? = nil, schedule: CanaryScheduleOutput? = nil, status: CanaryStatus? = nil, successRetentionPeriodInDays: Int? = nil, tags: [String : String]? = nil, timeline: CanaryTimeline? = nil, vpcConfig: VpcConfigOutput? = nil)