AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon CloudWatch Synthetics CreateCanary API operation.

Syntax

New-CWSYNCanary
-Name <String>
-RunConfig_ActiveTracing <Boolean>
-ArtifactS3Location <String>
-Schedule_DurationInSecond <Int64>
-S3Encryption_EncryptionMode <EncryptionMode>
-RunConfig_EnvironmentVariable <Hashtable>
-ExecutionRoleArn <String>
-Schedule_Expression <String>
-FailureRetentionPeriodInDay <Int32>
-Code_Handler <String>
-S3Encryption_KmsKeyArn <String>
-RunConfig_MemoryInMB <Int32>
-ResourcesToReplicateTag <String[]>
-RuntimeVersion <String>
-Code_S3Bucket <String>
-Code_S3Key <String>
-Code_S3Version <String>
-VpcConfig_SecurityGroupId <String[]>
-VpcConfig_SubnetId <String[]>
-SuccessRetentionPeriodInDay <Int32>
-Tag <Hashtable>
-RunConfig_TimeoutInSecond <Int32>
-Code_ZipFile <Byte[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonSyntheticsConfig>

Description

Creates 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. Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead. To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions. Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Parameters

-ArtifactS3Location <String>
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 (.).
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonSyntheticsConfig>
Amazon.PowerShell.Cmdlets.CWSYN.AmazonSyntheticsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Code_Handler <String>
The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName, or you can specify a folder where canary scripts reside as folder/fileName.functionName.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Code_S3Bucket <String>
If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Code_S3Key <String>
The S3 key of your script. For more information, see Working with Amazon S3 Objects.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Code_S3Version <String>
The S3 version ID of your script.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Code_ZipFile <Byte[]>
If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb.For large canary scripts, we recommend that you use an S3 location instead of inputting it directly with this parameter.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionRoleArn <String>
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
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FailureRetentionPeriodInDay <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFailureRetentionPeriodInDays
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
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.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourcesToReplicateTag <String[]>
To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourcesToReplicateTags
-RunConfig_ActiveTracing <Boolean>
Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing.You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RunConfig_EnvironmentVariable <Hashtable>
Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:{ "key1" : "value1", "key2" : "value2", ...}Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables.The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRunConfig_EnvironmentVariables
-RunConfig_MemoryInMB <Int32>
The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RunConfig_TimeoutInSecond <Int32>
How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary.If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRunConfig_TimeoutInSeconds
-RuntimeVersion <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Encryption_EncryptionMode <EncryptionMode>
The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with a customer-managed KMS key.If you omit this parameter, an Amazon Web Services-managed KMS key is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesArtifactConfig_S3Encryption_EncryptionMode
-S3Encryption_KmsKeyArn <String>
The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesArtifactConfig_S3Encryption_KmsKeyArn
-Schedule_DurationInSecond <Int64>
How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSchedule_DurationInSeconds
-Schedule_Expression <String>
A rate expression or a cron expression that defines how often the canary is to run.For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.Use cron(expression) to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Canary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Synthetics.Model.CreateCanaryResponse). Specifying the name of a property of type Amazon.Synthetics.Model.CreateCanaryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SuccessRetentionPeriodInDay <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSuccessRetentionPeriodInDays
-Tag <Hashtable>
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.To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VpcConfig_SecurityGroupId <String[]>
The IDs of the security groups for this canary.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfig_SecurityGroupIds
-VpcConfig_SubnetId <String[]>
The IDs of the subnets where this canary is to run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfig_SubnetIds

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Synthetics.Model.Canary or Amazon.Synthetics.Model.CreateCanaryResponse
This cmdlet returns an Amazon.Synthetics.Model.Canary object. The service call response (type Amazon.Synthetics.Model.CreateCanaryResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z