Class CanaryProps.Jsii$Proxy
- All Implemented Interfaces:
CanaryProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CanaryProps
CanaryProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.synthetics.CanaryProps
CanaryProps.Builder, CanaryProps.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Jsii$Proxy
(CanaryProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCanaryProps.Builder
.protected
Jsii$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.JsonNode
final boolean
final Boolean
Specifies whether this canary is to use active AWS X-Ray tracing when it runs.final List<LifecycleRule>
Lifecycle rules for the generated canary artifact bucket.final ArtifactsBucketLocation
The s3 location that stores the data of the canary runs.final String
The name of the canary.final Cleanup
Specify the underlying resources to be cleaned up when the canary is deleted.Key-value pairs that the Synthetics caches and makes available for your canary scripts.final Duration
How many days should failed runs be retained.final Size
The maximum amount of memory that the canary can use while running.final IRole
getRole()
Canary execution role.final Runtime
Specify the runtime version to use for the canary.final Schedule
Specify the schedule for how often the canary runs.final List<ISecurityGroup>
The list of security groups to associate with the canary's network interfaces.final Boolean
Whether or not the canary should start after creation.final Duration
How many days should successful runs be retained.final Test
getTest()
The type of test that you want your canary to run.final Duration
How long the canary is allowed to run before it must stop.final Duration
How long the canary will be in a 'RUNNING' state.final IVpc
getVpc()
The VPC where this canary is run.final SubnetSelection
Where to place the network interfaces within the VPC.final int
hashCode()
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 theCanaryProps.Builder
.
-
-
Method Details
-
getRuntime
Description copied from interface:CanaryProps
Specify the runtime version to use for the canary.- Specified by:
getRuntime
in interfaceCanaryProps
- See Also:
-
getTest
Description copied from interface:CanaryProps
The type of test that you want your canary to run.Use
Test.custom()
to specify the test to run.- Specified by:
getTest
in interfaceCanaryProps
-
getActiveTracing
Description copied from interface:CanaryProps
Specifies whether this canary is to use active AWS X-Ray tracing when it runs.Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges.
You can enable active tracing only for canaries that use version
syn-nodejs-2.0
or later for their canary runtime.Default: false
- Specified by:
getActiveTracing
in interfaceCanaryProps
- See Also:
-
getArtifactsBucketLifecycleRules
Description copied from interface:CanaryProps
Lifecycle rules for the generated canary artifact bucket.Has no effect if a bucket is passed to
artifactsBucketLocation
. If you pass a bucket toartifactsBucketLocation
, you can add lifecycle rules to the bucket itself.Default: - no rules applied to the generated bucket.
- Specified by:
getArtifactsBucketLifecycleRules
in interfaceCanaryProps
-
getArtifactsBucketLocation
Description copied from interface:CanaryProps
The s3 location that stores the data of the canary runs.Default: - A new s3 bucket will be created without a prefix.
- Specified by:
getArtifactsBucketLocation
in interfaceCanaryProps
-
getCanaryName
Description copied from interface:CanaryProps
The name of the 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 name. The canary name makes up part of the canary ARN, which is included in outbound calls over the internet.
Default: - A unique name will be generated from the construct ID
- Specified by:
getCanaryName
in interfaceCanaryProps
- See Also:
-
getCleanup
Description copied from interface:CanaryProps
Specify the underlying resources to be cleaned up when the canary is deleted.Using
Cleanup.LAMBDA
will create a Custom Resource to achieve this.Default: Cleanup.NOTHING
- Specified by:
getCleanup
in interfaceCanaryProps
-
getEnvironmentVariables
Description copied from interface:CanaryProps
Key-value pairs that the Synthetics caches and makes available for your canary scripts.Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Canary script source code.
Default: - No environment variables.
- Specified by:
getEnvironmentVariables
in interfaceCanaryProps
-
getFailureRetentionPeriod
Description copied from interface:CanaryProps
How many days should failed runs be retained.Default: Duration.days(31)
- Specified by:
getFailureRetentionPeriod
in interfaceCanaryProps
-
getMemory
Description copied from interface:CanaryProps
The maximum amount of memory that the canary can use while running.This value must be a multiple of 64 Mib. The range is 960 MiB to 3008 MiB.
Default: Size.mebibytes(1024)
- Specified by:
getMemory
in interfaceCanaryProps
-
getRole
Description copied from interface:CanaryProps
Canary execution role.This is the role that will be assumed by the canary upon execution. It controls the permissions that the canary will have. The role must be assumable by the AWS Lambda service principal.
If not supplied, a role will be created with all the required permissions. If you provide a Role, you must add the required permissions.
Default: - A unique role will be generated for this canary. You can add permissions to roles by calling 'addToRolePolicy'.
- Specified by:
getRole
in interfaceCanaryProps
- See Also:
-
getSchedule
Description copied from interface:CanaryProps
Specify the schedule for how often the canary runs.For example, if you set
schedule
torate(10 minutes)
, then the canary will run every 10 minutes. You can set the schedule withSchedule.rate(Duration)
(recommended) or you can specify an expression usingSchedule.expression()
.Default: 'rate(5 minutes)'
- Specified by:
getSchedule
in interfaceCanaryProps
-
getSecurityGroups
Description copied from interface:CanaryProps
The list of security groups to associate with the canary's network interfaces.You must provide
vpc
when using this prop.Default: - If the canary is placed within a VPC and a security group is not specified a dedicated security group will be created for this canary.
- Specified by:
getSecurityGroups
in interfaceCanaryProps
-
getStartAfterCreation
Description copied from interface:CanaryProps
Whether or not the canary should start after creation.Default: true
- Specified by:
getStartAfterCreation
in interfaceCanaryProps
-
getSuccessRetentionPeriod
Description copied from interface:CanaryProps
How many days should successful runs be retained.Default: Duration.days(31)
- Specified by:
getSuccessRetentionPeriod
in interfaceCanaryProps
-
getTimeout
Description copied from interface:CanaryProps
How long the canary is allowed to run before it must stop.You can't set this time to be longer than the frequency of the runs of this canary.
The minimum allowed value is 3 seconds. The maximum allowed value is 840 seconds (14 minutes).
Default: - the frequency of the canary is used as this value, up to a maximum of 900 seconds.
- Specified by:
getTimeout
in interfaceCanaryProps
-
getTimeToLive
Description copied from interface:CanaryProps
How long the canary will be in a 'RUNNING' state.For example, if you set
timeToLive
to be 1 hour andschedule
to berate(10 minutes)
, your canary will run at 10 minute intervals for an hour, for a total of 6 times.Default: - no limit
- Specified by:
getTimeToLive
in interfaceCanaryProps
-
getVpc
Description copied from interface:CanaryProps
The VPC where this canary is run.Specify this if the canary needs to access resources in a VPC.
Default: - Not in VPC
- Specified by:
getVpc
in interfaceCanaryProps
-
getVpcSubnets
Description copied from interface:CanaryProps
Where to place the network interfaces within the VPC.You must provide
vpc
when using this prop.Default: - the Vpc default strategy if not specified
- Specified by:
getVpcSubnets
in interfaceCanaryProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-