awssynthetics

Documentation

Index

• func CfnCanary_CFN_RESOURCE_TYPE_NAME() *string
• func CfnCanary_IsCfnElement(x interface{}) *bool
• func CfnCanary_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnCanary_IsConstruct(x interface{}) *bool
• func NewCfnCanary_Override(c CfnCanary, scope constructs.Construct, id *string, props *CfnCanaryProps)
• type CfnCanary
  • func NewCfnCanary(scope constructs.Construct, id *string, props *CfnCanaryProps) CfnCanary
• type CfnCanaryProps
• type CfnCanary_ArtifactConfigProperty
• type CfnCanary_BaseScreenshotProperty
• type CfnCanary_CodeProperty
• type CfnCanary_RunConfigProperty
• type CfnCanary_S3EncryptionProperty
• type CfnCanary_ScheduleProperty
• type CfnCanary_VPCConfigProperty
• type CfnCanary_VisualReferenceProperty

Functions

func CfnCanary_CFN_RESOURCE_TYPE_NAME

func CfnCanary_CFN_RESOURCE_TYPE_NAME() *string

func CfnCanary_IsCfnElement

func CfnCanary_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnCanary_IsCfnResource

func CfnCanary_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnCanary_IsConstruct

func CfnCanary_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnCanary_Override

func NewCfnCanary_Override(c CfnCanary, scope constructs.Construct, id *string, props *CfnCanaryProps)

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

Types

type CfnCanary

type CfnCanary interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ArtifactConfig() interface{}
	SetArtifactConfig(val interface{})
	ArtifactS3Location() *string
	SetArtifactS3Location(val *string)
	AttrId() *string
	AttrState() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Code() interface{}
	SetCode(val interface{})
	CreationStack() *[]*string
	ExecutionRoleArn() *string
	SetExecutionRoleArn(val *string)
	FailureRetentionPeriod() *float64
	SetFailureRetentionPeriod(val *float64)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	RunConfig() interface{}
	SetRunConfig(val interface{})
	RuntimeVersion() *string
	SetRuntimeVersion(val *string)
	Schedule() interface{}
	SetSchedule(val interface{})
	Stack() awscdk.Stack
	StartCanaryAfterCreation() interface{}
	SetStartCanaryAfterCreation(val interface{})
	SuccessRetentionPeriod() *float64
	SetSuccessRetentionPeriod(val *float64)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	VisualReference() interface{}
	SetVisualReference(val interface{})
	VpcConfig() interface{}
	SetVpcConfig(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Synthetics::Canary`.

TODO: EXAMPLE

func NewCfnCanary

func NewCfnCanary(scope constructs.Construct, id *string, props *CfnCanaryProps) CfnCanary

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

type CfnCanaryProps

type CfnCanaryProps struct {
	// `AWS::Synthetics::Canary.ArtifactConfig`.
	ArtifactConfig interface{} `json:"artifactConfig"`
	// `AWS::Synthetics::Canary.ArtifactS3Location`.
	ArtifactS3Location *string `json:"artifactS3Location"`
	// `AWS::Synthetics::Canary.Code`.
	Code interface{} `json:"code"`
	// `AWS::Synthetics::Canary.ExecutionRoleArn`.
	ExecutionRoleArn *string `json:"executionRoleArn"`
	// `AWS::Synthetics::Canary.FailureRetentionPeriod`.
	FailureRetentionPeriod *float64 `json:"failureRetentionPeriod"`
	// `AWS::Synthetics::Canary.Name`.
	Name *string `json:"name"`
	// `AWS::Synthetics::Canary.RunConfig`.
	RunConfig interface{} `json:"runConfig"`
	// `AWS::Synthetics::Canary.RuntimeVersion`.
	RuntimeVersion *string `json:"runtimeVersion"`
	// `AWS::Synthetics::Canary.Schedule`.
	Schedule interface{} `json:"schedule"`
	// `AWS::Synthetics::Canary.StartCanaryAfterCreation`.
	StartCanaryAfterCreation interface{} `json:"startCanaryAfterCreation"`
	// `AWS::Synthetics::Canary.SuccessRetentionPeriod`.
	SuccessRetentionPeriod *float64 `json:"successRetentionPeriod"`
	// `AWS::Synthetics::Canary.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// `AWS::Synthetics::Canary.VisualReference`.
	VisualReference interface{} `json:"visualReference"`
	// `AWS::Synthetics::Canary.VPCConfig`.
	VpcConfig interface{} `json:"vpcConfig"`
}

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

TODO: EXAMPLE

type CfnCanary_ArtifactConfigProperty

type CfnCanary_ArtifactConfigProperty struct {
	// `CfnCanary.ArtifactConfigProperty.S3Encryption`.
	S3Encryption interface{} `json:"s3Encryption"`
}

TODO: EXAMPLE

type CfnCanary_BaseScreenshotProperty

type CfnCanary_BaseScreenshotProperty struct {
	// `CfnCanary.BaseScreenshotProperty.IgnoreCoordinates`.
	IgnoreCoordinates *[]*string `json:"ignoreCoordinates"`
	// `CfnCanary.BaseScreenshotProperty.ScreenshotName`.
	ScreenshotName *string `json:"screenshotName"`
}

TODO: EXAMPLE

type CfnCanary_CodeProperty

type CfnCanary_CodeProperty struct {
	// `CfnCanary.CodeProperty.Handler`.
	Handler *string `json:"handler"`
	// `CfnCanary.CodeProperty.S3Bucket`.
	S3Bucket *string `json:"s3Bucket"`
	// `CfnCanary.CodeProperty.S3Key`.
	S3Key *string `json:"s3Key"`
	// `CfnCanary.CodeProperty.S3ObjectVersion`.
	S3ObjectVersion *string `json:"s3ObjectVersion"`
	// `CfnCanary.CodeProperty.Script`.
	Script *string `json:"script"`
}

TODO: EXAMPLE

type CfnCanary_RunConfigProperty

type CfnCanary_RunConfigProperty struct {
	// `CfnCanary.RunConfigProperty.ActiveTracing`.
	ActiveTracing interface{} `json:"activeTracing"`
	// `CfnCanary.RunConfigProperty.EnvironmentVariables`.
	EnvironmentVariables interface{} `json:"environmentVariables"`
	// `CfnCanary.RunConfigProperty.MemoryInMB`.
	MemoryInMb *float64 `json:"memoryInMb"`
	// `CfnCanary.RunConfigProperty.TimeoutInSeconds`.
	TimeoutInSeconds *float64 `json:"timeoutInSeconds"`
}

TODO: EXAMPLE

type CfnCanary_S3EncryptionProperty

type CfnCanary_S3EncryptionProperty struct {
	// `CfnCanary.S3EncryptionProperty.EncryptionMode`.
	EncryptionMode *string `json:"encryptionMode"`
	// `CfnCanary.S3EncryptionProperty.KmsKeyArn`.
	KmsKeyArn *string `json:"kmsKeyArn"`
}

TODO: EXAMPLE

type CfnCanary_ScheduleProperty

type CfnCanary_ScheduleProperty struct {
	// `CfnCanary.ScheduleProperty.DurationInSeconds`.
	DurationInSeconds *string `json:"durationInSeconds"`
	// `CfnCanary.ScheduleProperty.Expression`.
	Expression *string `json:"expression"`
}

TODO: EXAMPLE

type CfnCanary_VPCConfigProperty

type CfnCanary_VPCConfigProperty struct {
	// `CfnCanary.VPCConfigProperty.SecurityGroupIds`.
	SecurityGroupIds *[]*string `json:"securityGroupIds"`
	// `CfnCanary.VPCConfigProperty.SubnetIds`.
	SubnetIds *[]*string `json:"subnetIds"`
	// `CfnCanary.VPCConfigProperty.VpcId`.
	VpcId *string `json:"vpcId"`
}

TODO: EXAMPLE

type CfnCanary_VisualReferenceProperty

type CfnCanary_VisualReferenceProperty struct {
	// `CfnCanary.VisualReferenceProperty.BaseCanaryRunId`.
	BaseCanaryRunId *string `json:"baseCanaryRunId"`
	// `CfnCanary.VisualReferenceProperty.BaseScreenshots`.
	BaseScreenshots interface{} `json:"baseScreenshots"`
}

TODO: EXAMPLE