Package com.pulumi.aws.synthetics

Class CanaryArgs.Builder

  • Enclosing class:
    CanaryArgs
    public static final class CanaryArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

      • Builder

        public Builder​(CanaryArgs defaults)

    • Method Detail

      • artifactConfig

        public CanaryArgs.Builder artifactConfig​(@Nullable
                                         com.pulumi.core.Output<CanaryArtifactConfigArgs> artifactConfig)
        Parameters:
        artifactConfig - configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.
        Returns:
        builder

      • artifactConfig

        public CanaryArgs.Builder artifactConfig​(CanaryArtifactConfigArgs artifactConfig)
        Parameters:
        artifactConfig - configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.
        Returns:
        builder

      • artifactS3Location

        public CanaryArgs.Builder artifactS3Location​(com.pulumi.core.Output<java.lang.String> artifactS3Location)
        Parameters:
        artifactS3Location - Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
        Returns:
        builder

      • artifactS3Location

        public CanaryArgs.Builder artifactS3Location​(java.lang.String artifactS3Location)
        Parameters:
        artifactS3Location - Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
        Returns:
        builder

      • deleteLambda

        public CanaryArgs.Builder deleteLambda​(@Nullable
                                       com.pulumi.core.Output<java.lang.Boolean> deleteLambda)
        Parameters:
        deleteLambda - Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.
        Returns:
        builder

      • deleteLambda

        public CanaryArgs.Builder deleteLambda​(java.lang.Boolean deleteLambda)
        Parameters:
        deleteLambda - Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.
        Returns:
        builder

      • executionRoleArn

        public CanaryArgs.Builder executionRoleArn​(com.pulumi.core.Output<java.lang.String> executionRoleArn)
        Parameters:
        executionRoleArn - ARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.
        Returns:
        builder

      • executionRoleArn

        public CanaryArgs.Builder executionRoleArn​(java.lang.String executionRoleArn)
        Parameters:
        executionRoleArn - ARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.
        Returns:
        builder

      • failureRetentionPeriod

        public CanaryArgs.Builder failureRetentionPeriod​(@Nullable
                                                 com.pulumi.core.Output<java.lang.Integer> failureRetentionPeriod)
        Parameters:
        failureRetentionPeriod - 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:
        builder

      • failureRetentionPeriod

        public CanaryArgs.Builder failureRetentionPeriod​(java.lang.Integer failureRetentionPeriod)
        Parameters:
        failureRetentionPeriod - 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:
        builder

      • handler

        public CanaryArgs.Builder handler​(com.pulumi.core.Output<java.lang.String> handler)
        Parameters:
        handler - Entry point to use for the source code when running the canary. This value must end with the string `.handler` .
        Returns:
        builder

      • handler

        public CanaryArgs.Builder handler​(java.lang.String handler)
        Parameters:
        handler - Entry point to use for the source code when running the canary. This value must end with the string `.handler` .
        Returns:
        builder

      • kmsKeyArn

        public CanaryArgs.Builder kmsKeyArn​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> kmsKeyArn)
        Parameters:
        kmsKeyArn - ARN of the customer-managed KMS key used to encrypt the environment variables of the canary's Lambda function at rest. If omitted, an AWS owned key is used. Note that this is distinct from `artifact_config.s3_encryption.kms_key_arn`, which encrypts the artifacts the canary uploads to Amazon S3.
        Returns:
        builder

      • kmsKeyArn

        public CanaryArgs.Builder kmsKeyArn​(java.lang.String kmsKeyArn)
        Parameters:
        kmsKeyArn - ARN of the customer-managed KMS key used to encrypt the environment variables of the canary's Lambda function at rest. If omitted, an AWS owned key is used. Note that this is distinct from `artifact_config.s3_encryption.kms_key_arn`, which encrypts the artifacts the canary uploads to Amazon S3.
        Returns:
        builder

      • name

        public CanaryArgs.Builder name​(@Nullable
                               com.pulumi.core.Output<java.lang.String> name)
        Parameters:
        name - Name for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.
        Returns:
        builder

      • name

        public CanaryArgs.Builder name​(java.lang.String name)
        Parameters:
        name - Name for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.
        Returns:
        builder

      • region

        public CanaryArgs.Builder region​(@Nullable
                                 com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • region

        public CanaryArgs.Builder region​(java.lang.String region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • runConfig

        public CanaryArgs.Builder runConfig​(@Nullable
                                    com.pulumi.core.Output<CanaryRunConfigArgs> runConfig)
        Parameters:
        runConfig - Configuration block for individual canary runs. Detailed below.
        Returns:
        builder

      • runConfig

        public CanaryArgs.Builder runConfig​(CanaryRunConfigArgs runConfig)
        Parameters:
        runConfig - Configuration block for individual canary runs. Detailed below.
        Returns:
        builder

      • runtimeVersion

        public CanaryArgs.Builder runtimeVersion​(com.pulumi.core.Output<java.lang.String> runtimeVersion)
        Parameters:
        runtimeVersion - Runtime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.
        Returns:
        builder

      • runtimeVersion

        public CanaryArgs.Builder runtimeVersion​(java.lang.String runtimeVersion)
        Parameters:
        runtimeVersion - Runtime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.
        Returns:
        builder

      • s3Bucket

        public CanaryArgs.Builder s3Bucket​(@Nullable
                                   com.pulumi.core.Output<java.lang.String> s3Bucket)
        Parameters:
        s3Bucket - Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**
        Returns:
        builder

      • s3Bucket

        public CanaryArgs.Builder s3Bucket​(java.lang.String s3Bucket)
        Parameters:
        s3Bucket - Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**
        Returns:
        builder

      • s3Key

        public CanaryArgs.Builder s3Key​(@Nullable
                                com.pulumi.core.Output<java.lang.String> s3Key)
        Parameters:
        s3Key - S3 key of your script. **Conflicts with `zipFile`.**
        Returns:
        builder

      • s3Key

        public CanaryArgs.Builder s3Key​(java.lang.String s3Key)
        Parameters:
        s3Key - S3 key of your script. **Conflicts with `zipFile`.**
        Returns:
        builder

      • s3Version

        public CanaryArgs.Builder s3Version​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> s3Version)
        Parameters:
        s3Version - S3 version ID of your script. **Conflicts with `zipFile`.**
        Returns:
        builder

      • s3Version

        public CanaryArgs.Builder s3Version​(java.lang.String s3Version)
        Parameters:
        s3Version - S3 version ID of your script. **Conflicts with `zipFile`.**
        Returns:
        builder

      • schedule

        public CanaryArgs.Builder schedule​(com.pulumi.core.Output<CanaryScheduleArgs> schedule)
        Parameters:
        schedule - Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below. The following arguments are optional:
        Returns:
        builder

      • schedule

        public CanaryArgs.Builder schedule​(CanaryScheduleArgs schedule)
        Parameters:
        schedule - Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below. The following arguments are optional:
        Returns:
        builder

      • startCanary

        public CanaryArgs.Builder startCanary​(@Nullable
                                      com.pulumi.core.Output<java.lang.Boolean> startCanary)
        Parameters:
        startCanary - Whether to run or stop the canary.
        Returns:
        builder

      • startCanary

        public CanaryArgs.Builder startCanary​(java.lang.Boolean startCanary)
        Parameters:
        startCanary - Whether to run or stop the canary.
        Returns:
        builder

      • successRetentionPeriod

        public CanaryArgs.Builder successRetentionPeriod​(@Nullable
                                                 com.pulumi.core.Output<java.lang.Integer> successRetentionPeriod)
        Parameters:
        successRetentionPeriod - 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:
        builder

      • successRetentionPeriod

        public CanaryArgs.Builder successRetentionPeriod​(java.lang.Integer successRetentionPeriod)
        Parameters:
        successRetentionPeriod - 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:
        builder

      • tags

        public CanaryArgs.Builder tags​(@Nullable
                               com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
        Returns:
        builder

      • tags

        public CanaryArgs.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
        Returns:
        builder

      • vpcConfig

        public CanaryArgs.Builder vpcConfig​(@Nullable
                                    com.pulumi.core.Output<CanaryVpcConfigArgs> vpcConfig)
        Parameters:
        vpcConfig - Configuration block. Detailed below.
        Returns:
        builder

      • zipFile

        public CanaryArgs.Builder zipFile​(@Nullable
                                  com.pulumi.core.Output<java.lang.String> zipFile)
        Parameters:
        zipFile - ZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**
        Returns:
        builder

      • zipFile

        public CanaryArgs.Builder zipFile​(java.lang.String zipFile)
        Parameters:
        zipFile - ZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**
        Returns:
        builder