Class CfnCanaryProps.Jsii$Proxy
- All Implemented Interfaces:
CfnCanaryProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnCanaryProps
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
ConstructorsModifierConstructorDescriptionprotected
Jsii$Proxy
(CfnCanaryProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnCanaryProps.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 TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Object
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
The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.final Object
getCode()
Use this structure to input your script code for the canary.final Object
(deprecated) Deletes associated lambda resources created by Synthetics if set to True.final String
The ARN of the IAM role to be used to run the canary.final Number
The number of days to retain data about failed runs of this canary.final String
getName()
The name for this canary.final Object
A structure that contains input information for a canary run.final String
Specifies the runtime version to use for the canary.final Object
A structure that contains information about how often the canary is to run, and when these runs are to stop.final Object
Specify TRUE to have the canary start making runs immediately after it is created.final Number
The number of days to retain data about successful runs of this canary.getTags()
The list of key-value pairs that are associated with the canary.final Object
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.final Object
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
-
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
Constructor that initializes the object based on literal property values passed by theCfnCanaryProps.Builder
.
-
-
Method Details
-
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 interfaceCfnCanaryProps
- See Also:
-
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
.- Specified by:
getCode
in interfaceCfnCanaryProps
- See Also:
-
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 interfaceCfnCanaryProps
- See Also:
-
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 interfaceCfnCanaryProps
- See Also:
-
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 interfaceCfnCanaryProps
- See Also:
-
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.- Specified by:
getSchedule
in interfaceCfnCanaryProps
- See Also:
-
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.- Specified by:
getArtifactConfig
in interfaceCfnCanaryProps
- See Also:
-
getDeleteLambdaResourcesOnCanaryDeletion
Description copied from interface:CfnCanaryProps
(deprecated) Deletes associated lambda resources created by Synthetics if set to True.Default is False
- Specified by:
getDeleteLambdaResourcesOnCanaryDeletion
in interfaceCfnCanaryProps
- See Also:
-
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.
- Specified by:
getFailureRetentionPeriod
in interfaceCfnCanaryProps
- See Also:
-
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.
- Specified by:
getRunConfig
in interfaceCfnCanaryProps
- See Also:
-
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.
- Specified by:
getStartCanaryAfterCreation
in interfaceCfnCanaryProps
- See Also:
-
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.
- Specified by:
getSuccessRetentionPeriod
in interfaceCfnCanaryProps
- See Also:
-
getTags
Description copied from interface:CfnCanaryProps
The list of key-value pairs that are associated with the canary.- Specified by:
getTags
in interfaceCfnCanaryProps
- See Also:
-
getVisualReference
Description copied from interface:CfnCanaryProps
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.- Specified by:
getVisualReference
in interfaceCfnCanaryProps
- See Also:
-
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 .
- Specified by:
getVpcConfig
in interfaceCfnCanaryProps
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-