AWS Native is in preview. AWS Classic is fully supported.
aws-native.synthetics.Canary
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource Type definition for AWS::Synthetics::Canary
Example Usage
Example
using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;
return await Deployment.RunAsync(() =>
{
var syntheticsCanary = new AwsNative.Synthetics.Canary("syntheticsCanary", new()
{
Name = "samplecanary",
ExecutionRoleArn = "arn:aws:iam::123456789012:role/my-lambda-execution-role-to-run-canary",
Code = new AwsNative.Synthetics.Inputs.CanaryCodeArgs
{
Handler = "pageLoadBlueprint.handler",
S3Bucket = "aws-synthetics-code-myaccount-canary1",
S3Key = "my-script-location",
},
ArtifactS3Location = "s3://my-results-bucket",
RuntimeVersion = "syn-nodejs-puppeteer-3.3",
Schedule = new AwsNative.Synthetics.Inputs.CanaryScheduleArgs
{
Expression = "rate(1 minute)",
DurationInSeconds = "3600",
},
RunConfig = new AwsNative.Synthetics.Inputs.CanaryRunConfigArgs
{
TimeoutInSeconds = 60,
},
FailureRetentionPeriod = 30,
SuccessRetentionPeriod = 30,
Tags = new[]
{
new AwsNative.Synthetics.Inputs.CanaryTagArgs
{
Key = "key00AtCreate",
Value = "value001AtCreate",
},
},
StartCanaryAfterCreation = true,
});
});
package main
import (
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/synthetics"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := synthetics.NewCanary(ctx, "syntheticsCanary", &synthetics.CanaryArgs{
Name: pulumi.String("samplecanary"),
ExecutionRoleArn: pulumi.String("arn:aws:iam::123456789012:role/my-lambda-execution-role-to-run-canary"),
Code: &synthetics.CanaryCodeArgs{
Handler: pulumi.String("pageLoadBlueprint.handler"),
S3Bucket: pulumi.String("aws-synthetics-code-myaccount-canary1"),
S3Key: pulumi.String("my-script-location"),
},
ArtifactS3Location: pulumi.String("s3://my-results-bucket"),
RuntimeVersion: pulumi.String("syn-nodejs-puppeteer-3.3"),
Schedule: &synthetics.CanaryScheduleArgs{
Expression: pulumi.String("rate(1 minute)"),
DurationInSeconds: pulumi.String("3600"),
},
RunConfig: &synthetics.CanaryRunConfigArgs{
TimeoutInSeconds: pulumi.Int(60),
},
FailureRetentionPeriod: pulumi.Int(30),
SuccessRetentionPeriod: pulumi.Int(30),
Tags: []synthetics.CanaryTagArgs{
{
Key: pulumi.String("key00AtCreate"),
Value: pulumi.String("value001AtCreate"),
},
},
StartCanaryAfterCreation: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_aws_native as aws_native
synthetics_canary = aws_native.synthetics.Canary("syntheticsCanary",
name="samplecanary",
execution_role_arn="arn:aws:iam::123456789012:role/my-lambda-execution-role-to-run-canary",
code=aws_native.synthetics.CanaryCodeArgs(
handler="pageLoadBlueprint.handler",
s3_bucket="aws-synthetics-code-myaccount-canary1",
s3_key="my-script-location",
),
artifact_s3_location="s3://my-results-bucket",
runtime_version="syn-nodejs-puppeteer-3.3",
schedule=aws_native.synthetics.CanaryScheduleArgs(
expression="rate(1 minute)",
duration_in_seconds="3600",
),
run_config=aws_native.synthetics.CanaryRunConfigArgs(
timeout_in_seconds=60,
),
failure_retention_period=30,
success_retention_period=30,
tags=[aws_native.synthetics.CanaryTagArgs(
key="key00AtCreate",
value="value001AtCreate",
)],
start_canary_after_creation=True)
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";
const syntheticsCanary = new aws_native.synthetics.Canary("syntheticsCanary", {
name: "samplecanary",
executionRoleArn: "arn:aws:iam::123456789012:role/my-lambda-execution-role-to-run-canary",
code: {
handler: "pageLoadBlueprint.handler",
s3Bucket: "aws-synthetics-code-myaccount-canary1",
s3Key: "my-script-location",
},
artifactS3Location: "s3://my-results-bucket",
runtimeVersion: "syn-nodejs-puppeteer-3.3",
schedule: {
expression: "rate(1 minute)",
durationInSeconds: "3600",
},
runConfig: {
timeoutInSeconds: 60,
},
failureRetentionPeriod: 30,
successRetentionPeriod: 30,
tags: [{
key: "key00AtCreate",
value: "value001AtCreate",
}],
startCanaryAfterCreation: true,
});
Coming soon!
Example
using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;
return await Deployment.RunAsync(() =>
{
var syntheticsCanary = new AwsNative.Synthetics.Canary("syntheticsCanary", new()
{
Name = "samplecanary",
ExecutionRoleArn = "arn:aws:iam::123456789012:role/my-lambda-execution-role-to-run-canary",
Code = new AwsNative.Synthetics.Inputs.CanaryCodeArgs
{
Handler = "pageLoadBlueprint.handler",
Script = @"var synthetics = require('Synthetics');
const log = require('SyntheticsLogger');
const pageLoadBlueprint = async function () {
// INSERT URL here
const URL = ""https://amazon.com"";
let page = await synthetics.getPage();
const response = await page.goto(URL, {waitUntil: 'domcontentloaded', timeout: 30000});
//Wait for page to render.
//Increase or decrease wait time based on endpoint being monitored.
await page.waitFor(15000);
await synthetics.takeScreenshot('loaded', 'loaded');
let pageTitle = await page.title();
log.info('Page title: ' + pageTitle);
if (response.status() !== 200) {
throw ""Failed to load page!"";
}
};
exports.handler = async () => {
return await pageLoadBlueprint();
};
",
},
ArtifactS3Location = "s3://my-results-bucket",
RuntimeVersion = "syn-nodejs-puppeteer-3.3",
Schedule = new AwsNative.Synthetics.Inputs.CanaryScheduleArgs
{
Expression = "rate(1 minute)",
DurationInSeconds = "3600",
},
RunConfig = new AwsNative.Synthetics.Inputs.CanaryRunConfigArgs
{
TimeoutInSeconds = 60,
},
FailureRetentionPeriod = 30,
SuccessRetentionPeriod = 30,
Tags = new[]
{
new AwsNative.Synthetics.Inputs.CanaryTagArgs
{
Key = "key00AtCreate",
Value = "value001AtCreate",
},
},
StartCanaryAfterCreation = false,
});
});
package main
import (
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/synthetics"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := synthetics.NewCanary(ctx, "syntheticsCanary", &synthetics.CanaryArgs{
Name: pulumi.String("samplecanary"),
ExecutionRoleArn: pulumi.String("arn:aws:iam::123456789012:role/my-lambda-execution-role-to-run-canary"),
Code: &synthetics.CanaryCodeArgs{
Handler: pulumi.String("pageLoadBlueprint.handler"),
Script: pulumi.String("var synthetics = require('Synthetics');\nconst log = require('SyntheticsLogger');\nconst pageLoadBlueprint = async function () {\n// INSERT URL here\nconst URL = \"https://amazon.com\";\n\nlet page = await synthetics.getPage();\nconst response = await page.goto(URL, {waitUntil: 'domcontentloaded', timeout: 30000});\n//Wait for page to render.\n//Increase or decrease wait time based on endpoint being monitored.\nawait page.waitFor(15000);\nawait synthetics.takeScreenshot('loaded', 'loaded');\nlet pageTitle = await page.title();\nlog.info('Page title: ' + pageTitle);\nif (response.status() !== 200) {\n throw \"Failed to load page!\";\n}\n};\n\nexports.handler = async () => {\nreturn await pageLoadBlueprint();\n};\n"),
},
ArtifactS3Location: pulumi.String("s3://my-results-bucket"),
RuntimeVersion: pulumi.String("syn-nodejs-puppeteer-3.3"),
Schedule: &synthetics.CanaryScheduleArgs{
Expression: pulumi.String("rate(1 minute)"),
DurationInSeconds: pulumi.String("3600"),
},
RunConfig: &synthetics.CanaryRunConfigArgs{
TimeoutInSeconds: pulumi.Int(60),
},
FailureRetentionPeriod: pulumi.Int(30),
SuccessRetentionPeriod: pulumi.Int(30),
Tags: []synthetics.CanaryTagArgs{
{
Key: pulumi.String("key00AtCreate"),
Value: pulumi.String("value001AtCreate"),
},
},
StartCanaryAfterCreation: pulumi.Bool(false),
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_aws_native as aws_native
synthetics_canary = aws_native.synthetics.Canary("syntheticsCanary",
name="samplecanary",
execution_role_arn="arn:aws:iam::123456789012:role/my-lambda-execution-role-to-run-canary",
code=aws_native.synthetics.CanaryCodeArgs(
handler="pageLoadBlueprint.handler",
script="""var synthetics = require('Synthetics');
const log = require('SyntheticsLogger');
const pageLoadBlueprint = async function () {
// INSERT URL here
const URL = "https://amazon.com";
let page = await synthetics.getPage();
const response = await page.goto(URL, {waitUntil: 'domcontentloaded', timeout: 30000});
//Wait for page to render.
//Increase or decrease wait time based on endpoint being monitored.
await page.waitFor(15000);
await synthetics.takeScreenshot('loaded', 'loaded');
let pageTitle = await page.title();
log.info('Page title: ' + pageTitle);
if (response.status() !== 200) {
throw "Failed to load page!";
}
};
exports.handler = async () => {
return await pageLoadBlueprint();
};
""",
),
artifact_s3_location="s3://my-results-bucket",
runtime_version="syn-nodejs-puppeteer-3.3",
schedule=aws_native.synthetics.CanaryScheduleArgs(
expression="rate(1 minute)",
duration_in_seconds="3600",
),
run_config=aws_native.synthetics.CanaryRunConfigArgs(
timeout_in_seconds=60,
),
failure_retention_period=30,
success_retention_period=30,
tags=[aws_native.synthetics.CanaryTagArgs(
key="key00AtCreate",
value="value001AtCreate",
)],
start_canary_after_creation=False)
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";
const syntheticsCanary = new aws_native.synthetics.Canary("syntheticsCanary", {
name: "samplecanary",
executionRoleArn: "arn:aws:iam::123456789012:role/my-lambda-execution-role-to-run-canary",
code: {
handler: "pageLoadBlueprint.handler",
script: `var synthetics = require('Synthetics');
const log = require('SyntheticsLogger');
const pageLoadBlueprint = async function () {
// INSERT URL here
const URL = "https://amazon.com";
let page = await synthetics.getPage();
const response = await page.goto(URL, {waitUntil: 'domcontentloaded', timeout: 30000});
//Wait for page to render.
//Increase or decrease wait time based on endpoint being monitored.
await page.waitFor(15000);
await synthetics.takeScreenshot('loaded', 'loaded');
let pageTitle = await page.title();
log.info('Page title: ' + pageTitle);
if (response.status() !== 200) {
throw "Failed to load page!";
}
};
exports.handler = async () => {
return await pageLoadBlueprint();
};
`,
},
artifactS3Location: "s3://my-results-bucket",
runtimeVersion: "syn-nodejs-puppeteer-3.3",
schedule: {
expression: "rate(1 minute)",
durationInSeconds: "3600",
},
runConfig: {
timeoutInSeconds: 60,
},
failureRetentionPeriod: 30,
successRetentionPeriod: 30,
tags: [{
key: "key00AtCreate",
value: "value001AtCreate",
}],
startCanaryAfterCreation: false,
});
Coming soon!
Create Canary Resource
new Canary(name: string, args: CanaryArgs, opts?: CustomResourceOptions);
@overload
def Canary(resource_name: str,
opts: Optional[ResourceOptions] = None,
artifact_config: Optional[CanaryArtifactConfigArgs] = None,
artifact_s3_location: Optional[str] = None,
code: Optional[CanaryCodeArgs] = None,
delete_lambda_resources_on_canary_deletion: Optional[bool] = None,
execution_role_arn: Optional[str] = None,
failure_retention_period: Optional[int] = None,
name: Optional[str] = None,
run_config: Optional[CanaryRunConfigArgs] = None,
runtime_version: Optional[str] = None,
schedule: Optional[CanaryScheduleArgs] = None,
start_canary_after_creation: Optional[bool] = None,
success_retention_period: Optional[int] = None,
tags: Optional[Sequence[CanaryTagArgs]] = None,
v_pc_config: Optional[CanaryVPCConfigArgs] = None,
visual_reference: Optional[CanaryVisualReferenceArgs] = None)
@overload
def Canary(resource_name: str,
args: CanaryArgs,
opts: Optional[ResourceOptions] = None)
func NewCanary(ctx *Context, name string, args CanaryArgs, opts ...ResourceOption) (*Canary, error)
public Canary(string name, CanaryArgs args, CustomResourceOptions? opts = null)
public Canary(String name, CanaryArgs args)
public Canary(String name, CanaryArgs args, CustomResourceOptions options)
type: aws-native:synthetics:Canary
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CanaryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CanaryArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CanaryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CanaryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CanaryArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Canary Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Canary resource accepts the following input properties:
- Artifact
S3Location string Provide the s3 bucket output location for test results
- Code
Pulumi.
Aws Native. Synthetics. Inputs. Canary Code Args Provide the canary script source
- Execution
Role stringArn Lambda Execution role used to run your canaries
- Runtime
Version string Runtime version of Synthetics Library
- Schedule
Pulumi.
Aws Native. Synthetics. Inputs. Canary Schedule Args Frequency to run your canaries
- Artifact
Config Pulumi.Aws Native. Synthetics. Inputs. Canary Artifact Config Args Provide artifact configuration
- Delete
Lambda boolResources On Canary Deletion Deletes associated lambda resources created by Synthetics if set to True. Default is False
- Failure
Retention intPeriod Retention period of failed canary runs represented in number of days
- Name string
Name of the canary.
- Run
Config Pulumi.Aws Native. Synthetics. Inputs. Canary Run Config Args Provide canary run configuration
- Start
Canary boolAfter Creation Runs canary if set to True. Default is False
- Success
Retention intPeriod Retention period of successful canary runs represented in number of days
- List<Pulumi.
Aws Native. Synthetics. Inputs. Canary Tag Args> - VPCConfig
Pulumi.
Aws Native. Synthetics. Inputs. Canary VPCConfig Args Provide VPC Configuration if enabled.
- Visual
Reference Pulumi.Aws Native. Synthetics. Inputs. Canary Visual Reference Args Visual reference configuration for visual testing
- Artifact
S3Location string Provide the s3 bucket output location for test results
- Code
Canary
Code Args Provide the canary script source
- Execution
Role stringArn Lambda Execution role used to run your canaries
- Runtime
Version string Runtime version of Synthetics Library
- Schedule
Canary
Schedule Args Frequency to run your canaries
- Artifact
Config CanaryArtifact Config Args Provide artifact configuration
- Delete
Lambda boolResources On Canary Deletion Deletes associated lambda resources created by Synthetics if set to True. Default is False
- Failure
Retention intPeriod Retention period of failed canary runs represented in number of days
- Name string
Name of the canary.
- Run
Config CanaryRun Config Args Provide canary run configuration
- Start
Canary boolAfter Creation Runs canary if set to True. Default is False
- Success
Retention intPeriod Retention period of successful canary runs represented in number of days
- []Canary
Tag Args - VPCConfig
Canary
VPCConfig Args Provide VPC Configuration if enabled.
- Visual
Reference CanaryVisual Reference Args Visual reference configuration for visual testing
- artifact
S3Location String Provide the s3 bucket output location for test results
- code
Canary
Code Args Provide the canary script source
- execution
Role StringArn Lambda Execution role used to run your canaries
- runtime
Version String Runtime version of Synthetics Library
- schedule
Canary
Schedule Args Frequency to run your canaries
- artifact
Config CanaryArtifact Config Args Provide artifact configuration
- delete
Lambda BooleanResources On Canary Deletion Deletes associated lambda resources created by Synthetics if set to True. Default is False
- failure
Retention IntegerPeriod Retention period of failed canary runs represented in number of days
- name String
Name of the canary.
- run
Config CanaryRun Config Args Provide canary run configuration
- start
Canary BooleanAfter Creation Runs canary if set to True. Default is False
- success
Retention IntegerPeriod Retention period of successful canary runs represented in number of days
- List<Canary
Tag Args> - v
PCConfig CanaryVPCConfig Args Provide VPC Configuration if enabled.
- visual
Reference CanaryVisual Reference Args Visual reference configuration for visual testing
- artifact
S3Location string Provide the s3 bucket output location for test results
- code
Canary
Code Args Provide the canary script source
- execution
Role stringArn Lambda Execution role used to run your canaries
- runtime
Version string Runtime version of Synthetics Library
- schedule
Canary
Schedule Args Frequency to run your canaries
- artifact
Config CanaryArtifact Config Args Provide artifact configuration
- delete
Lambda booleanResources On Canary Deletion Deletes associated lambda resources created by Synthetics if set to True. Default is False
- failure
Retention numberPeriod Retention period of failed canary runs represented in number of days
- name string
Name of the canary.
- run
Config CanaryRun Config Args Provide canary run configuration
- start
Canary booleanAfter Creation Runs canary if set to True. Default is False
- success
Retention numberPeriod Retention period of successful canary runs represented in number of days
- Canary
Tag Args[] - v
PCConfig CanaryVPCConfig Args Provide VPC Configuration if enabled.
- visual
Reference CanaryVisual Reference Args Visual reference configuration for visual testing
- artifact_
s3_ strlocation Provide the s3 bucket output location for test results
- code
Canary
Code Args Provide the canary script source
- execution_
role_ strarn Lambda Execution role used to run your canaries
- runtime_
version str Runtime version of Synthetics Library
- schedule
Canary
Schedule Args Frequency to run your canaries
- artifact_
config CanaryArtifact Config Args Provide artifact configuration
- delete_
lambda_ boolresources_ on_ canary_ deletion Deletes associated lambda resources created by Synthetics if set to True. Default is False
- failure_
retention_ intperiod Retention period of failed canary runs represented in number of days
- name str
Name of the canary.
- run_
config CanaryRun Config Args Provide canary run configuration
- start_
canary_ boolafter_ creation Runs canary if set to True. Default is False
- success_
retention_ intperiod Retention period of successful canary runs represented in number of days
- Sequence[Canary
Tag Args] - v_
pc_ Canaryconfig VPCConfig Args Provide VPC Configuration if enabled.
- visual_
reference CanaryVisual Reference Args Visual reference configuration for visual testing
- artifact
S3Location String Provide the s3 bucket output location for test results
- code Property Map
Provide the canary script source
- execution
Role StringArn Lambda Execution role used to run your canaries
- runtime
Version String Runtime version of Synthetics Library
- schedule Property Map
Frequency to run your canaries
- artifact
Config Property Map Provide artifact configuration
- delete
Lambda BooleanResources On Canary Deletion Deletes associated lambda resources created by Synthetics if set to True. Default is False
- failure
Retention NumberPeriod Retention period of failed canary runs represented in number of days
- name String
Name of the canary.
- run
Config Property Map Provide canary run configuration
- start
Canary BooleanAfter Creation Runs canary if set to True. Default is False
- success
Retention NumberPeriod Retention period of successful canary runs represented in number of days
- List<Property Map>
- v
PCConfig Property Map Provide VPC Configuration if enabled.
- visual
Reference Property Map Visual reference configuration for visual testing
Outputs
All input properties are implicitly available as output properties. Additionally, the Canary resource produces the following output properties:
Supporting Types
CanaryArtifactConfig
- S3Encryption
Pulumi.
Aws Native. Synthetics. Inputs. Canary S3Encryption Encryption configuration for uploading artifacts to S3
- S3Encryption
Canary
S3Encryption Encryption configuration for uploading artifacts to S3
- s3Encryption
Canary
S3Encryption Encryption configuration for uploading artifacts to S3
- s3Encryption
Canary
S3Encryption Encryption configuration for uploading artifacts to S3
- s3_
encryption CanaryS3Encryption Encryption configuration for uploading artifacts to S3
- s3Encryption Property Map
Encryption configuration for uploading artifacts to S3
CanaryBaseScreenshot
- Screenshot
Name string Name of the screenshot to be used as base reference for visual testing
- Ignore
Coordinates List<string> List of coordinates of rectangles to be ignored during visual testing
- Screenshot
Name string Name of the screenshot to be used as base reference for visual testing
- Ignore
Coordinates []string List of coordinates of rectangles to be ignored during visual testing
- screenshot
Name String Name of the screenshot to be used as base reference for visual testing
- ignore
Coordinates List<String> List of coordinates of rectangles to be ignored during visual testing
- screenshot
Name string Name of the screenshot to be used as base reference for visual testing
- ignore
Coordinates string[] List of coordinates of rectangles to be ignored during visual testing
- screenshot_
name str Name of the screenshot to be used as base reference for visual testing
- ignore_
coordinates Sequence[str] List of coordinates of rectangles to be ignored during visual testing
- screenshot
Name String Name of the screenshot to be used as base reference for visual testing
- ignore
Coordinates List<String> List of coordinates of rectangles to be ignored during visual testing
CanaryCode
- Handler string
- S3Bucket string
- S3Key string
- S3Object
Version string - Script string
- Source
Location stringArn
- Handler string
- S3Bucket string
- S3Key string
- S3Object
Version string - Script string
- Source
Location stringArn
- handler String
- s3Bucket String
- s3Key String
- s3Object
Version String - script String
- source
Location StringArn
- handler string
- s3Bucket string
- s3Key string
- s3Object
Version string - script string
- source
Location stringArn
- handler str
- s3_
bucket str - s3_
key str - s3_
object_ strversion - script str
- source_
location_ strarn
- handler String
- s3Bucket String
- s3Key String
- s3Object
Version String - script String
- source
Location StringArn
CanaryRunConfig
- Active
Tracing bool Enable active tracing if set to true
- Environment
Variables object Environment variable key-value pairs.
- Memory
In intMB Provide maximum memory available for canary in MB
- Timeout
In intSeconds Provide maximum canary timeout per run in seconds
- Active
Tracing bool Enable active tracing if set to true
- Environment
Variables interface{} Environment variable key-value pairs.
- Memory
In intMB Provide maximum memory available for canary in MB
- Timeout
In intSeconds Provide maximum canary timeout per run in seconds
- active
Tracing Boolean Enable active tracing if set to true
- environment
Variables Object Environment variable key-value pairs.
- memory
In IntegerMB Provide maximum memory available for canary in MB
- timeout
In IntegerSeconds Provide maximum canary timeout per run in seconds
- active
Tracing boolean Enable active tracing if set to true
- environment
Variables any Environment variable key-value pairs.
- memory
In numberMB Provide maximum memory available for canary in MB
- timeout
In numberSeconds Provide maximum canary timeout per run in seconds
- active_
tracing bool Enable active tracing if set to true
- environment_
variables Any Environment variable key-value pairs.
- memory_
in_ intmb Provide maximum memory available for canary in MB
- timeout_
in_ intseconds Provide maximum canary timeout per run in seconds
- active
Tracing Boolean Enable active tracing if set to true
- environment
Variables Any Environment variable key-value pairs.
- memory
In NumberMB Provide maximum memory available for canary in MB
- timeout
In NumberSeconds Provide maximum canary timeout per run in seconds
CanaryS3Encryption
- Encryption
Mode string Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
- Kms
Key stringArn KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
- Encryption
Mode string Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
- Kms
Key stringArn KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
- encryption
Mode String Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
- kms
Key StringArn KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
- encryption
Mode string Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
- kms
Key stringArn KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
- encryption_
mode str Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
- kms_
key_ strarn KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
- encryption
Mode String Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
- kms
Key StringArn KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
CanarySchedule
- Expression string
- Duration
In stringSeconds
- Expression string
- Duration
In stringSeconds
- expression String
- duration
In StringSeconds
- expression string
- duration
In stringSeconds
- expression str
- duration_
in_ strseconds
- expression String
- duration
In StringSeconds
CanaryTag
- Key string
The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
CanaryVPCConfig
- Security
Group List<string>Ids - Subnet
Ids List<string> - Vpc
Id string
- Security
Group []stringIds - Subnet
Ids []string - Vpc
Id string
- security
Group List<String>Ids - subnet
Ids List<String> - vpc
Id String
- security
Group string[]Ids - subnet
Ids string[] - vpc
Id string
- security_
group_ Sequence[str]ids - subnet_
ids Sequence[str] - vpc_
id str
- security
Group List<String>Ids - subnet
Ids List<String> - vpc
Id String
CanaryVisualReference
- Base
Canary stringRun Id Canary run id to be used as base reference for visual testing
- Base
Screenshots List<Pulumi.Aws Native. Synthetics. Inputs. Canary Base Screenshot> List of screenshots used as base reference for visual testing
- Base
Canary stringRun Id Canary run id to be used as base reference for visual testing
- Base
Screenshots []CanaryBase Screenshot List of screenshots used as base reference for visual testing
- base
Canary StringRun Id Canary run id to be used as base reference for visual testing
- base
Screenshots List<CanaryBase Screenshot> List of screenshots used as base reference for visual testing
- base
Canary stringRun Id Canary run id to be used as base reference for visual testing
- base
Screenshots CanaryBase Screenshot[] List of screenshots used as base reference for visual testing
- base_
canary_ strrun_ id Canary run id to be used as base reference for visual testing
- base_
screenshots Sequence[CanaryBase Screenshot] List of screenshots used as base reference for visual testing
- base
Canary StringRun Id Canary run id to be used as base reference for visual testing
- base
Screenshots List<Property Map> List of screenshots used as base reference for visual testing
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.