public static interface CreateCanaryRequest.Builder extends SyntheticsRequest.Builder, SdkPojo, CopyableBuilder<CreateCanaryRequest.Builder,CreateCanaryRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateCanaryRequest.Builder |
artifactS3Location(String artifactS3Location)
The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
|
CreateCanaryRequest.Builder |
code(CanaryCodeInput code)
A structure that includes the entry point from which the canary should start running your script.
|
default CreateCanaryRequest.Builder |
code(Consumer<CanaryCodeInput.Builder> code)
A structure that includes the entry point from which the canary should start running your script.
|
CreateCanaryRequest.Builder |
executionRoleArn(String executionRoleArn)
The ARN of the IAM role to be used to run the canary.
|
CreateCanaryRequest.Builder |
failureRetentionPeriodInDays(Integer failureRetentionPeriodInDays)
The number of days to retain data about failed runs of this canary.
|
CreateCanaryRequest.Builder |
name(String name)
The name for this canary.
|
CreateCanaryRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateCanaryRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateCanaryRequest.Builder |
runConfig(CanaryRunConfigInput runConfig)
A structure that contains the configuration for individual canary runs, such as timeout value.
|
default CreateCanaryRequest.Builder |
runConfig(Consumer<CanaryRunConfigInput.Builder> runConfig)
A structure that contains the configuration for individual canary runs, such as timeout value.
|
CreateCanaryRequest.Builder |
runtimeVersion(String runtimeVersion)
Specifies the runtime version to use for the canary.
|
CreateCanaryRequest.Builder |
schedule(CanaryScheduleInput schedule)
A structure that contains information about how often the canary is to run and when these test runs are to
stop.
|
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.
|
CreateCanaryRequest.Builder |
successRetentionPeriodInDays(Integer successRetentionPeriodInDays)
The number of days to retain data about successful runs of this canary.
|
CreateCanaryRequest.Builder |
tags(Map<String,String> tags)
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.
|
CreateCanaryRequest.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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateCanaryRequest.Builder name(String 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.
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.
CreateCanaryRequest.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.
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.default CreateCanaryRequest.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 theCanaryCodeInput.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).code - a consumer that will call methods on CanaryCodeInput.Buildercode(CanaryCodeInput)CreateCanaryRequest.Builder artifactS3Location(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.
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.CreateCanaryRequest.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:PutLogEvents
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
CreateCanaryRequest.Builder schedule(CanaryScheduleInput schedule)
A structure that contains information about how often the canary is to run and when these test runs are to stop.
schedule - A structure that contains information about how often the canary is to run and when these test runs
are to stop.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.
This is a convenience that creates an instance of theCanaryScheduleInput.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).schedule - a consumer that will call methods on CanaryScheduleInput.Builderschedule(CanaryScheduleInput)CreateCanaryRequest.Builder runConfig(CanaryRunConfigInput runConfig)
A structure that contains the configuration for individual canary runs, such as timeout value.
runConfig - A structure that contains the configuration for individual canary runs, such as timeout value.default CreateCanaryRequest.Builder runConfig(Consumer<CanaryRunConfigInput.Builder> runConfig)
A structure that contains the configuration for individual canary runs, such as timeout value.
This is a convenience that creates an instance of theCanaryRunConfigInput.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).runConfig - a consumer that will call methods on CanaryRunConfigInput.BuilderrunConfig(CanaryRunConfigInput)CreateCanaryRequest.Builder successRetentionPeriodInDays(Integer 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.
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.CreateCanaryRequest.Builder failureRetentionPeriodInDays(Integer 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.
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.CreateCanaryRequest.Builder runtimeVersion(String 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.
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.CreateCanaryRequest.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.
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.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. For more information, see Running a Canary in a VPC.
This is a convenience that creates an instance of theVpcConfigInput.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).vpcConfig - a consumer that will call methods on VpcConfigInput.BuildervpcConfig(VpcConfigInput)CreateCanaryRequest.Builder tags(Map<String,String> 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.
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.
CreateCanaryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.CreateCanaryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.