software.amazon.awscdk.services.synthetics

Interface CfnCanaryProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCanaryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:08.191Z")
 @Stability(value=Stable)
public interface CfnCanaryProps
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.synthetics.*;
 CfnCanaryProps cfnCanaryProps = CfnCanaryProps.builder()
         .artifactS3Location("artifactS3Location")
         .code(CodeProperty.builder()
                 .handler("handler")
                 // the properties below are optional
                 .s3Bucket("s3Bucket")
                 .s3Key("s3Key")
                 .s3ObjectVersion("s3ObjectVersion")
                 .script("script")
                 .build())
         .executionRoleArn("executionRoleArn")
         .name("name")
         .runtimeVersion("runtimeVersion")
         .schedule(ScheduleProperty.builder()
                 .expression("expression")
                 // the properties below are optional
                 .durationInSeconds("durationInSeconds")
                 .build())
         .startCanaryAfterCreation(false)
         // the properties below are optional
         .artifactConfig(ArtifactConfigProperty.builder()
                 .s3Encryption(S3EncryptionProperty.builder()
                         .encryptionMode("encryptionMode")
                         .kmsKeyArn("kmsKeyArn")
                         .build())
                 .build())
         .failureRetentionPeriod(123)
         .runConfig(RunConfigProperty.builder()
                 .activeTracing(false)
                 .environmentVariables(Map.of(
                         "environmentVariablesKey", "environmentVariables"))
                 .memoryInMb(123)
                 .timeoutInSeconds(123)
                 .build())
         .successRetentionPeriod(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .visualReference(VisualReferenceProperty.builder()
                 .baseCanaryRunId("baseCanaryRunId")
                 // the properties below are optional
                 .baseScreenshots(List.of(BaseScreenshotProperty.builder()
                         .screenshotName("screenshotName")
                         // the properties below are optional
                         .ignoreCoordinates(List.of("ignoreCoordinates"))
                         .build()))
                 .build())
         .vpcConfig(VPCConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 // the properties below are optional
                 .vpcId("vpcId")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCanaryProps.Builder A builder for CfnCanaryProps
static class	CfnCanaryProps.Jsii$Proxy An implementation for CfnCanaryProps

Method Summary

Modifier and Type	Method and Description
static CfnCanaryProps.Builder	builder()
default Object	getArtifactConfig() `AWS::Synthetics::Canary.ArtifactConfig`.
String	getArtifactS3Location() `AWS::Synthetics::Canary.ArtifactS3Location`.
Object	getCode() `AWS::Synthetics::Canary.Code`.
String	getExecutionRoleArn() `AWS::Synthetics::Canary.ExecutionRoleArn`.
default Number	getFailureRetentionPeriod() `AWS::Synthetics::Canary.FailureRetentionPeriod`.
String	getName() `AWS::Synthetics::Canary.Name`.
default Object	getRunConfig() `AWS::Synthetics::Canary.RunConfig`.
String	getRuntimeVersion() `AWS::Synthetics::Canary.RuntimeVersion`.
Object	getSchedule() `AWS::Synthetics::Canary.Schedule`.
Object	getStartCanaryAfterCreation() `AWS::Synthetics::Canary.StartCanaryAfterCreation`.
default Number	getSuccessRetentionPeriod() `AWS::Synthetics::Canary.SuccessRetentionPeriod`.
default List<CfnTag>	getTags() `AWS::Synthetics::Canary.Tags`.
default Object	getVisualReference() `AWS::Synthetics::Canary.VisualReference`.
default Object	getVpcConfig() `AWS::Synthetics::Canary.VPCConfig`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArtifactConfig

@Stability(value=Stable)
 @Nullable
default Object getArtifactConfig()

`AWS::Synthetics::Canary.ArtifactConfig`.

getArtifactS3Location

@Stability(value=Stable)
 @NotNull
String getArtifactS3Location()

`AWS::Synthetics::Canary.ArtifactS3Location`.

getCode

@Stability(value=Stable)
 @NotNull
Object getCode()

`AWS::Synthetics::Canary.Code`.

getExecutionRoleArn

@Stability(value=Stable)
 @NotNull
String getExecutionRoleArn()

`AWS::Synthetics::Canary.ExecutionRoleArn`.

getFailureRetentionPeriod

@Stability(value=Stable)
 @Nullable
default Number getFailureRetentionPeriod()

`AWS::Synthetics::Canary.FailureRetentionPeriod`.

getName

@Stability(value=Stable)
 @NotNull
String getName()

`AWS::Synthetics::Canary.Name`.

getRunConfig

@Stability(value=Stable)
 @Nullable
default Object getRunConfig()

`AWS::Synthetics::Canary.RunConfig`.

getRuntimeVersion

@Stability(value=Stable)
 @NotNull
String getRuntimeVersion()

`AWS::Synthetics::Canary.RuntimeVersion`.

getSchedule

@Stability(value=Stable)
 @NotNull
Object getSchedule()

`AWS::Synthetics::Canary.Schedule`.

getStartCanaryAfterCreation

@Stability(value=Stable)
 @NotNull
Object getStartCanaryAfterCreation()

`AWS::Synthetics::Canary.StartCanaryAfterCreation`.

getSuccessRetentionPeriod

@Stability(value=Stable)
 @Nullable
default Number getSuccessRetentionPeriod()

`AWS::Synthetics::Canary.SuccessRetentionPeriod`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::Synthetics::Canary.Tags`.

getVisualReference

@Stability(value=Stable)
 @Nullable
default Object getVisualReference()

`AWS::Synthetics::Canary.VisualReference`.

getVpcConfig

@Stability(value=Stable)
 @Nullable
default Object getVpcConfig()

`AWS::Synthetics::Canary.VPCConfig`.

builder

@Stability(value=Stable)
static CfnCanaryProps.Builder builder()

Returns:

a CfnCanaryProps.Builder of CfnCanaryProps