CfnCanaryProps

class aws_cdk.aws_synthetics.CfnCanaryProps(*, artifact_s3_location, code, execution_role_arn, name, runtime_version, schedule, start_canary_after_creation, failure_retention_period=None, run_config=None, success_retention_period=None, tags=None, visual_reference=None, vpc_config=None)

Bases: object

Properties for defining a AWS::Synthetics::Canary.

Parameters
  • artifact_s3_location (str) – AWS::Synthetics::Canary.ArtifactS3Location.

  • code (Union[CodeProperty, IResolvable]) – AWS::Synthetics::Canary.Code.

  • execution_role_arn (str) – AWS::Synthetics::Canary.ExecutionRoleArn.

  • name (str) – AWS::Synthetics::Canary.Name.

  • runtime_version (str) – AWS::Synthetics::Canary.RuntimeVersion.

  • schedule (Union[IResolvable, ScheduleProperty]) – AWS::Synthetics::Canary.Schedule.

  • start_canary_after_creation (Union[bool, IResolvable]) – AWS::Synthetics::Canary.StartCanaryAfterCreation.

  • failure_retention_period (Union[int, float, None]) – AWS::Synthetics::Canary.FailureRetentionPeriod.

  • run_config (Union[IResolvable, RunConfigProperty, None]) – AWS::Synthetics::Canary.RunConfig.

  • success_retention_period (Union[int, float, None]) – AWS::Synthetics::Canary.SuccessRetentionPeriod.

  • tags (Optional[Sequence[CfnTag]]) – AWS::Synthetics::Canary.Tags.

  • visual_reference (Union[IResolvable, VisualReferenceProperty, None]) – AWS::Synthetics::Canary.VisualReference.

  • vpc_config (Union[IResolvable, VPCConfigProperty, None]) – AWS::Synthetics::Canary.VPCConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html

Attributes

artifact_s3_location

AWS::Synthetics::Canary.ArtifactS3Location.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-artifacts3location

Return type

str

code

AWS::Synthetics::Canary.Code.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-code

Return type

Union[CodeProperty, IResolvable]

execution_role_arn

AWS::Synthetics::Canary.ExecutionRoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-executionrolearn

Return type

str

failure_retention_period

AWS::Synthetics::Canary.FailureRetentionPeriod.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-failureretentionperiod

Return type

Union[int, float, None]

name

AWS::Synthetics::Canary.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-name

Return type

str

run_config

AWS::Synthetics::Canary.RunConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-runconfig

Return type

Union[IResolvable, RunConfigProperty, None]

runtime_version

AWS::Synthetics::Canary.RuntimeVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-runtimeversion

Return type

str

schedule

AWS::Synthetics::Canary.Schedule.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-schedule

Return type

Union[IResolvable, ScheduleProperty]

start_canary_after_creation

AWS::Synthetics::Canary.StartCanaryAfterCreation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-startcanaryaftercreation

Return type

Union[bool, IResolvable]

success_retention_period

AWS::Synthetics::Canary.SuccessRetentionPeriod.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-successretentionperiod

Return type

Union[int, float, None]

tags

AWS::Synthetics::Canary.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-tags

Return type

Optional[List[CfnTag]]

visual_reference

AWS::Synthetics::Canary.VisualReference.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-visualreference

Return type

Union[IResolvable, VisualReferenceProperty, None]

vpc_config

AWS::Synthetics::Canary.VPCConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-vpcconfig

Return type

Union[IResolvable, VPCConfigProperty, None]