software.amazon.awssdk.services.synthetics.model

Interface UpdateCanaryRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateCanaryRequest.Builder,UpdateCanaryRequest>, SdkBuilder<UpdateCanaryRequest.Builder,UpdateCanaryRequest>, SdkPojo, SdkRequest.Builder, SyntheticsRequest.Builder

Enclosing class:

UpdateCanaryRequest

public static interface UpdateCanaryRequest.Builder
extends SyntheticsRequest.Builder, SdkPojo, CopyableBuilder<UpdateCanaryRequest.Builder,UpdateCanaryRequest>

Method Summary

Modifier and Type	Method and Description
UpdateCanaryRequest.Builder	code(CanaryCodeInput code) A structure that includes the entry point from which the canary should start running your script.
default UpdateCanaryRequest.Builder	code(Consumer<CanaryCodeInput.Builder> code) A structure that includes the entry point from which the canary should start running your script.
UpdateCanaryRequest.Builder	executionRoleArn(String executionRoleArn) The ARN of the IAM role to be used to run the canary.
UpdateCanaryRequest.Builder	failureRetentionPeriodInDays(Integer failureRetentionPeriodInDays) The number of days to retain data about failed runs of this canary.
UpdateCanaryRequest.Builder	name(String name) The name of the canary that you want to update.
UpdateCanaryRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateCanaryRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateCanaryRequest.Builder	runConfig(CanaryRunConfigInput runConfig) A structure that contains the timeout value that is used for each individual run of the canary.
default UpdateCanaryRequest.Builder	runConfig(Consumer<CanaryRunConfigInput.Builder> runConfig) A structure that contains the timeout value that is used for each individual run of the canary.
UpdateCanaryRequest.Builder	runtimeVersion(String runtimeVersion) Specifies the runtime version to use for the canary.
UpdateCanaryRequest.Builder	schedule(CanaryScheduleInput schedule) A structure that contains information about how often the canary is to run, and when these runs are to stop.
default UpdateCanaryRequest.Builder	schedule(Consumer<CanaryScheduleInput.Builder> schedule) A structure that contains information about how often the canary is to run, and when these runs are to stop.
UpdateCanaryRequest.Builder	successRetentionPeriodInDays(Integer successRetentionPeriodInDays) The number of days to retain data about successful runs of this canary.
default UpdateCanaryRequest.Builder	vpcConfig(Consumer<VpcConfigInput.Builder> 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.
UpdateCanaryRequest.Builder	vpcConfig(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 interface software.amazon.awssdk.services.synthetics.model.SyntheticsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

UpdateCanaryRequest.Builder name(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

code

UpdateCanaryRequest.Builder code(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

code

default UpdateCanaryRequest.Builder code(Consumer<CanaryCodeInput.Builder> 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.

This is a convenience that creates an instance of the CanaryCodeInput.Builder avoiding the need to create one manually via CanaryCodeInput.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to code(CanaryCodeInput).

Parameters:

code - a consumer that will call methods on CanaryCodeInput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

code(CanaryCodeInput)

executionRoleArn

UpdateCanaryRequest.Builder executionRoleArn(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

runtimeVersion

UpdateCanaryRequest.Builder runtimeVersion(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

schedule

UpdateCanaryRequest.Builder schedule(CanaryScheduleInput schedule)

A structure that contains information about how often the canary is to run, and when these runs are to stop.

Parameters:

schedule - A structure that contains information about how often the canary is to run, and when these runs are to stop.

Returns:

Returns a reference to this object so that method calls can be chained together.

schedule

default UpdateCanaryRequest.Builder schedule(Consumer<CanaryScheduleInput.Builder> schedule)

A structure that contains information about how often the canary is to run, and when these runs are to stop.

This is a convenience that creates an instance of the CanaryScheduleInput.Builder avoiding the need to create one manually via CanaryScheduleInput.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedule(CanaryScheduleInput).

Parameters:

schedule - a consumer that will call methods on CanaryScheduleInput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

schedule(CanaryScheduleInput)

runConfig

UpdateCanaryRequest.Builder runConfig(CanaryRunConfigInput runConfig)

A structure that contains the timeout value that is used for each individual run of the canary.

Parameters:

runConfig - A structure that contains the timeout value that is used for each individual run of the canary.

Returns:

Returns a reference to this object so that method calls can be chained together.

runConfig

default UpdateCanaryRequest.Builder runConfig(Consumer<CanaryRunConfigInput.Builder> runConfig)

A structure that contains the timeout value that is used for each individual run of the canary.

This is a convenience that creates an instance of the CanaryRunConfigInput.Builder avoiding the need to create one manually via CanaryRunConfigInput.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to runConfig(CanaryRunConfigInput).

Parameters:

runConfig - a consumer that will call methods on CanaryRunConfigInput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

runConfig(CanaryRunConfigInput)

successRetentionPeriodInDays

UpdateCanaryRequest.Builder successRetentionPeriodInDays(Integer successRetentionPeriodInDays)

The number of days to retain data about successful runs of this canary.

Parameters:

successRetentionPeriodInDays - The number of days to retain data about successful runs of this canary.

Returns:

Returns a reference to this object so that method calls can be chained together.

failureRetentionPeriodInDays

UpdateCanaryRequest.Builder failureRetentionPeriodInDays(Integer failureRetentionPeriodInDays)

The number of days to retain data about failed runs of this canary.

Parameters:

failureRetentionPeriodInDays - The number of days to retain data about failed runs of this canary.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcConfig

UpdateCanaryRequest.Builder vpcConfig(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

vpcConfig

default UpdateCanaryRequest.Builder vpcConfig(Consumer<VpcConfigInput.Builder> 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.

This is a convenience that creates an instance of the VpcConfigInput.Builder avoiding the need to create one manually via VpcConfigInput.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfigInput).

Parameters:

vpcConfig - a consumer that will call methods on VpcConfigInput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

vpcConfig(VpcConfigInput)

overrideConfiguration

UpdateCanaryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateCanaryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder