java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.synthetics.model.SyntheticsRequest
    - - software.amazon.awssdk.services.synthetics.model.UpdateCanaryRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateCanaryRequest.Builder,UpdateCanaryRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateCanaryRequest
extends SyntheticsRequest
implements ToCopyableBuilder<UpdateCanaryRequest.Builder,UpdateCanaryRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateCanaryRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ArtifactConfigInput`	`artifactConfig()`	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`	`artifactS3Location()`	The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
`static UpdateCanaryRequest.Builder`	`builder()`
`CanaryCodeInput`	`code()`	A structure that includes the entry point from which the canary should start running your script.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionRoleArn()`	The ARN of the IAM role to be used to run the canary.
`Integer`	`failureRetentionPeriodInDays()`	The number of days to retain data about failed runs of this canary.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`name()`	The name of the canary that you want to update.
`CanaryRunConfigInput`	`runConfig()`	A structure that contains the timeout value that is used for each individual run of the canary.
`String`	`runtimeVersion()`	Specifies the runtime version to use for the canary.
`CanaryScheduleInput`	`schedule()`	A structure that contains information about how often the canary is to run, and when these runs are to stop.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateCanaryRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`successRetentionPeriodInDays()`	The number of days to retain data about successful runs of this canary.
`UpdateCanaryRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`VisualReferenceInput`	`visualReference()`	Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary.
`VpcConfigInput`	`vpcConfig()`	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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.
    
    You cannot change the name of a canary that has already been created.
    
    Returns:
    
    The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.
    
    You cannot change the name of a canary that has already been created.
  - code
```
public final CanaryCodeInput code()
```
    A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.
    
    Returns:
    
    A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.
  - executionRoleArn
```
public final String executionRoleArn()
```
    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:CreateLogStream
    Returns:
    
    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:CreateLogStream
  - runtimeVersion
```
public final String runtimeVersion()
```
    Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.
    
    Returns:
    
    Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.
  - schedule
```
public final CanaryScheduleInput schedule()
```
    A structure that contains information about how often the canary is to run, and when these runs are to stop.
    
    Returns:
    
    A structure that contains information about how often the canary is to run, and when these runs are to stop.
  - runConfig
```
public final CanaryRunConfigInput runConfig()
```
    A structure that contains the timeout value that is used for each individual run of the canary.
    
    The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
    
    Returns:
    
    A structure that contains the timeout value that is used for each individual run of the canary.
    
    The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
  - successRetentionPeriodInDays
```
public final Integer successRetentionPeriodInDays()
```
    The number of days to retain data about successful runs of this canary.
    
    Returns:
    
    The number of days to retain data about successful runs of this canary.
  - failureRetentionPeriodInDays
```
public final Integer failureRetentionPeriodInDays()
```
    The number of days to retain data about failed runs of this canary.
    
    Returns:
    
    The number of days to retain data about failed runs of this canary.
  - vpcConfig
```
public final VpcConfigInput vpcConfig()
```
    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.
    
    Returns:
    
    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.
  - visualReference
```
public final VisualReferenceInput visualReference()
```
    Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.
    
    Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint
    
    Returns:
    
    Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.
    
    Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint
  - artifactS3Location
```
public final String artifactS3Location()
```
    The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).
    
    Returns:
    
    The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).
  - artifactConfig
```
public final ArtifactConfigInput artifactConfig()
```
    A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
    
    Returns:
    
    A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
  - toBuilder
```
public UpdateCanaryRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateCanaryRequest.Builder,UpdateCanaryRequest>
    
    Specified by:
    
    toBuilder in class SyntheticsRequest
  - builder
```
public static UpdateCanaryRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateCanaryRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateCanaryRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

code

executionRoleArn

runtimeVersion

schedule

runConfig

successRetentionPeriodInDays

failureRetentionPeriodInDays

vpcConfig

visualReference

artifactS3Location

artifactConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields