Interface CreateCanaryRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateCanaryRequest.Builder,
,CreateCanaryRequest> SdkBuilder<CreateCanaryRequest.Builder,
,CreateCanaryRequest> SdkPojo
,SdkRequest.Builder
,SyntheticsRequest.Builder
- Enclosing class:
CreateCanaryRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault CreateCanaryRequest.Builder
artifactConfig
(Consumer<ArtifactConfigInput.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
(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.artifactS3Location
(String artifactS3Location) The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.default CreateCanaryRequest.Builder
code
(Consumer<CanaryCodeInput.Builder> code) A structure that includes the entry point from which the canary should start running your script.code
(CanaryCodeInput code) A structure that includes the entry point from which the canary should start running your script.executionRoleArn
(String executionRoleArn) The ARN of the IAM role to be used to run the canary.failureRetentionPeriodInDays
(Integer failureRetentionPeriodInDays) The number of days to retain data about failed runs of this canary.The name for this canary.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default CreateCanaryRequest.Builder
runConfig
(Consumer<CanaryRunConfigInput.Builder> runConfig) A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.runConfig
(CanaryRunConfigInput runConfig) A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.runtimeVersion
(String runtimeVersion) Specifies the runtime version to use for the canary.default CreateCanaryRequest.Builder
schedule
(Consumer<CanaryScheduleInput.Builder> schedule) A structure that contains information about how often the canary is to run and when these test runs are to stop.schedule
(CanaryScheduleInput schedule) A structure that contains information about how often the canary is to run and when these test runs are to stop.successRetentionPeriodInDays
(Integer successRetentionPeriodInDays) The number of days to retain data about successful runs of this canary.A list of key-value pairs to associate with the canary.default CreateCanaryRequest.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.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.awscore.AwsRequest.Builder
overrideConfiguration
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
Methods inherited from interface software.amazon.awssdk.services.synthetics.model.SyntheticsRequest.Builder
build
-
Method Details
-
name
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.
- Parameters:
name
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 method that creates an instance of theCanaryCodeInput.Builder
avoiding the need to create one manually viaCanaryCodeInput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocode(CanaryCodeInput)
.- Parameters:
code
- a consumer that will call methods onCanaryCodeInput.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 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 (.).
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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:PutLogEvents
- Parameters:
executionRoleArn
- The ARN of the IAM role to be used to run the canary. This role must already exist, and must includelambda.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
-
- 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 test runs are to stop.
- Parameters:
schedule
- A structure that contains information about how often the canary is to run and when these test 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 test runs are to stop.
This is a convenience method that creates an instance of theCanaryScheduleInput.Builder
avoiding the need to create one manually viaCanaryScheduleInput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toschedule(CanaryScheduleInput)
.- Parameters:
schedule
- a consumer that will call methods onCanaryScheduleInput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
runConfig
A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
- Parameters:
runConfig
- A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
runConfig
A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
CanaryRunConfigInput.Builder
avoiding the need to create one manually viaCanaryRunConfigInput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torunConfig(CanaryRunConfigInput)
.- Parameters:
runConfig
- a consumer that will call methods onCanaryRunConfigInput.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. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
- Parameters:
successRetentionPeriodInDays
- 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.- 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. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
- Parameters:
failureRetentionPeriodInDays
- 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.- 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 a list of valid runtime versions and 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 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
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
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 method that creates an instance of theVpcConfigInput.Builder
avoiding the need to create one manually viaVpcConfigInput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcConfig(VpcConfigInput)
.- Parameters:
vpcConfig
- a consumer that will call methods onVpcConfigInput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.
- Parameters:
tags
- A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.
- 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
default CreateCanaryRequest.Builder artifactConfig(Consumer<ArtifactConfigInput.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 theArtifactConfigInput.Builder
avoiding the need to create one manually viaArtifactConfigInput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toartifactConfig(ArtifactConfigInput)
.- Parameters:
artifactConfig
- a consumer that will call methods onArtifactConfigInput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateCanaryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateCanaryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-