Amazonka.Synthetics.Types.Canary

Documentation

data Canary

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

See: newCanary smart constructor.

Constructors

Canary'

Fields

• artifactConfig :: Maybe ArtifactConfigOutput

  A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

• artifactS3Location :: Maybe Text

  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 :: Maybe CanaryCodeOutput
• engineArn :: Maybe Text

  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.

• executionRoleArn :: Maybe Text

  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 :: Maybe Natural

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

• id :: Maybe Text

  The unique ID of this canary.

• name :: Maybe Text

  The name of the canary.

• runConfig :: Maybe CanaryRunConfigOutput
• runtimeVersion :: Maybe Text

  Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

• schedule :: Maybe CanaryScheduleOutput

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

• status :: Maybe CanaryStatus

  A structure that contains information about the canary's status.

• successRetentionPeriodInDays :: Maybe Natural

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

• tags :: Maybe (HashMap Text Text)

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

• timeline :: Maybe CanaryTimeline

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

• visualReference :: Maybe VisualReferenceOutput

  If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

• vpcConfig :: Maybe VpcConfigOutput

Instances

FromJSON Canary

Defined in Amazonka.Synthetics.Types.Canary

Methods

parseJSON :: Value -> Parser Canary

parseJSONList :: Value -> Parser [Canary]

Generic Canary

Defined in Amazonka.Synthetics.Types.Canary

Associated Types

type Rep Canary :: Type -> Type

Methods

from :: Canary -> Rep Canary x

to :: Rep Canary x -> Canary

Read Canary

Defined in Amazonka.Synthetics.Types.Canary

Methods

readsPrec :: Int -> ReadS Canary

readList :: ReadS [Canary]

readPrec :: ReadPrec Canary

readListPrec :: ReadPrec [Canary]

Show Canary

Defined in Amazonka.Synthetics.Types.Canary

Methods

showsPrec :: Int -> Canary -> ShowS

show :: Canary -> String

showList :: [Canary] -> ShowS

NFData Canary

Defined in Amazonka.Synthetics.Types.Canary

Methods

rnf :: Canary -> ()

Eq Canary

Defined in Amazonka.Synthetics.Types.Canary

Methods

(==) :: Canary -> Canary -> Bool

(/=) :: Canary -> Canary -> Bool

Hashable Canary

Defined in Amazonka.Synthetics.Types.Canary

Methods

hashWithSalt :: Int -> Canary -> Int

hash :: Canary -> Int

type Rep Canary

Defined in Amazonka.Synthetics.Types.Canary

type Rep Canary = D1 ('MetaData "Canary" "Amazonka.Synthetics.Types.Canary" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "Canary'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "artifactConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ArtifactConfigOutput)) :*: S1 ('MetaSel ('Just "artifactS3Location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanaryCodeOutput)) :*: S1 ('MetaSel ('Just "engineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureRetentionPeriodInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "runConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanaryRunConfigOutput)) :*: S1 ('MetaSel ('Just "runtimeVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanaryScheduleOutput)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanaryStatus)))) :*: ((S1 ('MetaSel ('Just "successRetentionPeriodInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "timeline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanaryTimeline)) :*: (S1 ('MetaSel ('Just "visualReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VisualReferenceOutput)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfigOutput))))))))

newCanary :: Canary

Create a value of Canary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:artifactConfig:Canary', canary_artifactConfig - A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

$sel:artifactS3Location:Canary', canary_artifactS3Location - The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

$sel:code:Canary', canary_code - Undocumented member.

$sel:engineArn:Canary', canary_engineArn - 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.

$sel:executionRoleArn:Canary', canary_executionRoleArn - 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.

$sel:failureRetentionPeriodInDays:Canary', canary_failureRetentionPeriodInDays - The number of days to retain data about failed runs of this canary.

$sel:id:Canary', canary_id - The unique ID of this canary.

$sel:name:Canary', canary_name - The name of the canary.

$sel:runConfig:Canary', canary_runConfig - Undocumented member.

$sel:runtimeVersion:Canary', canary_runtimeVersion - Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

$sel:schedule:Canary', canary_schedule - A structure that contains information about how often the canary is to run, and when these runs are to stop.

$sel:status:Canary', canary_status - A structure that contains information about the canary's status.

$sel:successRetentionPeriodInDays:Canary', canary_successRetentionPeriodInDays - The number of days to retain data about successful runs of this canary.

$sel:tags:Canary', canary_tags - The list of key-value pairs that are associated with the canary.

$sel:timeline:Canary', canary_timeline - A structure that contains information about when the canary was created, modified, and most recently run.

$sel:visualReference:Canary', canary_visualReference - If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

$sel:vpcConfig:Canary', canary_vpcConfig - Undocumented member.

canary_artifactConfig :: Lens' Canary (Maybe ArtifactConfigOutput)

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

canary_artifactS3Location :: Lens' Canary (Maybe Text)

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

canary_code :: Lens' Canary (Maybe CanaryCodeOutput)

Undocumented member.

canary_engineArn :: Lens' Canary (Maybe Text)

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.

canary_executionRoleArn :: Lens' Canary (Maybe Text)

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.

canary_failureRetentionPeriodInDays :: Lens' Canary (Maybe Natural)

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

canary_id :: Lens' Canary (Maybe Text)

The unique ID of this canary.

canary_name :: Lens' Canary (Maybe Text)

The name of the canary.

canary_runConfig :: Lens' Canary (Maybe CanaryRunConfigOutput)

Undocumented member.

canary_runtimeVersion :: Lens' Canary (Maybe Text)

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

canary_schedule :: Lens' Canary (Maybe CanaryScheduleOutput)

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

canary_status :: Lens' Canary (Maybe CanaryStatus)

A structure that contains information about the canary's status.

canary_successRetentionPeriodInDays :: Lens' Canary (Maybe Natural)

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

canary_tags :: Lens' Canary (Maybe (HashMap Text Text))

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

canary_timeline :: Lens' Canary (Maybe CanaryTimeline)

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

canary_visualReference :: Lens' Canary (Maybe VisualReferenceOutput)

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

canary_vpcConfig :: Lens' Canary (Maybe VpcConfigOutput)

Undocumented member.