CfnCanaryProps.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

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

All Implemented Interfaces:: CfnCanaryProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: CfnCanaryProps

@Stability(value=Stable)
 @Internal
public static final class CfnCanaryProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnCanaryProps

An implementation for CfnCanaryProps

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.CfnCanaryProps
  CfnCanaryProps.Builder, CfnCanaryProps.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(CfnCanaryProps.Builder builder)` Constructor that initializes the object based on literal property values passed by the `CfnCanaryProps.Builder`.
`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(Object o)`
`Object`	`getArtifactConfig()` A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
`String`	`getArtifactS3Location()` The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
`Object`	`getCode()` Use this structure to input your script code for the canary.
`Object`	`getDeleteLambdaResourcesOnCanaryDeletion()` Specifies whether AWS CloudFormation is to also delete the Lambda functions and layers used by this canary, when the canary is deleted.
`String`	`getExecutionRoleArn()` The ARN of the IAM role to be used to run the canary.
`Number`	`getFailureRetentionPeriod()` The number of days to retain data about failed runs of this canary.
`String`	`getName()` The name for this canary.
`Object`	`getRunConfig()` A structure that contains input information for a canary run.
`String`	`getRuntimeVersion()` Specifies the runtime version to use for the canary.
`Object`	`getSchedule()` A structure that contains information about how often the canary is to run, and when these runs are to stop.
`Object`	`getStartCanaryAfterCreation()` Specify TRUE to have the canary start making runs immediately after it is created.
`Number`	`getSuccessRetentionPeriod()` The number of days to retain data about successful runs of this canary.
`List<CfnTag>`	`getTags()` The list of key-value pairs that are associated with the canary.
`Object`	`getVisualReference()` If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.
`Object`	`getVpcConfig()` If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint.
`int`	`hashCode()`

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

Methods inherited from interface software.amazon.awscdk.services.synthetics.CfnCanaryProps
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.
  - Jsii$Proxy
```
protected Jsii$Proxy(CfnCanaryProps.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the CfnCanaryProps.Builder.
- Method Detail
  - getArtifactS3Location
```
public final String getArtifactS3Location()
```
    Description copied from interface: CfnCanaryProps
    
    The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
    Artifacts include the log file, screenshots, and HAR files. Specify the full location path, including s3:// at the beginning of the path.
    
    Specified by:
    
    getArtifactS3Location in interface CfnCanaryProps
  - getCode
```
public final Object getCode()
```
    Description copied from interface: CfnCanaryProps
    
    Use this structure to input your script code for the canary.
    This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script is passed into the canary directly, the script code is contained in the value of Script .
    
    Specified by:
    
    getCode in interface CfnCanaryProps
  - getExecutionRoleArn
```
public final String getExecutionRoleArn()
```
    Description copied from interface: CfnCanaryProps
    The ARN of the IAM role to be used to run the canary.
    This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:
    - s3:PutObject
    - s3:GetBucketLocation
    - s3:ListAllMyBuckets
    - cloudwatch:PutMetricData
    - logs:CreateLogGroup
    - logs:CreateLogStream
    - logs:PutLogEvents
    Specified by:
    
    getExecutionRoleArn in interface CfnCanaryProps
  - getName
```
public final String getName()
```
    Description copied from interface: CfnCanaryProps
    
    The name for this 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 names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries .
    
    Specified by:
    
    getName in interface CfnCanaryProps
  - getRuntimeVersion
```
public final String getRuntimeVersion()
```
    Description copied from interface: CfnCanaryProps
    
    Specifies the runtime version to use for the canary.
    For more information about runtime versions, see Canary Runtime Versions .
    
    Specified by:
    
    getRuntimeVersion in interface CfnCanaryProps
  - getSchedule
```
public final Object getSchedule()
```
    Description copied from interface: CfnCanaryProps
    
    A structure that contains information about how often the canary is to run, and when these runs are to stop.
    
    Specified by:
    
    getSchedule in interface CfnCanaryProps
  - getStartCanaryAfterCreation
```
public final Object getStartCanaryAfterCreation()
```
    Description copied from interface: CfnCanaryProps
    
    Specify TRUE to have the canary start making runs immediately after it is created.
    A canary that you create using CloudFormation can't be used to monitor the CloudFormation stack that creates the canary or to roll back that stack if there is a failure.
    
    Specified by:
    
    getStartCanaryAfterCreation in interface CfnCanaryProps
  - getArtifactConfig
```
public final Object getArtifactConfig()
```
    Description copied from interface: CfnCanaryProps
    
    A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
    
    Specified by:
    
    getArtifactConfig in interface CfnCanaryProps
  - getDeleteLambdaResourcesOnCanaryDeletion
```
public final Object getDeleteLambdaResourcesOnCanaryDeletion()
```
    Description copied from interface: CfnCanaryProps
    
    Specifies whether AWS CloudFormation is to also delete the Lambda functions and layers used by this canary, when the canary is deleted.
    The default is false.
    
    Specified by:
    
    getDeleteLambdaResourcesOnCanaryDeletion in interface CfnCanaryProps
  - getFailureRetentionPeriod
```
public final Number getFailureRetentionPeriod()
```
    Description copied from interface: CfnCanaryProps
    
    The number of days to retain data about failed runs of this canary.
    If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
    
    Specified by:
    
    getFailureRetentionPeriod in interface CfnCanaryProps
  - getRunConfig
```
public final Object getRunConfig()
```
    Description copied from interface: CfnCanaryProps
    
    A structure that contains input information for a canary run.
    If you omit this structure, the frequency of the canary is used as canary's timeout value, up to a maximum of 900 seconds.
    
    Specified by:
    
    getRunConfig in interface CfnCanaryProps
  - getSuccessRetentionPeriod
```
public final Number getSuccessRetentionPeriod()
```
    Description copied from interface: CfnCanaryProps
    
    The number of days to retain data about successful runs of this canary.
    If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
    
    Specified by:
    
    getSuccessRetentionPeriod in interface CfnCanaryProps
  - getTags
```
public final List<CfnTag> getTags()
```
    Description copied from interface: CfnCanaryProps
    
    The list of key-value pairs that are associated with the canary.
    
    Specified by:
    
    getTags in interface CfnCanaryProps
  - getVisualReference
```
public final Object getVisualReference()
```
    Description copied from interface: CfnCanaryProps
    
    If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.
    
    Specified by:
    
    getVisualReference in interface CfnCanaryProps
  - getVpcConfig
```
public final Object getVpcConfig()
```
    Description copied from interface: CfnCanaryProps
    
    If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint.
    For more information, see Running a Canary in a VPC .
    
    Specified by:
    
    getVpcConfig in interface CfnCanaryProps
  - $jsii$toJson
```
@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
    Specified by:
    
    $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class CfnCanaryProps.Jsii$Proxy

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getArtifactS3Location

getCode

getExecutionRoleArn

getName

getRuntimeVersion

getSchedule

getStartCanaryAfterCreation

getArtifactConfig

getDeleteLambdaResourcesOnCanaryDeletion

getFailureRetentionPeriod

getRunConfig

getSuccessRetentionPeriod

getTags

getVisualReference

getVpcConfig

$jsii$toJson

equals

hashCode