Interface Canary.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Canary.Builder,
,Canary> SdkBuilder<Canary.Builder,
,Canary> SdkPojo
- Enclosing class:
Canary
-
Method Summary
Modifier and TypeMethodDescriptiondefault 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.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.artifactS3Location
(String artifactS3Location) The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.default Canary.Builder
code
(Consumer<CanaryCodeOutput.Builder> code) Sets the value of the Code property for this object.code
(CanaryCodeOutput code) Sets the value of the Code property for this object.The ARN of the Lambda function that is used as your canary's engine.executionRoleArn
(String executionRoleArn) The ARN of the IAM role used to run the canary.failureRetentionPeriodInDays
(Integer failureRetentionPeriodInDays) The number of days to retain data about failed runs of this canary.The unique ID of this canary.The name of the canary.default Canary.Builder
runConfig
(Consumer<CanaryRunConfigOutput.Builder> runConfig) Sets the value of the RunConfig property for this object.runConfig
(CanaryRunConfigOutput runConfig) Sets the value of the RunConfig property for this object.runtimeVersion
(String runtimeVersion) Specifies the runtime version to use for the canary.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.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
status
(Consumer<CanaryStatus.Builder> status) A structure that contains information about the canary's status.status
(CanaryStatus status) A structure that contains information about the canary's status.successRetentionPeriodInDays
(Integer successRetentionPeriodInDays) The number of days to retain data about successful runs of this canary.The list of key-value pairs that are associated with the canary.default Canary.Builder
timeline
(Consumer<CanaryTimeline.Builder> timeline) A structure that contains information about when the canary was created, modified, and most recently run.timeline
(CanaryTimeline 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.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.vpcConfig
(VpcConfigOutput vpcConfig) Sets the value of the VpcConfig property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
Sets the value of the Code property for this object. This is a convenience method that creates an instance of theCanaryCodeOutput.Builder
avoiding the need to create one manually viaCanaryCodeOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocode(CanaryCodeOutput)
.- Parameters:
code
- a consumer that will call methods onCanaryCodeOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 includelambda.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
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
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 theCanaryScheduleOutput.Builder
avoiding the need to create one manually viaCanaryScheduleOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toschedule(CanaryScheduleOutput)
.- Parameters:
schedule
- a consumer that will call methods onCanaryScheduleOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Sets the value of the RunConfig property for this object. This is a convenience method that creates an instance of theCanaryRunConfigOutput.Builder
avoiding the need to create one manually viaCanaryRunConfigOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torunConfig(CanaryRunConfigOutput)
.- Parameters:
runConfig
- a consumer that will call methods onCanaryRunConfigOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
A structure that contains information about the canary's status.
This is a convenience method that creates an instance of theCanaryStatus.Builder
avoiding the need to create one manually viaCanaryStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatus(CanaryStatus)
.- Parameters:
status
- a consumer that will call methods onCanaryStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theCanaryTimeline.Builder
avoiding the need to create one manually viaCanaryTimeline.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimeline(CanaryTimeline)
.- Parameters:
timeline
- a consumer that will call methods onCanaryTimeline.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
Sets the value of the VpcConfig property for this object. This is a convenience method that creates an instance of theVpcConfigOutput.Builder
avoiding the need to create one manually viaVpcConfigOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcConfig(VpcConfigOutput)
.- Parameters:
vpcConfig
- a consumer that will call methods onVpcConfigOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theVisualReferenceOutput.Builder
avoiding the need to create one manually viaVisualReferenceOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovisualReference(VisualReferenceOutput)
.- Parameters:
visualReference
- a consumer that will call methods onVisualReferenceOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theArtifactConfigOutput.Builder
avoiding the need to create one manually viaArtifactConfigOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toartifactConfig(ArtifactConfigOutput)
.- Parameters:
artifactConfig
- a consumer that will call methods onArtifactConfigOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-