CfnCanary

class aws_cdk.aws_synthetics.CfnCanary(scope, id, *, 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: aws_cdk.core.CfnResource

A CloudFormation AWS::Synthetics::Canary.

CloudformationResource

AWS::Synthetics::Canary

Link

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

Create a new AWS::Synthetics::Canary.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

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

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Synthetics::Canary'
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

attr_id

Id

Type

cloudformationAttribute

Return type

str

attr_state

State

Type

cloudformationAttribute

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

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]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

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]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

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

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

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]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

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

TagManager

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]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

BaseScreenshotProperty

class CfnCanary.BaseScreenshotProperty(*, screenshot_name, ignore_coordinates=None)

Bases: object

Parameters
  • screenshot_name (str) – CfnCanary.BaseScreenshotProperty.ScreenshotName.

  • ignore_coordinates (Optional[Sequence[str]]) – CfnCanary.BaseScreenshotProperty.IgnoreCoordinates.

Link

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

Attributes

ignore_coordinates

CfnCanary.BaseScreenshotProperty.IgnoreCoordinates.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-basescreenshot.html#cfn-synthetics-canary-basescreenshot-ignorecoordinates

Return type

Optional[List[str]]

screenshot_name

CfnCanary.BaseScreenshotProperty.ScreenshotName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-basescreenshot.html#cfn-synthetics-canary-basescreenshot-screenshotname

Return type

str

CodeProperty

class CfnCanary.CodeProperty(*, handler, s3_bucket=None, s3_key=None, s3_object_version=None, script=None)

Bases: object

Parameters
  • handler (str) – CfnCanary.CodeProperty.Handler.

  • s3_bucket (Optional[str]) – CfnCanary.CodeProperty.S3Bucket.

  • s3_key (Optional[str]) – CfnCanary.CodeProperty.S3Key.

  • s3_object_version (Optional[str]) – CfnCanary.CodeProperty.S3ObjectVersion.

  • script (Optional[str]) – CfnCanary.CodeProperty.Script.

Link

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

Attributes

handler

CfnCanary.CodeProperty.Handler.

Link

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

Return type

str

s3_bucket

CfnCanary.CodeProperty.S3Bucket.

Link

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

Return type

Optional[str]

s3_key

CfnCanary.CodeProperty.S3Key.

Link

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

Return type

Optional[str]

s3_object_version

CfnCanary.CodeProperty.S3ObjectVersion.

Link

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

Return type

Optional[str]

script

CfnCanary.CodeProperty.Script.

Link

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

Return type

Optional[str]

RunConfigProperty

class CfnCanary.RunConfigProperty(*, active_tracing=None, environment_variables=None, memory_in_mb=None, timeout_in_seconds=None)

Bases: object

Parameters
  • active_tracing (Union[bool, IResolvable, None]) – CfnCanary.RunConfigProperty.ActiveTracing.

  • environment_variables (Union[IResolvable, Mapping[str, str], None]) – CfnCanary.RunConfigProperty.EnvironmentVariables.

  • memory_in_mb (Union[int, float, None]) – CfnCanary.RunConfigProperty.MemoryInMB.

  • timeout_in_seconds (Union[int, float, None]) – CfnCanary.RunConfigProperty.TimeoutInSeconds.

Link

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

Attributes

active_tracing

CfnCanary.RunConfigProperty.ActiveTracing.

Link

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

Return type

Union[bool, IResolvable, None]

environment_variables

CfnCanary.RunConfigProperty.EnvironmentVariables.

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]

memory_in_mb

CfnCanary.RunConfigProperty.MemoryInMB.

Link

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

Return type

Union[int, float, None]

timeout_in_seconds

CfnCanary.RunConfigProperty.TimeoutInSeconds.

Link

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

Return type

Union[int, float, None]

ScheduleProperty

class CfnCanary.ScheduleProperty(*, expression, duration_in_seconds=None)

Bases: object

Parameters
  • expression (str) – CfnCanary.ScheduleProperty.Expression.

  • duration_in_seconds (Optional[str]) – CfnCanary.ScheduleProperty.DurationInSeconds.

Link

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

Attributes

duration_in_seconds

CfnCanary.ScheduleProperty.DurationInSeconds.

Link

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

Return type

Optional[str]

expression

CfnCanary.ScheduleProperty.Expression.

Link

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

Return type

str

VPCConfigProperty

class CfnCanary.VPCConfigProperty(*, security_group_ids, subnet_ids, vpc_id=None)

Bases: object

Parameters
  • security_group_ids (Sequence[str]) – CfnCanary.VPCConfigProperty.SecurityGroupIds.

  • subnet_ids (Sequence[str]) – CfnCanary.VPCConfigProperty.SubnetIds.

  • vpc_id (Optional[str]) – CfnCanary.VPCConfigProperty.VpcId.

Link

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

Attributes

security_group_ids

CfnCanary.VPCConfigProperty.SecurityGroupIds.

Link

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

Return type

List[str]

subnet_ids

CfnCanary.VPCConfigProperty.SubnetIds.

Link

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

Return type

List[str]

vpc_id

CfnCanary.VPCConfigProperty.VpcId.

Link

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

Return type

Optional[str]

VisualReferenceProperty

class CfnCanary.VisualReferenceProperty(*, base_canary_run_id, base_screenshots=None)

Bases: object

Parameters
  • base_canary_run_id (str) – CfnCanary.VisualReferenceProperty.BaseCanaryRunId.

  • base_screenshots (Union[IResolvable, Sequence[Union[IResolvable, BaseScreenshotProperty]], None]) – CfnCanary.VisualReferenceProperty.BaseScreenshots.

Link

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

Attributes

base_canary_run_id

CfnCanary.VisualReferenceProperty.BaseCanaryRunId.

Link

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

Return type

str

base_screenshots

CfnCanary.VisualReferenceProperty.BaseScreenshots.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, BaseScreenshotProperty]], None]