software.amazon.awscdk.services.synthetics

Class CfnCanary

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.synthetics.CfnCanary

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:19.549Z")
 @Stability(value=Stable)
public class CfnCanary
extends CfnResource
implements IInspectable

A CloudFormation `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.*;
 CfnCanary cfnCanary = CfnCanary.Builder.create(this, "MyCfnCanary")
         .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	Class and Description
static interface	CfnCanary.ArtifactConfigProperty Example:
static interface	CfnCanary.BaseScreenshotProperty Example:
static class	CfnCanary.Builder A fluent builder for CfnCanary.
static interface	CfnCanary.CodeProperty Example:
static interface	CfnCanary.RunConfigProperty Example:
static interface	CfnCanary.S3EncryptionProperty Example:
static interface	CfnCanary.ScheduleProperty Example:
static interface	CfnCanary.VisualReferenceProperty Example:
static interface	CfnCanary.VPCConfigProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCanary(software.constructs.Construct scope, String id, CfnCanaryProps props) Create a new `AWS::Synthetics::Canary`.
protected	CfnCanary(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCanary(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getArtifactConfig() `AWS::Synthetics::Canary.ArtifactConfig`.
String	getArtifactS3Location() `AWS::Synthetics::Canary.ArtifactS3Location`.
String	getAttrId()
String	getAttrState()
protected Map<String,Object>	getCfnProperties()
Object	getCode() `AWS::Synthetics::Canary.Code`.
String	getExecutionRoleArn() `AWS::Synthetics::Canary.ExecutionRoleArn`.
Number	getFailureRetentionPeriod() `AWS::Synthetics::Canary.FailureRetentionPeriod`.
String	getName() `AWS::Synthetics::Canary.Name`.
Object	getRunConfig() `AWS::Synthetics::Canary.RunConfig`.
String	getRuntimeVersion() `AWS::Synthetics::Canary.RuntimeVersion`.
Object	getSchedule() `AWS::Synthetics::Canary.Schedule`.
Object	getStartCanaryAfterCreation() `AWS::Synthetics::Canary.StartCanaryAfterCreation`.
Number	getSuccessRetentionPeriod() `AWS::Synthetics::Canary.SuccessRetentionPeriod`.
TagManager	getTags() `AWS::Synthetics::Canary.Tags`.
Object	getVisualReference() `AWS::Synthetics::Canary.VisualReference`.
Object	getVpcConfig() `AWS::Synthetics::Canary.VPCConfig`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setArtifactConfig(CfnCanary.ArtifactConfigProperty value) `AWS::Synthetics::Canary.ArtifactConfig`.
void	setArtifactConfig(IResolvable value) `AWS::Synthetics::Canary.ArtifactConfig`.
void	setArtifactS3Location(String value) `AWS::Synthetics::Canary.ArtifactS3Location`.
void	setCode(CfnCanary.CodeProperty value) `AWS::Synthetics::Canary.Code`.
void	setCode(IResolvable value) `AWS::Synthetics::Canary.Code`.
void	setExecutionRoleArn(String value) `AWS::Synthetics::Canary.ExecutionRoleArn`.
void	setFailureRetentionPeriod(Number value) `AWS::Synthetics::Canary.FailureRetentionPeriod`.
void	setName(String value) `AWS::Synthetics::Canary.Name`.
void	setRunConfig(CfnCanary.RunConfigProperty value) `AWS::Synthetics::Canary.RunConfig`.
void	setRunConfig(IResolvable value) `AWS::Synthetics::Canary.RunConfig`.
void	setRuntimeVersion(String value) `AWS::Synthetics::Canary.RuntimeVersion`.
void	setSchedule(CfnCanary.ScheduleProperty value) `AWS::Synthetics::Canary.Schedule`.
void	setSchedule(IResolvable value) `AWS::Synthetics::Canary.Schedule`.
void	setStartCanaryAfterCreation(Boolean value) `AWS::Synthetics::Canary.StartCanaryAfterCreation`.
void	setStartCanaryAfterCreation(IResolvable value) `AWS::Synthetics::Canary.StartCanaryAfterCreation`.
void	setSuccessRetentionPeriod(Number value) `AWS::Synthetics::Canary.SuccessRetentionPeriod`.
void	setVisualReference(CfnCanary.VisualReferenceProperty value) `AWS::Synthetics::Canary.VisualReference`.
void	setVisualReference(IResolvable value) `AWS::Synthetics::Canary.VisualReference`.
void	setVpcConfig(CfnCanary.VPCConfigProperty value) `AWS::Synthetics::Canary.VPCConfig`.
void	setVpcConfig(IResolvable value) `AWS::Synthetics::Canary.VPCConfig`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCanary

protected CfnCanary(software.amazon.jsii.JsiiObjectRef objRef)

CfnCanary

protected CfnCanary(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCanary

@Stability(value=Stable)
public CfnCanary(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          CfnCanaryProps props)

Create a new `AWS::Synthetics::Canary`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getArtifactConfig

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

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

setArtifactConfig

@Stability(value=Stable)
public void setArtifactConfig(@Nullable
                                                       CfnCanary.ArtifactConfigProperty value)

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

setArtifactConfig

@Stability(value=Stable)
public void setArtifactConfig(@Nullable
                                                       IResolvable value)

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

getArtifactS3Location

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

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

setArtifactS3Location

@Stability(value=Stable)
public void setArtifactS3Location(@NotNull
                                                           String value)

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

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

getAttrState

@Stability(value=Stable)
 @NotNull
public String getAttrState()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCode

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

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

setCode

@Stability(value=Stable)
public void setCode(@NotNull
                                             CfnCanary.CodeProperty value)

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

setCode

@Stability(value=Stable)
public void setCode(@NotNull
                                             IResolvable value)

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

getExecutionRoleArn

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

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

setExecutionRoleArn

@Stability(value=Stable)
public void setExecutionRoleArn(@NotNull
                                                         String value)

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

getFailureRetentionPeriod

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

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

setFailureRetentionPeriod

@Stability(value=Stable)
public void setFailureRetentionPeriod(@Nullable
                                                               Number value)

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

getName

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

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

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

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

getRunConfig

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

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

setRunConfig

@Stability(value=Stable)
public void setRunConfig(@Nullable
                                                  CfnCanary.RunConfigProperty value)

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

setRunConfig

@Stability(value=Stable)
public void setRunConfig(@Nullable
                                                  IResolvable value)

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

getRuntimeVersion

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

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

setRuntimeVersion

@Stability(value=Stable)
public void setRuntimeVersion(@NotNull
                                                       String value)

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

getSchedule

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

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

setSchedule

@Stability(value=Stable)
public void setSchedule(@NotNull
                                                 CfnCanary.ScheduleProperty value)

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

setSchedule

@Stability(value=Stable)
public void setSchedule(@NotNull
                                                 IResolvable value)

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

getStartCanaryAfterCreation

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

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

setStartCanaryAfterCreation

@Stability(value=Stable)
public void setStartCanaryAfterCreation(@NotNull
                                                                 Boolean value)

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

setStartCanaryAfterCreation

@Stability(value=Stable)
public void setStartCanaryAfterCreation(@NotNull
                                                                 IResolvable value)

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

getSuccessRetentionPeriod

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

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

setSuccessRetentionPeriod

@Stability(value=Stable)
public void setSuccessRetentionPeriod(@Nullable
                                                               Number value)

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

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getVisualReference

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

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

setVisualReference

@Stability(value=Stable)
public void setVisualReference(@Nullable
                                                        CfnCanary.VisualReferenceProperty value)

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

setVisualReference

@Stability(value=Stable)
public void setVisualReference(@Nullable
                                                        IResolvable value)

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

getVpcConfig

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

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

setVpcConfig

@Stability(value=Stable)
public void setVpcConfig(@Nullable
                                                  CfnCanary.VPCConfigProperty value)

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

setVpcConfig

@Stability(value=Stable)
public void setVpcConfig(@Nullable
                                                  IResolvable value)

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