Canary

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,
    });

});

Coming soon!

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,
    });

});

Coming soon!

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:

ArtifactS3Location string

Provide the s3 bucket output location for test results

Code Pulumi.AwsNative.Synthetics.Inputs.CanaryCodeArgs

Provide the canary script source

ExecutionRoleArn string

Lambda Execution role used to run your canaries

RuntimeVersion string

Runtime version of Synthetics Library

Schedule Pulumi.AwsNative.Synthetics.Inputs.CanaryScheduleArgs

Frequency to run your canaries

StartCanaryAfterCreation bool

Runs canary if set to True. Default is False

ArtifactConfig Pulumi.AwsNative.Synthetics.Inputs.CanaryArtifactConfigArgs

Provide artifact configuration

DeleteLambdaResourcesOnCanaryDeletion bool

Deletes associated lambda resources created by Synthetics if set to True. Default is False

FailureRetentionPeriod int

Retention period of failed canary runs represented in number of days

Name string

Name of the canary.

RunConfig Pulumi.AwsNative.Synthetics.Inputs.CanaryRunConfigArgs

Provide canary run configuration

SuccessRetentionPeriod int

Retention period of successful canary runs represented in number of days

Tags List<Pulumi.AwsNative.Synthetics.Inputs.CanaryTagArgs>
VPCConfig Pulumi.AwsNative.Synthetics.Inputs.CanaryVPCConfigArgs

Provide VPC Configuration if enabled.

VisualReference Pulumi.AwsNative.Synthetics.Inputs.CanaryVisualReferenceArgs

Visual reference configuration for visual testing

ArtifactS3Location string

Provide the s3 bucket output location for test results

Code CanaryCodeArgs

Provide the canary script source

ExecutionRoleArn string

Lambda Execution role used to run your canaries

RuntimeVersion string

Runtime version of Synthetics Library

Schedule CanaryScheduleArgs

Frequency to run your canaries

StartCanaryAfterCreation bool

Runs canary if set to True. Default is False

ArtifactConfig CanaryArtifactConfigArgs

Provide artifact configuration

DeleteLambdaResourcesOnCanaryDeletion bool

Deletes associated lambda resources created by Synthetics if set to True. Default is False

FailureRetentionPeriod int

Retention period of failed canary runs represented in number of days

Name string

Name of the canary.

RunConfig CanaryRunConfigArgs

Provide canary run configuration

SuccessRetentionPeriod int

Retention period of successful canary runs represented in number of days

Tags []CanaryTagArgs
VPCConfig CanaryVPCConfigArgs

Provide VPC Configuration if enabled.

VisualReference CanaryVisualReferenceArgs

Visual reference configuration for visual testing

artifactS3Location String

Provide the s3 bucket output location for test results

code CanaryCodeArgs

Provide the canary script source

executionRoleArn String

Lambda Execution role used to run your canaries

runtimeVersion String

Runtime version of Synthetics Library

schedule CanaryScheduleArgs

Frequency to run your canaries

startCanaryAfterCreation Boolean

Runs canary if set to True. Default is False

artifactConfig CanaryArtifactConfigArgs

Provide artifact configuration

deleteLambdaResourcesOnCanaryDeletion Boolean

Deletes associated lambda resources created by Synthetics if set to True. Default is False

failureRetentionPeriod Integer

Retention period of failed canary runs represented in number of days

name String

Name of the canary.

runConfig CanaryRunConfigArgs

Provide canary run configuration

successRetentionPeriod Integer

Retention period of successful canary runs represented in number of days

tags List<CanaryTagArgs>
vPCConfig CanaryVPCConfigArgs

Provide VPC Configuration if enabled.

visualReference CanaryVisualReferenceArgs

Visual reference configuration for visual testing

artifactS3Location string

Provide the s3 bucket output location for test results

code CanaryCodeArgs

Provide the canary script source

executionRoleArn string

Lambda Execution role used to run your canaries

runtimeVersion string

Runtime version of Synthetics Library

schedule CanaryScheduleArgs

Frequency to run your canaries

startCanaryAfterCreation boolean

Runs canary if set to True. Default is False

artifactConfig CanaryArtifactConfigArgs

Provide artifact configuration

deleteLambdaResourcesOnCanaryDeletion boolean

Deletes associated lambda resources created by Synthetics if set to True. Default is False

failureRetentionPeriod number

Retention period of failed canary runs represented in number of days

name string

Name of the canary.

runConfig CanaryRunConfigArgs

Provide canary run configuration

successRetentionPeriod number

Retention period of successful canary runs represented in number of days

tags CanaryTagArgs[]
vPCConfig CanaryVPCConfigArgs

Provide VPC Configuration if enabled.

visualReference CanaryVisualReferenceArgs

Visual reference configuration for visual testing

artifact_s3_location str

Provide the s3 bucket output location for test results

code CanaryCodeArgs

Provide the canary script source

execution_role_arn str

Lambda Execution role used to run your canaries

runtime_version str

Runtime version of Synthetics Library

schedule CanaryScheduleArgs

Frequency to run your canaries

start_canary_after_creation bool

Runs canary if set to True. Default is False

artifact_config CanaryArtifactConfigArgs

Provide artifact configuration

delete_lambda_resources_on_canary_deletion bool

Deletes associated lambda resources created by Synthetics if set to True. Default is False

failure_retention_period int

Retention period of failed canary runs represented in number of days

name str

Name of the canary.

run_config CanaryRunConfigArgs

Provide canary run configuration

success_retention_period int

Retention period of successful canary runs represented in number of days

tags Sequence[CanaryTagArgs]
v_pc_config CanaryVPCConfigArgs

Provide VPC Configuration if enabled.

visual_reference CanaryVisualReferenceArgs

Visual reference configuration for visual testing

artifactS3Location String

Provide the s3 bucket output location for test results

code Property Map

Provide the canary script source

executionRoleArn String

Lambda Execution role used to run your canaries

runtimeVersion String

Runtime version of Synthetics Library

schedule Property Map

Frequency to run your canaries

startCanaryAfterCreation Boolean

Runs canary if set to True. Default is False

artifactConfig Property Map

Provide artifact configuration

deleteLambdaResourcesOnCanaryDeletion Boolean

Deletes associated lambda resources created by Synthetics if set to True. Default is False

failureRetentionPeriod Number

Retention period of failed canary runs represented in number of days

name String

Name of the canary.

runConfig Property Map

Provide canary run configuration

successRetentionPeriod Number

Retention period of successful canary runs represented in number of days

tags List<Property Map>
vPCConfig Property Map

Provide VPC Configuration if enabled.

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

Id string

The provider-assigned unique ID for this managed resource.

State string

State of the canary

Id string

The provider-assigned unique ID for this managed resource.

State string

State of the canary

id String

The provider-assigned unique ID for this managed resource.

state String

State of the canary

id string

The provider-assigned unique ID for this managed resource.

state string

State of the canary

id str

The provider-assigned unique ID for this managed resource.

state str

State of the canary

id String

The provider-assigned unique ID for this managed resource.

state String

State of the canary

Supporting Types

CanaryArtifactConfig

S3Encryption Pulumi.AwsNative.Synthetics.Inputs.CanaryS3Encryption

Encryption configuration for uploading artifacts to S3

S3Encryption CanaryS3Encryption

Encryption configuration for uploading artifacts to S3

s3Encryption CanaryS3Encryption

Encryption configuration for uploading artifacts to S3

s3Encryption CanaryS3Encryption

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

ScreenshotName string

Name of the screenshot to be used as base reference for visual testing

IgnoreCoordinates List<string>

List of coordinates of rectangles to be ignored during visual testing

ScreenshotName string

Name of the screenshot to be used as base reference for visual testing

IgnoreCoordinates []string

List of coordinates of rectangles to be ignored during visual testing

screenshotName String

Name of the screenshot to be used as base reference for visual testing

ignoreCoordinates List<String>

List of coordinates of rectangles to be ignored during visual testing

screenshotName string

Name of the screenshot to be used as base reference for visual testing

ignoreCoordinates 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

screenshotName String

Name of the screenshot to be used as base reference for visual testing

ignoreCoordinates List<String>

List of coordinates of rectangles to be ignored during visual testing

CanaryCode

Handler string
S3Bucket string
S3Key string
S3ObjectVersion string
Script string
Handler string
S3Bucket string
S3Key string
S3ObjectVersion string
Script string
handler String
s3Bucket String
s3Key String
s3ObjectVersion String
script String
handler string
s3Bucket string
s3Key string
s3ObjectVersion string
script string
handler String
s3Bucket String
s3Key String
s3ObjectVersion String
script String

CanaryRunConfig

ActiveTracing bool

Enable active tracing if set to true

EnvironmentVariables object

Environment variable key-value pairs.

MemoryInMB int

Provide maximum memory available for canary in MB

TimeoutInSeconds int

Provide maximum canary timeout per run in seconds

ActiveTracing bool

Enable active tracing if set to true

EnvironmentVariables interface{}

Environment variable key-value pairs.

MemoryInMB int

Provide maximum memory available for canary in MB

TimeoutInSeconds int

Provide maximum canary timeout per run in seconds

activeTracing Boolean

Enable active tracing if set to true

environmentVariables Object

Environment variable key-value pairs.

memoryInMB Integer

Provide maximum memory available for canary in MB

timeoutInSeconds Integer

Provide maximum canary timeout per run in seconds

activeTracing boolean

Enable active tracing if set to true

environmentVariables any

Environment variable key-value pairs.

memoryInMB number

Provide maximum memory available for canary in MB

timeoutInSeconds number

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_mb int

Provide maximum memory available for canary in MB

timeout_in_seconds int

Provide maximum canary timeout per run in seconds

activeTracing Boolean

Enable active tracing if set to true

environmentVariables Any

Environment variable key-value pairs.

memoryInMB Number

Provide maximum memory available for canary in MB

timeoutInSeconds Number

Provide maximum canary timeout per run in seconds

CanaryS3Encryption

EncryptionMode string

Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.

KmsKeyArn string

KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.

EncryptionMode string

Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.

KmsKeyArn string

KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.

encryptionMode String

Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.

kmsKeyArn String

KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.

encryptionMode string

Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.

kmsKeyArn string

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_arn str

KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.

encryptionMode String

Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.

kmsKeyArn String

KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.

CanarySchedule

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

SecurityGroupIds List<string>
SubnetIds List<string>
VpcId string
SecurityGroupIds []string
SubnetIds []string
VpcId string
securityGroupIds List<String>
subnetIds List<String>
vpcId String
securityGroupIds string[]
subnetIds string[]
vpcId string
security_group_ids Sequence[str]
subnet_ids Sequence[str]
vpc_id str
securityGroupIds List<String>
subnetIds List<String>
vpcId String

CanaryVisualReference

BaseCanaryRunId string

Canary run id to be used as base reference for visual testing

BaseScreenshots List<Pulumi.AwsNative.Synthetics.Inputs.CanaryBaseScreenshot>

List of screenshots used as base reference for visual testing

BaseCanaryRunId string

Canary run id to be used as base reference for visual testing

BaseScreenshots []CanaryBaseScreenshot

List of screenshots used as base reference for visual testing

baseCanaryRunId String

Canary run id to be used as base reference for visual testing

baseScreenshots List<CanaryBaseScreenshot>

List of screenshots used as base reference for visual testing

baseCanaryRunId string

Canary run id to be used as base reference for visual testing

baseScreenshots CanaryBaseScreenshot[]

List of screenshots used as base reference for visual testing

base_canary_run_id str

Canary run id to be used as base reference for visual testing

base_screenshots Sequence[CanaryBaseScreenshot]

List of screenshots used as base reference for visual testing

baseCanaryRunId String

Canary run id to be used as base reference for visual testing

baseScreenshots List<Property Map>

List of screenshots used as base reference for visual testing

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0