software.amazon.awssdk.services.synthetics.model

Interface Canary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Canary.Builder,Canary>, SdkBuilder<Canary.Builder,Canary>, SdkPojo

Enclosing class:

Canary

public static interface Canary.Builder
extends SdkPojo, CopyableBuilder<Canary.Builder,Canary>

Method Summary

Modifier and Type	Method and Description
Canary.Builder	artifactConfig(ArtifactConfigOutput 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.
default Canary.Builder	artifactConfig(Consumer<ArtifactConfigOutput.Builder> 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.
Canary.Builder	artifactS3Location(String artifactS3Location) The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
Canary.Builder	code(CanaryCodeOutput code) Sets the value of the Code property for this object.
default Canary.Builder	code(Consumer<CanaryCodeOutput.Builder> code) Sets the value of the Code property for this object.
Canary.Builder	engineArn(String engineArn) The ARN of the Lambda function that is used as your canary's engine.
Canary.Builder	executionRoleArn(String executionRoleArn) The ARN of the IAM role used to run the canary.
Canary.Builder	failureRetentionPeriodInDays(Integer failureRetentionPeriodInDays) The number of days to retain data about failed runs of this canary.
Canary.Builder	id(String id) The unique ID of this canary.
Canary.Builder	name(String name) The name of the canary.
Canary.Builder	runConfig(CanaryRunConfigOutput runConfig) Sets the value of the RunConfig property for this object.
default Canary.Builder	runConfig(Consumer<CanaryRunConfigOutput.Builder> runConfig) Sets the value of the RunConfig property for this object.
Canary.Builder	runtimeVersion(String runtimeVersion) Specifies the runtime version to use for the canary.
Canary.Builder	schedule(CanaryScheduleOutput schedule) A structure that contains information about how often the canary is to run, and when these runs are to stop.
default Canary.Builder	schedule(Consumer<CanaryScheduleOutput.Builder> schedule) A structure that contains information about how often the canary is to run, and when these runs are to stop.
Canary.Builder	status(CanaryStatus status) A structure that contains information about the canary's status.
default Canary.Builder	status(Consumer<CanaryStatus.Builder> status) A structure that contains information about the canary's status.
Canary.Builder	successRetentionPeriodInDays(Integer successRetentionPeriodInDays) The number of days to retain data about successful runs of this canary.
Canary.Builder	tags(Map<String,String> tags) The list of key-value pairs that are associated with the canary.
Canary.Builder	timeline(CanaryTimeline timeline) A structure that contains information about when the canary was created, modified, and most recently run.
default Canary.Builder	timeline(Consumer<CanaryTimeline.Builder> timeline) A structure that contains information about when the canary was created, modified, and most recently run.
default Canary.Builder	visualReference(Consumer<VisualReferenceOutput.Builder> visualReference) 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.
Canary.Builder	visualReference(VisualReferenceOutput visualReference) 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.
default Canary.Builder	vpcConfig(Consumer<VpcConfigOutput.Builder> vpcConfig) Sets the value of the VpcConfig property for this object.
Canary.Builder	vpcConfig(VpcConfigOutput vpcConfig) Sets the value of the VpcConfig property for this object.

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

id

Canary.Builder id(String id)

The unique ID of this canary.

Parameters:

id - The unique ID of this canary.

Returns:

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

name

Canary.Builder name(String name)

The name of the canary.

Parameters:

name - The name of the canary.

Returns:

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

code

Canary.Builder code(CanaryCodeOutput code)

Sets the value of the Code property for this object.

Parameters:

code - The new value for the Code property for this object.

Returns:

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

code

default Canary.Builder code(Consumer<CanaryCodeOutput.Builder> code)

Sets the value of the Code property for this object. This is a convenience method that creates an instance of the CanaryCodeOutput.Builder avoiding the need to create one manually via CanaryCodeOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to code(CanaryCodeOutput).

Parameters:

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

Returns:

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

See Also:

code(CanaryCodeOutput)

executionRoleArn

Canary.Builder executionRoleArn(String executionRoleArn)

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

Parameters:

executionRoleArn - The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

Returns:

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

schedule

Canary.Builder schedule(CanaryScheduleOutput 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 Canary.Builder schedule(Consumer<CanaryScheduleOutput.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 method that creates an instance of the CanaryScheduleOutput.Builder avoiding the need to create one manually via CanaryScheduleOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedule(CanaryScheduleOutput).

Parameters:

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

Returns:

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

See Also:

schedule(CanaryScheduleOutput)

runConfig

Canary.Builder runConfig(CanaryRunConfigOutput runConfig)

Sets the value of the RunConfig property for this object.

Parameters:

runConfig - The new value for the RunConfig property for this object.

Returns:

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

runConfig

default Canary.Builder runConfig(Consumer<CanaryRunConfigOutput.Builder> runConfig)

Sets the value of the RunConfig property for this object. This is a convenience method that creates an instance of the CanaryRunConfigOutput.Builder avoiding the need to create one manually via CanaryRunConfigOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to runConfig(CanaryRunConfigOutput).

Parameters:

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

Returns:

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

See Also:

runConfig(CanaryRunConfigOutput)

successRetentionPeriodInDays

Canary.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

Canary.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.

status

Canary.Builder status(CanaryStatus status)

A structure that contains information about the canary's status.

Parameters:

status - A structure that contains information about the canary's status.

Returns:

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

status

default Canary.Builder status(Consumer<CanaryStatus.Builder> status)

A structure that contains information about the canary's status.

This is a convenience method that creates an instance of the CanaryStatus.Builder avoiding the need to create one manually via CanaryStatus.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to status(CanaryStatus).

Parameters:

status - a consumer that will call methods on CanaryStatus.Builder

Returns:

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

See Also:

status(CanaryStatus)

timeline

Canary.Builder timeline(CanaryTimeline timeline)

A structure that contains information about when the canary was created, modified, and most recently run.

Parameters:

timeline - A structure that contains information about when the canary was created, modified, and most recently run.

Returns:

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

timeline

default Canary.Builder timeline(Consumer<CanaryTimeline.Builder> timeline)

A structure that contains information about when the canary was created, modified, and most recently run.

This is a convenience method that creates an instance of the CanaryTimeline.Builder avoiding the need to create one manually via CanaryTimeline.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeline(CanaryTimeline).

Parameters:

timeline - a consumer that will call methods on CanaryTimeline.Builder

Returns:

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

See Also:

timeline(CanaryTimeline)

artifactS3Location

Canary.Builder artifactS3Location(String artifactS3Location)

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Parameters:

artifactS3Location - The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Returns:

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

engineArn

Canary.Builder engineArn(String engineArn)

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

Parameters:

engineArn - The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

Returns:

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

runtimeVersion

Canary.Builder runtimeVersion(String runtimeVersion)

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

Parameters:

runtimeVersion - Specifies the runtime version to use for the canary. 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.

vpcConfig

Canary.Builder vpcConfig(VpcConfigOutput vpcConfig)

Sets the value of the VpcConfig property for this object.

Parameters:

vpcConfig - The new value for the VpcConfig property for this object.

Returns:

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

vpcConfig

default Canary.Builder vpcConfig(Consumer<VpcConfigOutput.Builder> vpcConfig)

Sets the value of the VpcConfig property for this object. This is a convenience method that creates an instance of the VpcConfigOutput.Builder avoiding the need to create one manually via VpcConfigOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfigOutput).

Parameters:

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

Returns:

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

See Also:

vpcConfig(VpcConfigOutput)

visualReference

Canary.Builder visualReference(VisualReferenceOutput visualReference)

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.

Parameters:

visualReference - 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.

Returns:

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

visualReference

default Canary.Builder visualReference(Consumer<VisualReferenceOutput.Builder> visualReference)

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.

This is a convenience method that creates an instance of the VisualReferenceOutput.Builder avoiding the need to create one manually via VisualReferenceOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to visualReference(VisualReferenceOutput).

Parameters:

visualReference - a consumer that will call methods on VisualReferenceOutput.Builder

Returns:

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

See Also:

visualReference(VisualReferenceOutput)

tags

Canary.Builder tags(Map<String,String> tags)

The list of key-value pairs that are associated with the canary.

Parameters:

tags - The list of key-value pairs that are associated with the canary.

Returns:

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

artifactConfig

Canary.Builder artifactConfig(ArtifactConfigOutput 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.

Parameters:

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:

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

artifactConfig

default Canary.Builder artifactConfig(Consumer<ArtifactConfigOutput.Builder> 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.

This is a convenience method that creates an instance of the ArtifactConfigOutput.Builder avoiding the need to create one manually via ArtifactConfigOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to artifactConfig(ArtifactConfigOutput).

Parameters:

artifactConfig - a consumer that will call methods on ArtifactConfigOutput.Builder

Returns:

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

See Also:

artifactConfig(ArtifactConfigOutput)