| Package | Description |
|---|---|
| software.amazon.awssdk.services.synthetics |
|
| software.amazon.awssdk.services.synthetics.model |
| Modifier and Type | Method and Description |
|---|---|
default CreateCanaryResponse |
SyntheticsClient.createCanary(Consumer<CreateCanaryRequest.Builder> createCanaryRequest)
Creates a canary.
|
default CompletableFuture<CreateCanaryResponse> |
SyntheticsAsyncClient.createCanary(Consumer<CreateCanaryRequest.Builder> createCanaryRequest)
Creates a canary.
|
| Modifier and Type | Method and Description |
|---|---|
CreateCanaryRequest.Builder |
CreateCanaryRequest.Builder.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.
|
default CreateCanaryRequest.Builder |
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.
|
CreateCanaryRequest.Builder |
CreateCanaryRequest.Builder.artifactS3Location(String artifactS3Location)
The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
|
static CreateCanaryRequest.Builder |
CreateCanaryRequest.builder() |
CreateCanaryRequest.Builder |
CreateCanaryRequest.Builder.code(CanaryCodeInput code)
A structure that includes the entry point from which the canary should start running your script.
|
default CreateCanaryRequest.Builder |
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 |
CreateCanaryRequest.Builder.executionRoleArn(String executionRoleArn)
The ARN of the IAM role to be used to run the canary.
|
CreateCanaryRequest.Builder |
CreateCanaryRequest.Builder.failureRetentionPeriodInDays(Integer failureRetentionPeriodInDays)
The number of days to retain data about failed runs of this canary.
|
CreateCanaryRequest.Builder |
CreateCanaryRequest.Builder.name(String name)
The name for this canary.
|
CreateCanaryRequest.Builder |
CreateCanaryRequest.Builder.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateCanaryRequest.Builder |
CreateCanaryRequest.Builder.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateCanaryRequest.Builder |
CreateCanaryRequest.Builder.runConfig(CanaryRunConfigInput runConfig)
A structure that contains the configuration for individual canary runs, such as timeout value and environment
variables.
|
default CreateCanaryRequest.Builder |
CreateCanaryRequest.Builder.runConfig(Consumer<CanaryRunConfigInput.Builder> runConfig)
A structure that contains the configuration for individual canary runs, such as timeout value and environment
variables.
|
CreateCanaryRequest.Builder |
CreateCanaryRequest.Builder.runtimeVersion(String runtimeVersion)
Specifies the runtime version to use for the canary.
|
CreateCanaryRequest.Builder |
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 |
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 |
CreateCanaryRequest.Builder.successRetentionPeriodInDays(Integer successRetentionPeriodInDays)
The number of days to retain data about successful runs of this canary.
|
CreateCanaryRequest.Builder |
CreateCanaryRequest.Builder.tags(Map<String,String> tags)
A list of key-value pairs to associate with the canary.
|
CreateCanaryRequest.Builder |
CreateCanaryRequest.toBuilder() |
default CreateCanaryRequest.Builder |
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 |
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.
|
| Modifier and Type | Method and Description |
|---|---|
static Class<? extends CreateCanaryRequest.Builder> |
CreateCanaryRequest.serializableBuilderClass() |
Copyright © 2023. All rights reserved.