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

Class CreateCanaryRequest

    • Method Detail

      • name

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

        Returns:
        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.

      • code

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

        Returns:
        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.

      • artifactS3Location

        public final 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 (.).

        Returns:
        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 (.).

      • executionRoleArn

        public final 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

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

      • schedule

        public final CanaryScheduleInput schedule()

        A structure that contains information about how often the canary is to run and when these test runs are to stop.

        Returns:
        A structure that contains information about how often the canary is to run and when these test runs are to stop.

      • runConfig

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

        Returns:
        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.

      • successRetentionPeriodInDays

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

        Returns:
        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.

      • failureRetentionPeriodInDays

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

        Returns:
        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.

      • runtimeVersion

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

        Returns:
        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.

      • vpcConfig

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

        Returns:
        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.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        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.

      • artifactConfig

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

        Returns:
        A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object