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.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.synthetics.CfnCanaryProps
CfnCanaryProps.Builder, CfnCanaryProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJsii$Proxy(CfnCanaryProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnCanaryProps.Builder.protectedJsii$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.JsonNodefinal booleanfinal ObjectA structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.final StringThe location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.final ObjectA structure that specifies the browser type to use for a canary run.final ObjectgetCode()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 ObjectSpecifies whether to perform a dry run before updating the canary.final StringThe ARN of the IAM role to be used to run the canary.final NumberThe number of days to retain data about failed runs of this canary.final StringgetName()The name for this canary.final StringSpecifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.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 valuelambda-function.final ObjectA structure that contains input information for a canary run.final StringSpecifies the runtime version to use for the canary.final ObjectA structure that contains information about how often the canary is to run, and when these runs are to stop.final ObjectSpecify TRUE to have the canary start making runs immediately after it is created.final NumberThe 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 Objectfinal ObjectA list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on.final ObjectIf 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 inthashCode()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:CfnCanaryPropsThe 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:
getArtifactS3Locationin interfaceCfnCanaryProps- See Also:
-
getCode
Description copied from interface:CfnCanaryPropsUse 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:
getCodein interfaceCfnCanaryProps- See Also:
-
getExecutionRoleArn
Description copied from interface:CfnCanaryPropsThe ARN of the IAM role to be used to run the canary.This role must already exist, and must include
lambda.amazonaws.com.rproxy.govskope.caas a principal in the trust policy. The role must also have the following permissions:s3:PutObjects3:GetBucketLocations3:ListAllMyBucketscloudwatch:PutMetricDatalogs:CreateLogGrouplogs:CreateLogStreamlogs:PutLogEvents
- Specified by:
getExecutionRoleArnin interfaceCfnCanaryProps- See Also:
-
getName
Description copied from interface:CfnCanaryPropsThe 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:
getNamein interfaceCfnCanaryProps- See Also:
-
getRuntimeVersion
Description copied from interface:CfnCanaryPropsSpecifies the runtime version to use for the canary.For more information about runtime versions, see Canary Runtime Versions .
- Specified by:
getRuntimeVersionin interfaceCfnCanaryProps- See Also:
-
getSchedule
Description copied from interface:CfnCanaryPropsA structure that contains information about how often the canary is to run, and when these runs are to stop.- Specified by:
getSchedulein interfaceCfnCanaryProps- See Also:
-
getArtifactConfig
Description copied from interface:CfnCanaryPropsA 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:
getArtifactConfigin interfaceCfnCanaryProps- See Also:
-
getBrowserConfigs
Description copied from interface:CfnCanaryPropsA structure that specifies the browser type to use for a canary run.CloudWatch Synthetics supports running canaries on both
CHROMEandFIREFOXbrowsers.If not specified,
browserConfigsdefaults to Chrome.- Specified by:
getBrowserConfigsin 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:
getDeleteLambdaResourcesOnCanaryDeletionin interfaceCfnCanaryProps- See Also:
-
getDryRunAndUpdate
Description copied from interface:CfnCanaryPropsSpecifies 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
falseor omitted, the canary will be updated directly without first performing a dry run. The default value isfalse.For more information, see Performing safe canary updates .
- Specified by:
getDryRunAndUpdatein interfaceCfnCanaryProps- See Also:
-
getFailureRetentionPeriod
Description copied from interface:CfnCanaryPropsThe 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:
getFailureRetentionPeriodin interfaceCfnCanaryProps- See Also:
-
getProvisionedResourceCleanup
Description copied from interface:CfnCanaryPropsSpecifies 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 theDeleteLambdaparameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.- Specified by:
getProvisionedResourceCleanupin interfaceCfnCanaryProps- See Also:
-
getResourcesToReplicateTags
Description copied from interface:CfnCanaryPropsTo 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 valuelambda-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:
getResourcesToReplicateTagsin interfaceCfnCanaryProps- See Also:
-
getRunConfig
Description copied from interface:CfnCanaryPropsA 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:
getRunConfigin interfaceCfnCanaryProps- See Also:
-
getStartCanaryAfterCreation
Description copied from interface:CfnCanaryPropsSpecify 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:
getStartCanaryAfterCreationin interfaceCfnCanaryProps- See Also:
-
getSuccessRetentionPeriod
Description copied from interface:CfnCanaryPropsThe 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:
getSuccessRetentionPeriodin interfaceCfnCanaryProps- See Also:
-
getTags
Description copied from interface:CfnCanaryPropsThe list of key-value pairs that are associated with the canary.- Specified by:
getTagsin interfaceCfnCanaryProps- See Also:
-
getVisualReference
- Specified by:
getVisualReferencein interfaceCfnCanaryProps- See Also:
-
getVisualReferences
Description copied from interface:CfnCanaryPropsA 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.0and above, andsyn-nodejs-playwright-3.0and above, only supportsvisualReferences.visualReferencefield is not supported.Versions older than
syn-nodejs-puppeteer-11.0supports bothvisualReferenceandvisualReferencesfor backward compatibility. It is recommended to usevisualReferencesfor consistency and future compatibility.- Specified by:
getVisualReferencesin interfaceCfnCanaryProps- See Also:
-
getVpcConfig
Description copied from interface:CfnCanaryPropsIf 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:
getVpcConfigin interfaceCfnCanaryProps- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-