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.14.1 (build 828de8a)",
           date="2020-11-24T22:28:57.278Z")
 @Stability(value=Stable)
public interface CfnCanaryProps
extends software.amazon.jsii.JsiiSerializable

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

See Also:

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

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()
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	getVpcConfig() `AWS::Synthetics::Canary.VPCConfig`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArtifactS3Location

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

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

See Also:

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

getCode

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

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

See Also:

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

getExecutionRoleArn

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

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

See Also:

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

getName

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

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

See Also:

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

getRuntimeVersion

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

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

See Also:

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

getSchedule

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

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

See Also:

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

getStartCanaryAfterCreation

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

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

See Also:

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

getFailureRetentionPeriod

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

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

See Also:

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

getRunConfig

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

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

See Also:

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

getSuccessRetentionPeriod

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

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

See Also:

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

getTags

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

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

See Also:

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

getVpcConfig

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

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

See Also:

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

builder

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

Returns:

a CfnCanaryProps.Builder of CfnCanaryProps