Package com.pulumi.aws.synthetics.inputs

Class CanaryState.Builder

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

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • arn

        public CanaryState.Builder arn​(@Nullable
                               com.pulumi.core.Output<java.lang.String> arn)
        Parameters:
        arn - ARN of the Canary.
        Returns:
        builder

      • arn

        public CanaryState.Builder arn​(java.lang.String arn)
        Parameters:
        arn - ARN of the Canary.
        Returns:
        builder

      • artifactConfig

        public CanaryState.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 CanaryState.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 CanaryState.Builder artifactS3Location​(@Nullable
                                              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 CanaryState.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 CanaryState.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 CanaryState.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

      • engineArn

        public CanaryState.Builder engineArn​(@Nullable
                                     com.pulumi.core.Output<java.lang.String> engineArn)
        Parameters:
        engineArn - ARN of the Lambda function that is used as your canary's engine.
        Returns:
        builder

      • engineArn

        public CanaryState.Builder engineArn​(java.lang.String engineArn)
        Parameters:
        engineArn - ARN of the Lambda function that is used as your canary's engine.
        Returns:
        builder

      • executionRoleArn

        public CanaryState.Builder executionRoleArn​(@Nullable
                                            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 CanaryState.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 CanaryState.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 CanaryState.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 CanaryState.Builder handler​(@Nullable
                                   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 CanaryState.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 CanaryState.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 CanaryState.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 CanaryState.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 CanaryState.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 CanaryState.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 CanaryState.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 CanaryState.Builder runConfig​(@Nullable
                                     com.pulumi.core.Output<CanaryRunConfigArgs> runConfig)
        Parameters:
        runConfig - Configuration block for individual canary runs. Detailed below.
        Returns:
        builder

      • runConfig

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

      • runtimeVersion

        public CanaryState.Builder runtimeVersion​(@Nullable
                                          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 CanaryState.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 CanaryState.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 CanaryState.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 CanaryState.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 CanaryState.Builder s3Key​(java.lang.String s3Key)
        Parameters:
        s3Key - S3 key of your script. **Conflicts with `zipFile`.**
        Returns:
        builder

      • s3Version

        public CanaryState.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 CanaryState.Builder s3Version​(java.lang.String s3Version)
        Parameters:
        s3Version - S3 version ID of your script. **Conflicts with `zipFile`.**
        Returns:
        builder

      • schedule

        public CanaryState.Builder schedule​(@Nullable
                                    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 CanaryState.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

      • sourceLocationArn

        public CanaryState.Builder sourceLocationArn​(@Nullable
                                             com.pulumi.core.Output<java.lang.String> sourceLocationArn)
        Parameters:
        sourceLocationArn - ARN of the Lambda layer where Synthetics stores the canary script code.
        Returns:
        builder

      • sourceLocationArn

        public CanaryState.Builder sourceLocationArn​(java.lang.String sourceLocationArn)
        Parameters:
        sourceLocationArn - ARN of the Lambda layer where Synthetics stores the canary script code.
        Returns:
        builder

      • startCanary

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

      • startCanary

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

      • status

        public CanaryState.Builder status​(@Nullable
                                  com.pulumi.core.Output<java.lang.String> status)
        Parameters:
        status - Canary status.
        Returns:
        builder

      • status

        public CanaryState.Builder status​(java.lang.String status)
        Parameters:
        status - Canary status.
        Returns:
        builder

      • successRetentionPeriod

        public CanaryState.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 CanaryState.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 CanaryState.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 CanaryState.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

      • tagsAll

        public CanaryState.Builder tagsAll​(@Nullable
                                   com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll)
        Parameters:
        tagsAll - A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
        Returns:
        builder

      • tagsAll

        public CanaryState.Builder tagsAll​(java.util.Map<java.lang.String,​java.lang.String> tagsAll)
        Parameters:
        tagsAll - A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
        Returns:
        builder

      • timelines

        public CanaryState.Builder timelines​(@Nullable
                                     com.pulumi.core.Output<java.util.List<CanaryTimelineArgs>> timelines)
        Parameters:
        timelines - Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.
        Returns:
        builder

      • timelines

        public CanaryState.Builder timelines​(java.util.List<CanaryTimelineArgs> timelines)
        Parameters:
        timelines - Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.
        Returns:
        builder

      • timelines

        public CanaryState.Builder timelines​(CanaryTimelineArgs... timelines)
        Parameters:
        timelines - Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.
        Returns:
        builder

      • vpcConfig

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

      • zipFile

        public CanaryState.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 CanaryState.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