Package com.pulumi.aws.synthetics.inputs

Class CanaryState

  • public final class CanaryState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CanaryState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static CanaryState Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      java.util.Optional<com.pulumi.core.Output<CanaryArtifactConfigArgs>> artifactConfig()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> artifactS3Location()  
      static CanaryState.Builder builder()  
      static CanaryState.Builder builder​(CanaryState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> deleteLambda()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> executionRoleArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> failureRetentionPeriod()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> handler()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<CanaryRunConfigArgs>> runConfig()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> runtimeVersion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> s3Bucket()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> s3Key()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> s3Version()  
      java.util.Optional<com.pulumi.core.Output<CanaryScheduleArgs>> schedule()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceLocationArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> startCanary()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> status()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> successRetentionPeriod()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<CanaryTimelineArgs>>> timelines()  
      java.util.Optional<com.pulumi.core.Output<CanaryVpcConfigArgs>> vpcConfig()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> zipFile()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the Canary.

      • artifactConfig

        public java.util.Optional<com.pulumi.core.Output<CanaryArtifactConfigArgs>> artifactConfig()
        Returns:
        configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

      • artifactS3Location

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> artifactS3Location()
        Returns:
        Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

      • deleteLambda

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> deleteLambda()
        Returns:
        Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.

      • engineArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineArn()
        Returns:
        ARN of the Lambda function that is used as your canary's engine.

      • executionRoleArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> executionRoleArn()
        Returns:
        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.

      • failureRetentionPeriod

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> failureRetentionPeriod()
        Returns:
        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.

      • handler

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

      • kmsKeyArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyArn()
        Returns:
        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.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        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.

      • runConfig

        public java.util.Optional<com.pulumi.core.Output<CanaryRunConfigArgs>> runConfig()
        Returns:
        Configuration block for individual canary runs. Detailed below.

      • runtimeVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> runtimeVersion()
        Returns:
        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`.

      • s3Bucket

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> s3Bucket()
        Returns:
        Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**

      • s3Key

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> s3Key()
        Returns:
        S3 key of your script. **Conflicts with `zipFile`.**

      • s3Version

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> s3Version()
        Returns:
        S3 version ID of your script. **Conflicts with `zipFile`.**

      • schedule

        public java.util.Optional<com.pulumi.core.Output<CanaryScheduleArgs>> schedule()
        Returns:
        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:

      • sourceLocationArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceLocationArn()
        Returns:
        ARN of the Lambda layer where Synthetics stores the canary script code.

      • startCanary

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> startCanary()
        Returns:
        Whether to run or stop the canary.

      • status

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> status()
        Returns:
        Canary status.

      • successRetentionPeriod

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> successRetentionPeriod()
        Returns:
        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.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

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

      • timelines

        public java.util.Optional<com.pulumi.core.Output<java.util.List<CanaryTimelineArgs>>> timelines()
        Returns:
        Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

      • vpcConfig

        public java.util.Optional<com.pulumi.core.Output<CanaryVpcConfigArgs>> vpcConfig()
        Returns:
        Configuration block. Detailed below.

      • zipFile

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> zipFile()
        Returns:
        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`.**