AWS Cloud Control v1.27.0, Apr 14 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.synthetics.getCanary

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Using getCanary

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getCanary(args: GetCanaryArgs, opts?: InvokeOptions): Promise<GetCanaryResult>
function getCanaryOutput(args: GetCanaryOutputArgs, opts?: InvokeOptions): Output<GetCanaryResult>

def get_canary(name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetCanaryResult
def get_canary_output(name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetCanaryResult]

func LookupCanary(ctx *Context, args *LookupCanaryArgs, opts ...InvokeOption) (*LookupCanaryResult, error)
func LookupCanaryOutput(ctx *Context, args *LookupCanaryOutputArgs, opts ...InvokeOption) LookupCanaryResultOutput

> Note: This function is named LookupCanary in the Go SDK.

public static class GetCanary 
{
    public static Task<GetCanaryResult> InvokeAsync(GetCanaryArgs args, InvokeOptions? opts = null)
    public static Output<GetCanaryResult> Invoke(GetCanaryInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCanaryResult> getCanary(GetCanaryArgs args, InvokeOptions options)
public static Output<GetCanaryResult> getCanary(GetCanaryArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:synthetics:getCanary
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the canary.

Name string: Name of the canary.

name String: Name of the canary.

name string: Name of the canary.

name str: Name of the canary.

name String: Name of the canary.

getCanary Result

The following output properties are available:

ArtifactConfig Pulumi.AwsNative.Synthetics.Outputs.CanaryArtifactConfig: Provide artifact configuration
ArtifactS3Location string: Provide the s3 bucket output location for test results
Code Pulumi.AwsNative.Synthetics.Outputs.CanaryCode: Provide the canary script source
ExecutionRoleArn string: Lambda Execution role used to run your canaries
FailureRetentionPeriod int: Retention period of failed canary runs represented in number of days
Id string: Id of the canary
ProvisionedResourceCleanup Pulumi.AwsNative.Synthetics.CanaryProvisionedResourceCleanup: Setting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC.
RunConfig Pulumi.AwsNative.Synthetics.Outputs.CanaryRunConfig: Provide canary run configuration
RuntimeVersion string: Runtime version of Synthetics Library
Schedule Pulumi.AwsNative.Synthetics.Outputs.CanarySchedule: Frequency to run your canaries
State string: State of the canary
SuccessRetentionPeriod int: Retention period of successful canary runs represented in number of days
Tags List<Pulumi.AwsNative.Outputs.Tag>: The list of key-value pairs that are associated with the canary.
VpcConfig Pulumi.AwsNative.Synthetics.Outputs.CanaryVpcConfig: Provide VPC Configuration if enabled.

ArtifactConfig CanaryArtifactConfig: Provide artifact configuration
ArtifactS3Location string: Provide the s3 bucket output location for test results
Code CanaryCode: Provide the canary script source
ExecutionRoleArn string: Lambda Execution role used to run your canaries
FailureRetentionPeriod int: Retention period of failed canary runs represented in number of days
Id string: Id of the canary
ProvisionedResourceCleanup CanaryProvisionedResourceCleanup: Setting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC.
RunConfig CanaryRunConfig: Provide canary run configuration
RuntimeVersion string: Runtime version of Synthetics Library
Schedule CanarySchedule: Frequency to run your canaries
State string: State of the canary
SuccessRetentionPeriod int: Retention period of successful canary runs represented in number of days
Tags Tag: The list of key-value pairs that are associated with the canary.
VpcConfig CanaryVpcConfig: Provide VPC Configuration if enabled.

artifactConfig CanaryArtifactConfig: Provide artifact configuration
artifactS3Location String: Provide the s3 bucket output location for test results
code CanaryCode: Provide the canary script source
executionRoleArn String: Lambda Execution role used to run your canaries
failureRetentionPeriod Integer: Retention period of failed canary runs represented in number of days
id String: Id of the canary
provisionedResourceCleanup CanaryProvisionedResourceCleanup: Setting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC.
runConfig CanaryRunConfig: Provide canary run configuration
runtimeVersion String: Runtime version of Synthetics Library
schedule CanarySchedule: Frequency to run your canaries
state String: State of the canary
successRetentionPeriod Integer: Retention period of successful canary runs represented in number of days
tags List<Tag>: The list of key-value pairs that are associated with the canary.
vpcConfig CanaryVpcConfig: Provide VPC Configuration if enabled.

artifactConfig CanaryArtifactConfig: Provide artifact configuration
artifactS3Location string: Provide the s3 bucket output location for test results
code CanaryCode: Provide the canary script source
executionRoleArn string: Lambda Execution role used to run your canaries
failureRetentionPeriod number: Retention period of failed canary runs represented in number of days
id string: Id of the canary
provisionedResourceCleanup CanaryProvisionedResourceCleanup: Setting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC.
runConfig CanaryRunConfig: Provide canary run configuration
runtimeVersion string: Runtime version of Synthetics Library
schedule CanarySchedule: Frequency to run your canaries
state string: State of the canary
successRetentionPeriod number: Retention period of successful canary runs represented in number of days
tags Tag[]: The list of key-value pairs that are associated with the canary.
vpcConfig CanaryVpcConfig: Provide VPC Configuration if enabled.

artifact_config CanaryArtifactConfig: Provide artifact configuration
artifact_s3_location str: Provide the s3 bucket output location for test results
code CanaryCode: Provide the canary script source
execution_role_arn str: Lambda Execution role used to run your canaries
failure_retention_period int: Retention period of failed canary runs represented in number of days
id str: Id of the canary
provisioned_resource_cleanup CanaryProvisionedResourceCleanup: Setting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC.
run_config CanaryRunConfig: Provide canary run configuration
runtime_version str: Runtime version of Synthetics Library
schedule CanarySchedule: Frequency to run your canaries
state str: State of the canary
success_retention_period int: Retention period of successful canary runs represented in number of days
tags Sequence[root_Tag]: The list of key-value pairs that are associated with the canary.
vpc_config CanaryVpcConfig: Provide VPC Configuration if enabled.

artifactConfig Property Map: Provide artifact configuration
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
failureRetentionPeriod Number: Retention period of failed canary runs represented in number of days
id String: Id of the canary
provisionedResourceCleanup "AUTOMATIC" | "OFF": Setting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC.
runConfig Property Map: Provide canary run configuration
runtimeVersion String: Runtime version of Synthetics Library
schedule Property Map: Frequency to run your canaries
state String: State of the canary
successRetentionPeriod Number: Retention period of successful canary runs represented in number of days
tags List<Property Map>: The list of key-value pairs that are associated with the canary.
vpcConfig Property Map: Provide VPC Configuration if enabled.

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

CanaryCode

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* .
S3Bucket string: If your canary script is located in S3, specify the bucket name here. The bucket must already exist.
S3Key string: The S3 key of your script. For more information, see Working with Amazon S3 Objects .
S3ObjectVersion string: The S3 version ID of your script.
Script string: 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.
SourceLocationArn string: The ARN of the Lambda layer where Synthetics stores the canary script 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* .
S3Bucket string: If your canary script is located in S3, specify the bucket name here. The bucket must already exist.
S3Key string: The S3 key of your script. For more information, see Working with Amazon S3 Objects .
S3ObjectVersion string: The S3 version ID of your script.
Script string: 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.
SourceLocationArn string: The ARN of the Lambda layer where Synthetics stores the canary script 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* .
s3Bucket String: If your canary script is located in S3, specify the bucket name here. The bucket must already exist.
s3Key String: The S3 key of your script. For more information, see Working with Amazon S3 Objects .
s3ObjectVersion String: The S3 version ID of your script.
script String: 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.
sourceLocationArn String: The ARN of the Lambda layer where Synthetics stores the canary script 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* .
s3Bucket string: If your canary script is located in S3, specify the bucket name here. The bucket must already exist.
s3Key string: The S3 key of your script. For more information, see Working with Amazon S3 Objects .
s3ObjectVersion string: The S3 version ID of your script.
script string: 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.
sourceLocationArn string: The ARN of the Lambda layer where Synthetics stores the canary script code.

handler str: 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* .
s3_bucket str: If your canary script is located in S3, specify the bucket name here. The bucket must already exist.
s3_key str: The S3 key of your script. For more information, see Working with Amazon S3 Objects .
s3_object_version str: The S3 version ID of your script.
script str: 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.
source_location_arn str: The ARN of the Lambda layer where Synthetics stores the canary script 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* .
s3Bucket String: If your canary script is located in S3, specify the bucket name here. The bucket must already exist.
s3Key String: The S3 key of your script. For more information, see Working with Amazon S3 Objects .
s3ObjectVersion String: The S3 version ID of your script.
script String: 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.
sourceLocationArn String: The ARN of the Lambda layer where Synthetics stores the canary script code.

CanaryProvisionedResourceCleanup

CanaryRunConfig

ActiveTracing bool: Enable active tracing if set to true
EnvironmentVariables Dictionary<string, string>: 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 map[string]string: 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 Map<String,String>: 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 {[key: string]: string}: 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 Mapping[str, str]: 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 Map<String>: 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

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 .

DurationInSeconds string

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.

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 .

Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

DurationInSeconds string

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 .

Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

durationInSeconds String

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 .

Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

durationInSeconds string

expression str

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 .

Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

duration_in_seconds str

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 .

Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

durationInSeconds String

CanaryVpcConfig

SecurityGroupIds List<string>: The IDs of the security groups for this canary.
SubnetIds List<string>: The IDs of the subnets where this canary is to run.
Ipv6AllowedForDualStack bool: Allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets if set to true
VpcId string: The ID of the VPC where this canary is to run.

SecurityGroupIds []string: The IDs of the security groups for this canary.
SubnetIds []string: The IDs of the subnets where this canary is to run.
Ipv6AllowedForDualStack bool: Allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets if set to true
VpcId string: The ID of the VPC where this canary is to run.

securityGroupIds List<String>: The IDs of the security groups for this canary.
subnetIds List<String>: The IDs of the subnets where this canary is to run.
ipv6AllowedForDualStack Boolean: Allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets if set to true
vpcId String: The ID of the VPC where this canary is to run.

securityGroupIds string[]: The IDs of the security groups for this canary.
subnetIds string[]: The IDs of the subnets where this canary is to run.
ipv6AllowedForDualStack boolean: Allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets if set to true
vpcId string: The ID of the VPC where this canary is to run.

security_group_ids Sequence[str]: The IDs of the security groups for this canary.
subnet_ids Sequence[str]: The IDs of the subnets where this canary is to run.
ipv6_allowed_for_dual_stack bool: Allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets if set to true
vpc_id str: The ID of the VPC where this canary is to run.

securityGroupIds List<String>: The IDs of the security groups for this canary.
subnetIds List<String>: The IDs of the subnets where this canary is to run.
ipv6AllowedForDualStack Boolean: Allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets if set to true
vpcId String: The ID of the VPC where this canary is to run.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.synthetics.getCanary

On this page

On this page

Using getCanary

getCanary Result

Supporting Types

CanaryArtifactConfig

CanaryCode

CanaryProvisionedResourceCleanup

CanaryRunConfig

CanaryS3Encryption

CanarySchedule

CanaryVpcConfig

Tag

Package Details

On this page

On this page