import { Value } from '../../../cloudformation/Value';
/**
  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>.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html">the AWS Docs</a>
*/
export interface CodeProps {
    /** <code>Script</code>  <a name="cfn-synthetics-canary-code-script"></a>
  If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the script in plain text. It can be up to 5 MB.<br />
  
  Required: Conditional<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> */
    script?: Value<string>;
    /** <code>S3ObjectVersion</code>  <a name="cfn-synthetics-canary-code-s3objectversion"></a>
  The S3 version ID of your script.<br />
  
  Required: Conditional<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> */
    s3ObjectVersion?: Value<string>;
    /** <code>S3Bucket</code>  <a name="cfn-synthetics-canary-code-s3bucket"></a>
  If your canary script is located in S3, specify the bucket name here. The bucket must already exist.<br />
  
  Required: Conditional<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> */
    s3Bucket?: Value<string>;
    /** <code>S3Key</code>  <a name="cfn-synthetics-canary-code-s3key"></a>
  The S3 key of your script. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html">Working with Amazon S3 Objects</a>.<br />
  
  Required: Conditional<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> */
    s3Key?: Value<string>;
    /** <code>Handler</code>  <a name="cfn-synthetics-canary-code-handler"></a>
  The entry point to use for the source code when running the canary. For canaries that use the <code>syn-python-selenium-1.0</code> runtime or a <code>syn-nodejs.puppeteer</code> runtime earlier than <code>syn-nodejs.puppeteer-3.4</code>, the handler must be specified as <code> fileName.handler</code>. For <code>syn-python-selenium-1.1</code>, <code>syn-nodejs.puppeteer-3.4</code>, and later runtimes, the handler can be specified as <code>fileName.functionName</code>, or you can specify a folder where canary scripts reside as <code>folder/fileName.functionName</code>.<br />
  
  Required: Conditional<br />
  
  Minimum: <code>1</code><br />
  
  Maximum: <code>128</code><br />
  
  Pattern: <code>^([0-9a-zA-Z_-]+\/)*[0-9A-Za-z_\\-]+\.[A-Za-z_][A-Za-z0-9_]*$</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> */
    handler: Value<string>;
    /** <code>SourceLocationArn</code>  <a name="cfn-synthetics-canary-code-sourcelocationarn"></a>
  The ARN of the Lambda layer where Synthetics stores the canary script code.<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> */
    sourceLocationArn?: Value<string>;
}
