All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateCanaryRequest.Builder,CreateCanaryRequest>, SdkBuilder<CreateCanaryRequest.Builder,CreateCanaryRequest>, SdkPojo, SdkRequest.Builder, SyntheticsRequest.Builder

Enclosing class:

CreateCanaryRequest
```
public static interface CreateCanaryRequest.Builder
extends SyntheticsRequest.Builder, SdkPojo, CopyableBuilder<CreateCanaryRequest.Builder,CreateCanaryRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`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.
`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.
`CreateCanaryRequest.Builder`	`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.
`CreateCanaryRequest.Builder`	`code(CanaryCodeInput 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(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`CreateCanaryRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`CreateCanaryRequest.Builder`	`provisionedResourceCleanup(String provisionedResourceCleanup)`	Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.
`CreateCanaryRequest.Builder`	`provisionedResourceCleanup(ProvisionedResourceCleanupSetting provisionedResourceCleanup)`	Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.
`CreateCanaryRequest.Builder`	`resourcesToReplicateTags(Collection<ResourceToTag> resourcesToReplicateTags)`	To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value `lambda-function`.
`CreateCanaryRequest.Builder`	`resourcesToReplicateTags(ResourceToTag... resourcesToReplicateTags)`	To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value `lambda-function`.
`CreateCanaryRequest.Builder`	`resourcesToReplicateTagsWithStrings(String... resourcesToReplicateTags)`	To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value `lambda-function`.
`CreateCanaryRequest.Builder`	`resourcesToReplicateTagsWithStrings(Collection<String> resourcesToReplicateTags)`	To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value `lambda-function`.
`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.
`CreateCanaryRequest.Builder`	`runConfig(CanaryRunConfigInput runConfig)`	A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.
`CreateCanaryRequest.Builder`	`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.
`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.
`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.

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, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.synthetics.model.SyntheticsRequest.Builder
build

- Method Detail
  - name
```
CreateCanaryRequest.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.
    
    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
```
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.
    
    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
```
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 method that creates an instance of the CanaryCodeInput.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).
    
    Parameters:
    
    code - a consumer that will call methods on CanaryCodeInput.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    code(CanaryCodeInput)
  - artifactS3Location
```
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. 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
```
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
    Parameters:
    
    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
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - schedule
```
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.
    
    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
```
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 method that creates an instance of the CanaryScheduleInput.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).
    
    Parameters:
    
    schedule - a consumer that will call methods on CanaryScheduleInput.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    schedule(CanaryScheduleInput)
  - runConfig
```
CreateCanaryRequest.Builder runConfig(CanaryRunConfigInput 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
```
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.
    
    The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
    This is a convenience method that creates an instance of the CanaryRunConfigInput.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).
    
    Parameters:
    
    runConfig - a consumer that will call methods on CanaryRunConfigInput.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    runConfig(CanaryRunConfigInput)
  - successRetentionPeriodInDays
```
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.
    
    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
```
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.
    
    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
```
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.
    
    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
```
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.
    
    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
```
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 method that creates an instance of the VpcConfigInput.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).
    
    Parameters:
    
    vpcConfig - a consumer that will call methods on VpcConfigInput.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    vpcConfig(VpcConfigInput)
  - resourcesToReplicateTagsWithStrings
```
CreateCanaryRequest.Builder resourcesToReplicateTagsWithStrings(Collection<String> resourcesToReplicateTags)
```
    To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.
    
    If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.
    
    Parameters:
    
    resourcesToReplicateTags - To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.
    
    If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - resourcesToReplicateTagsWithStrings
```
CreateCanaryRequest.Builder resourcesToReplicateTagsWithStrings(String... resourcesToReplicateTags)
```
    To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.
    
    If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.
    
    Parameters:
    
    resourcesToReplicateTags - To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.
    
    If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - resourcesToReplicateTags
```
CreateCanaryRequest.Builder resourcesToReplicateTags(Collection<ResourceToTag> resourcesToReplicateTags)
```
    To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.
    
    If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.
    
    Parameters:
    
    resourcesToReplicateTags - To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.
    
    If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - resourcesToReplicateTags
```
CreateCanaryRequest.Builder resourcesToReplicateTags(ResourceToTag... resourcesToReplicateTags)
```
    To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.
    
    If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.
    
    Parameters:
    
    resourcesToReplicateTags - To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.
    
    If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - provisionedResourceCleanup
```
CreateCanaryRequest.Builder provisionedResourceCleanup(String provisionedResourceCleanup)
```
    Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted.
    
    If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
    
    Parameters:
    
    provisionedResourceCleanup - Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted.
    
    If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProvisionedResourceCleanupSetting, ProvisionedResourceCleanupSetting
  - provisionedResourceCleanup
```
CreateCanaryRequest.Builder provisionedResourceCleanup(ProvisionedResourceCleanupSetting provisionedResourceCleanup)
```
    Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted.
    
    If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
    
    Parameters:
    
    provisionedResourceCleanup - Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted.
    
    If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProvisionedResourceCleanupSetting, ProvisionedResourceCleanupSetting
  - tags
```
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.
    
    To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.
    
    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.
    
    To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - artifactConfig
```
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.
    
    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 the ArtifactConfigInput.Builder avoiding the need to create one manually via ArtifactConfigInput.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to artifactConfig(ArtifactConfigInput).
    
    Parameters:
    
    artifactConfig - a consumer that will call methods on ArtifactConfigInput.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    artifactConfig(ArtifactConfigInput)
  - overrideConfiguration
```
CreateCanaryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
CreateCanaryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface CreateCanaryRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.services.synthetics.model.SyntheticsRequest.Builder

Method Detail

name

code

code

artifactS3Location

executionRoleArn

schedule

schedule

runConfig

runConfig

successRetentionPeriodInDays

failureRetentionPeriodInDays

runtimeVersion

vpcConfig

vpcConfig

resourcesToReplicateTagsWithStrings

resourcesToReplicateTagsWithStrings

resourcesToReplicateTags

resourcesToReplicateTags

provisionedResourceCleanup

provisionedResourceCleanup

tags

artifactConfig

artifactConfig

overrideConfiguration

overrideConfiguration