import { VisualReferenceProps } from './canary/VisualReferenceProps';
import { ArtifactConfigProps } from './canary/ArtifactConfigProps';
import { Value } from '../../cloudformation/Value';
import { VPCConfigProps } from './canary/VPCConfigProps';
import { RunConfigProps } from './canary/RunConfigProps';
import { CodeProps } from './canary/CodeProps';
import { ScheduleProps } from './canary/ScheduleProps';
import { Tag } from '../Tag';
import { Attribute } from '../../cloudformation/Attribute';
import { AwsResource } from '../../cloudformation/resources/AwsResource';
export type CanaryAttributes = {
    Code_SourceLocationArn: Attribute<string>;
    State: Attribute<string>;
    Id: Attribute<string>;
};
export type Canary = AwsResource<'AWS::Synthetics::Canary', CanaryProperties, CanaryAttributes>;
/**
  Creates or updates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html">the AWS Docs</a>
*/
export declare function canary(canaryProps: CanaryProperties): Canary;
/**
  Creates or updates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html">the AWS Docs</a>
*/
export interface CanaryProperties {
    /** <code>VisualReference</code>  <a name="cfn-synthetics-canary-visualreference"></a>
  If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    visualReference?: VisualReferenceProps;
    /** <code>ArtifactConfig</code>  <a name="cfn-synthetics-canary-artifactconfig"></a>
  A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    artifactConfig?: ArtifactConfigProps;
    /** <code>SuccessRetentionPeriod</code>  <a name="cfn-synthetics-canary-successretentionperiod"></a>
  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.<br />
  
  Required: No<br />
  
  Minimum: <code>1</code><br />
  
  Maximum: <code>1024</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    successRetentionPeriod?: Value<number>;
    /** <code>RuntimeVersion</code>  <a name="cfn-synthetics-canary-runtimeversion"></a>
  Specifies the runtime version to use for the canary. For more information about runtime versions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html"> Canary Runtime Versions</a>.<br />
  
  Required: Yes<br />
  
  Minimum: <code>1</code><br />
  
  Maximum: <code>1024</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    runtimeVersion: Value<string>;
    /** <code>VPCConfig</code>  <a name="cfn-synthetics-canary-vpcconfig"></a>
  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 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html"> Running a Canary in a VPC</a>.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    vPCConfig?: VPCConfigProps;
    /** <code>RunConfig</code>  <a name="cfn-synthetics-canary-runconfig"></a>
  A structure that contains input information for a canary run. If you omit this structure, the frequency of the canary is used as canary’s timeout value, up to a maximum of 900 seconds.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    runConfig?: RunConfigProps;
    /** <code>FailureRetentionPeriod</code>  <a name="cfn-synthetics-canary-failureretentionperiod"></a>
  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.<br />
  
  Required: No<br />
  
  Minimum: <code>1</code><br />
  
  Maximum: <code>1024</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    failureRetentionPeriod?: Value<number>;
    /** <code>Code</code>  <a name="cfn-synthetics-canary-code"></a>
  Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script is passed into the canary directly, the script code is contained in the value of <code>Script</code>.<br />
  
  Required: Yes<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    code: CodeProps;
    /** <code>Name</code>  <a name="cfn-synthetics-canary-name"></a>
  The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.<br />
  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 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html">Security Considerations for Synthetics Canaries</a>.<br />
  
  Required: Yes<br />
  
  Minimum: <code>1</code><br />
  
  Maximum: <code>21</code><br />
  
  Pattern: <code>^[0-9a-z_\-]+$</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">Replacement</a> */
    name: Value<string>;
    /** <p> */
    executionRoleArn: Value<string>;
    /** <code>Schedule</code>  <a name="cfn-synthetics-canary-schedule"></a>
  A structure that contains information about how often the canary is to run, and when these runs are to stop.<br />
  
  Required: Yes<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    schedule: ScheduleProps;
    /** <code>ArtifactS3Location</code>  <a name="cfn-synthetics-canary-artifacts3location"></a>
  The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files. Specify the full location path, including <code>s3://</code> at the beginning of the path.<br />
  
  Required: Yes<br />
  
  Minimum: <code>1</code><br />
  
  Maximum: <code>1024</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    artifactS3Location: Value<string>;
    /** <code>Tags</code>  <a name="cfn-synthetics-canary-tags"></a>
  The list of key-value pairs that are associated with the canary.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    tags?: Tag[];
    /** <code>StartCanaryAfterCreation</code>  <a name="cfn-synthetics-canary-startcanaryaftercreation"></a>
  Specify TRUE to have the canary start making runs immediately after it is created.<br />
  A canary that you create using CloudFormation can’t be used to monitor the CloudFormation stack that creates the canary or to roll back that stack if there is a failure.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    startCanaryAfterCreation?: Value<boolean>;
}
