Package software.amazon.awscdk.services.synthetics

Class CfnCanaryProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.synthetics.CfnCanaryProps.Jsii$Proxy

All Implemented Interfaces:

CfnCanaryProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnCanaryProps

@Stability(Stable)
@Internal
public static final class CfnCanaryProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnCanaryProps

An implementation for CfnCanaryProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.synthetics.CfnCanaryProps

CfnCanaryProps.Builder, CfnCanaryProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnCanaryProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnCanaryProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getArtifactConfig()	A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
final String	getArtifactS3Location()	The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
final Object	getBrowserConfigs()	A structure that specifies the browser type to use for a canary run.
final Object	getCode()	Use this structure to input your script code for the canary.
final Object	getDeleteLambdaResourcesOnCanaryDeletion()	(deprecated) Deletes associated lambda resources created by Synthetics if set to True.
final Object	getDryRunAndUpdate()	Specifies whether to perform a dry run before updating the canary.
final String	getExecutionRoleArn()	The ARN of the IAM role to be used to run the canary.
final Number	getFailureRetentionPeriod()	The number of days to retain data about failed runs of this canary.
final String	getName()	The name for this canary.
final String	getProvisionedResourceCleanup()	Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.
final List<String>	getResourcesToReplicateTags()	To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this property with the value lambda-function .
final Object	getRunConfig()	A structure that contains input information for a canary run.
final String	getRuntimeVersion()	Specifies the runtime version to use for the canary.
final Object	getSchedule()	A structure that contains information about how often the canary is to run, and when these runs are to stop.
final Object	getStartCanaryAfterCreation()	Specify TRUE to have the canary start making runs immediately after it is created.
final Number	getSuccessRetentionPeriod()	The number of days to retain data about successful runs of this canary.
final List<CfnTag>	getTags()	The list of key-value pairs that are associated with the canary.
final Object	getVisualReference()	Returns union: either IResolvable or CfnCanary.VisualReferenceProperty
final Object	getVisualReferences()	A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on.
final Object	getVpcConfig()	If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnCanaryProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnCanaryProps.Builder.

Method Details

getArtifactS3Location

public final String getArtifactS3Location()

Description copied from interface: CfnCanaryProps

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.

Artifacts include the log file, screenshots, and HAR files. Specify the full location path, including s3:// at the beginning of the path.

Specified by:

getArtifactS3Location in interface CfnCanaryProps

See Also:

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

getCode

public final Object getCode()

Description copied from interface: CfnCanaryProps

Use this structure to input your script code for the canary.

This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script is passed into the canary directly, the script code is contained in the value of Script .

Returns union: either IResolvable or CfnCanary.CodeProperty

Specified by:

getCode in interface CfnCanaryProps

See Also:

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

getExecutionRoleArn

public final String getExecutionRoleArn()

Description copied from interface: CfnCanaryProps

The ARN of the IAM role to be used to run the canary.

This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

• s3:PutObject
• s3:GetBucketLocation
• s3:ListAllMyBuckets
• cloudwatch:PutMetricData
• logs:CreateLogGroup
• logs:CreateLogStream
• logs:PutLogEvents

Specified by:

getExecutionRoleArn in interface CfnCanaryProps

See Also:

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

getName

public final String getName()

Description copied from interface: CfnCanaryProps

The name for this canary.

Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries .

Specified by:

getName in interface CfnCanaryProps

See Also:

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

getRuntimeVersion

public final String getRuntimeVersion()

Description copied from interface: CfnCanaryProps

Specifies the runtime version to use for the canary.

For more information about runtime versions, see Canary Runtime Versions .

Specified by:

getRuntimeVersion in interface CfnCanaryProps

See Also:

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

getSchedule

public final Object getSchedule()

Description copied from interface: CfnCanaryProps

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

Returns union: either IResolvable or CfnCanary.ScheduleProperty

Specified by:

getSchedule in interface CfnCanaryProps

See Also:

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

getArtifactConfig

public final Object getArtifactConfig()

Description copied from interface: CfnCanaryProps

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

Returns union: either IResolvable or CfnCanary.ArtifactConfigProperty

Specified by:

getArtifactConfig in interface CfnCanaryProps

See Also:

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

getBrowserConfigs

public final Object getBrowserConfigs()

Description copied from interface: CfnCanaryProps

A structure that specifies the browser type to use for a canary run.

CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

If not specified, browserConfigs defaults to Chrome.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCanary.BrowserConfigProperty>

Specified by:

getBrowserConfigs in interface CfnCanaryProps

See Also:

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

getDeleteLambdaResourcesOnCanaryDeletion

public final Object getDeleteLambdaResourcesOnCanaryDeletion()

Description copied from interface: CfnCanaryProps

(deprecated) Deletes associated lambda resources created by Synthetics if set to True.

Default is False

Returns union: either Boolean or IResolvable

Specified by:

getDeleteLambdaResourcesOnCanaryDeletion in interface CfnCanaryProps

See Also:

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

getDryRunAndUpdate

public final Object getDryRunAndUpdate()

Description copied from interface: CfnCanaryProps

Specifies whether to perform a dry run before updating the canary.

If set to true , CloudFormation will execute a dry run to validate the changes before applying them to the canary. If the dry run succeeds, the canary will be updated with the changes. If the dry run fails, the CloudFormation deployment will fail with the dry run’s failure reason.

If set to false or omitted, the canary will be updated directly without first performing a dry run. The default value is false .

For more information, see Performing safe canary updates .

Returns union: either Boolean or IResolvable

Specified by:

getDryRunAndUpdate in interface CfnCanaryProps

See Also:

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

getFailureRetentionPeriod

public final Number getFailureRetentionPeriod()

Description copied from interface: CfnCanaryProps

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

If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

This setting affects the range of information returned by GetCanaryRuns , as well as the range of information displayed in the Synthetics console.

Specified by:

getFailureRetentionPeriod in interface CfnCanaryProps

See Also:

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

getProvisionedResourceCleanup

public final String getProvisionedResourceCleanup()

Description copied from interface: CfnCanaryProps

Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.

If it is AUTOMATIC , the Lambda functions and layers will be deleted when the canary is deleted.

If the value of this parameter is OFF , then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.

Specified by:

getProvisionedResourceCleanup in interface CfnCanaryProps

See Also:

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

getResourcesToReplicateTags

public final List<String> getResourcesToReplicateTags()

Description copied from interface: CfnCanaryProps

To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this property with the value lambda-function .

If you do this, CloudWatch Synthetics will keep the tags of the canary and the Lambda function synchronized. Any future changes you make to the canary's tags will also be applied to the function.

Specified by:

getResourcesToReplicateTags in interface CfnCanaryProps

See Also:

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

getRunConfig

public final Object getRunConfig()

Description copied from interface: CfnCanaryProps

A structure that contains input information for a canary run.

If you omit this structure, the frequency of the canary is used as canary's timeout value, up to a maximum of 900 seconds.

Returns union: either IResolvable or CfnCanary.RunConfigProperty

Specified by:

getRunConfig in interface CfnCanaryProps

See Also:

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

getStartCanaryAfterCreation

public final Object getStartCanaryAfterCreation()

Description copied from interface: CfnCanaryProps

Specify TRUE to have the canary start making runs immediately after it is created.

A canary that you create using CloudFormation can't be used to monitor the CloudFormation stack that creates the canary or to roll back that stack if there is a failure.

Returns union: either Boolean or IResolvable

Specified by:

getStartCanaryAfterCreation in interface CfnCanaryProps

See Also:

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

getSuccessRetentionPeriod

public final Number getSuccessRetentionPeriod()

Description copied from interface: CfnCanaryProps

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

If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

This setting affects the range of information returned by GetCanaryRuns , as well as the range of information displayed in the Synthetics console.

Specified by:

getSuccessRetentionPeriod in interface CfnCanaryProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnCanaryProps

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

Specified by:

getTags in interface CfnCanaryProps

See Also:

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

getVisualReference

public final Object getVisualReference()

Description copied from interface: CfnCanaryProps

Returns union: either IResolvable or CfnCanary.VisualReferenceProperty

Specified by:

getVisualReference in interface CfnCanaryProps

See Also:

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

getVisualReferences

public final Object getVisualReferences()

Description copied from interface: CfnCanaryProps

A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on.

Visual references are used for visual monitoring comparisons.

syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, only supports visualReferences . visualReference field is not supported.

Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences for consistency and future compatibility.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCanary.VisualReferenceProperty>

Specified by:

getVisualReferences in interface CfnCanaryProps

See Also:

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

getVpcConfig

public final Object getVpcConfig()

Description copied from interface: CfnCanaryProps

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint.

For more information, see Running a Canary in a VPC .

Returns union: either IResolvable or CfnCanary.VPCConfigProperty

Specified by:

getVpcConfig in interface CfnCanaryProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object