Package software.amazon.awssdk.services.synthetics.model

Interface UpdateCanaryRequest.Builder

    • Method Detail

      • name

        UpdateCanaryRequest.Builder name​(String name)

        The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

        You cannot change the name of a canary that has already been created.

        Parameters:
        name - The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

        You cannot change the name of a canary that has already been created.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • code

        UpdateCanaryRequest.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.

      • executionRoleArn

        UpdateCanaryRequest.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:CreateLogStream

        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:CreateLogStream

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • runtimeVersion

        UpdateCanaryRequest.Builder runtimeVersion​(String runtimeVersion)

        Specifies the runtime version to use for the canary. For a list of valid runtime versions and for 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 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.

      • schedule

        UpdateCanaryRequest.Builder schedule​(CanaryScheduleInput 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.

      • runConfig

        UpdateCanaryRequest.Builder runConfig​(CanaryRunConfigInput runConfig)

        A structure that contains the timeout value that is used for each individual run of the canary.

        The environment variables keys and values are not encrypted. Do not store sensitive information in this field.

        Parameters:
        runConfig - A structure that contains the timeout value that is used for each individual run of the canary.

        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.

      • successRetentionPeriodInDays

        UpdateCanaryRequest.Builder successRetentionPeriodInDays​(Integer 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

        UpdateCanaryRequest.Builder failureRetentionPeriodInDays​(Integer 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.

      • vpcConfig

        UpdateCanaryRequest.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.

      • visualReference

        UpdateCanaryRequest.Builder visualReference​(VisualReferenceInput visualReference)

        Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.

        Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

        Parameters:
        visualReference - Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.

        Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • artifactS3Location

        UpdateCanaryRequest.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.

      • artifactConfig

        UpdateCanaryRequest.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.