CanaryProps.Jsii$Proxy

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.synthetics.CanaryProps.Jsii$Proxy

All Implemented Interfaces:: CanaryProps

Enclosing interface:: CanaryProps

public static final class CanaryProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CanaryProps

An implementation for CanaryProps

Nested Class Summary
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.synthetics.CanaryProps
  CanaryProps.Builder, CanaryProps.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(java.lang.Object o)`
`ArtifactsBucketLocation`	`getArtifactsBucketLocation()` (experimental) The s3 location that stores the data of the canary runs.
`java.lang.String`	`getCanaryName()` (experimental) The name of the canary.
`java.util.Map<java.lang.String,java.lang.String>`	`getEnvironmentVariables()` (experimental) Key-value pairs that the Synthetics caches and makes available for your canary scripts.
`Duration`	`getFailureRetentionPeriod()` (experimental) How many days should failed runs be retained.
`IRole`	`getRole()` (experimental) Canary execution role.
`Runtime`	`getRuntime()` (experimental) Specify the runtime version to use for the canary.
`Schedule`	`getSchedule()` (experimental) Specify the schedule for how often the canary runs.
`java.util.List<ISecurityGroup>`	`getSecurityGroups()` (experimental) The list of security groups to associate with the canary's network interfaces.
`java.lang.Boolean`	`getStartAfterCreation()` (experimental) Whether or not the canary should start after creation.
`Duration`	`getSuccessRetentionPeriod()` (experimental) How many days should successful runs be retained.
`Test`	`getTest()` (experimental) The type of test that you want your canary to run.
`Duration`	`getTimeToLive()` (experimental) How long the canary will be in a 'RUNNING' state.
`IVpc`	`getVpc()` (experimental) The VPC where this canary is run.
`SubnetSelection`	`getVpcSubnets()` (experimental) Where to place the network interfaces within the VPC.
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.synthetics.CanaryProps
builder

- Constructor Detail
  - 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.
- Method Detail
  - getRuntime
```
public final Runtime getRuntime()
```
    Description copied from interface: CanaryProps
    
    (experimental) Specify the runtime version to use for the canary.
    
    Specified by:
    
    getRuntime in interface CanaryProps
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html
  - getTest
```
public final Test getTest()
```
    Description copied from interface: CanaryProps
    
    (experimental) The type of test that you want your canary to run.
    Use Test.custom() to specify the test to run.
    
    Specified by:
    
    getTest in interface CanaryProps
  - getArtifactsBucketLocation
```
public final ArtifactsBucketLocation getArtifactsBucketLocation()
```
    Description copied from interface: CanaryProps
    
    (experimental) 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 interface CanaryProps
  - getCanaryName
```
public final java.lang.String getCanaryName()
```
    Description copied from interface: CanaryProps
    
    (experimental) 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 interface CanaryProps
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html
  - getEnvironmentVariables
```
public final java.util.Map<java.lang.String,java.lang.String> getEnvironmentVariables()
```
    Description copied from interface: CanaryProps
    
    (experimental) 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 interface CanaryProps
  - getFailureRetentionPeriod
```
public final Duration getFailureRetentionPeriod()
```
    Description copied from interface: CanaryProps
    
    (experimental) How many days should failed runs be retained.
    Default: Duration.days(31)
    
    Specified by:
    
    getFailureRetentionPeriod in interface CanaryProps
  - getRole
```
public final IRole getRole()
```
    Description copied from interface: CanaryProps
    
    (experimental) 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 interface CanaryProps
    
    See Also:
    
    required permissions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-executionrolearn
  - getSchedule
```
public final Schedule getSchedule()
```
    Description copied from interface: CanaryProps
    
    (experimental) Specify the schedule for how often the canary runs.
    For example, if you set schedule to rate(10 minutes), then the canary will run every 10 minutes. You can set the schedule with Schedule.rate(Duration) (recommended) or you can specify an expression using Schedule.expression().
    Default: 'rate(5 minutes)'
    
    Specified by:
    
    getSchedule in interface CanaryProps
  - getSecurityGroups
```
public final java.util.List<ISecurityGroup> getSecurityGroups()
```
    Description copied from interface: CanaryProps
    
    (experimental) 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 interface CanaryProps
  - getStartAfterCreation
```
public final java.lang.Boolean getStartAfterCreation()
```
    Description copied from interface: CanaryProps
    
    (experimental) Whether or not the canary should start after creation.
    Default: true
    
    Specified by:
    
    getStartAfterCreation in interface CanaryProps
  - getSuccessRetentionPeriod
```
public final Duration getSuccessRetentionPeriod()
```
    Description copied from interface: CanaryProps
    
    (experimental) How many days should successful runs be retained.
    Default: Duration.days(31)
    
    Specified by:
    
    getSuccessRetentionPeriod in interface CanaryProps
  - getTimeToLive
```
public final Duration getTimeToLive()
```
    Description copied from interface: CanaryProps
    
    (experimental) How long the canary will be in a 'RUNNING' state.
    For example, if you set timeToLive to be 1 hour and schedule to be rate(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 interface CanaryProps
  - getVpc
```
public final IVpc getVpc()
```
    Description copied from interface: CanaryProps
    
    (experimental) 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 interface CanaryProps
  - getVpcSubnets
```
public final SubnetSelection getVpcSubnets()
```
    Description copied from interface: CanaryProps
    
    (experimental) 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 interface CanaryProps
  - $jsii$toJson
```
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
  - equals
```
public final boolean equals(java.lang.Object o)
```
  - hashCode
```
public final int hashCode()
```

Class CanaryProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.synthetics.CanaryProps

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.synthetics.CanaryProps

Constructor Detail

Jsii$Proxy

Method Detail

getRuntime

getTest

getArtifactsBucketLocation

getCanaryName

getEnvironmentVariables

getFailureRetentionPeriod

getRole

getSchedule

getSecurityGroups

getStartAfterCreation

getSuccessRetentionPeriod

getTimeToLive

getVpc

getVpcSubnets

$jsii$toJson

equals

hashCode