getCanary

Resource Type definition for AWS::Synthetics::Canary

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.

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)
// Output-based functions aren't available in Java yet
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

DeleteLambdaResourcesOnCanaryDeletion bool

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

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

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

StartCanaryAfterCreation bool

Runs canary if set to True. Default is False

State string

State of the canary

SuccessRetentionPeriod int

Retention period of successful canary runs represented in number of days

Tags List<Pulumi.AwsNative.Synthetics.Outputs.CanaryTag>
VPCConfig Pulumi.AwsNative.Synthetics.Outputs.CanaryVPCConfig

Provide VPC Configuration if enabled.

VisualReference Pulumi.AwsNative.Synthetics.Outputs.CanaryVisualReference

Visual reference configuration for visual testing

ArtifactConfig CanaryArtifactConfig

Provide artifact configuration

ArtifactS3Location string

Provide the s3 bucket output location for test results

Code CanaryCode

Provide the canary script source

DeleteLambdaResourcesOnCanaryDeletion bool

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

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

RunConfig CanaryRunConfig

Provide canary run configuration

RuntimeVersion string

Runtime version of Synthetics Library

Schedule CanarySchedule

Frequency to run your canaries

StartCanaryAfterCreation bool

Runs canary if set to True. Default is False

State string

State of the canary

SuccessRetentionPeriod int

Retention period of successful canary runs represented in number of days

Tags []CanaryTag
VPCConfig CanaryVPCConfig

Provide VPC Configuration if enabled.

VisualReference CanaryVisualReference

Visual reference configuration for visual testing

artifactConfig CanaryArtifactConfig

Provide artifact configuration

artifactS3Location String

Provide the s3 bucket output location for test results

code CanaryCode

Provide the canary script source

deleteLambdaResourcesOnCanaryDeletion Boolean

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

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

runConfig CanaryRunConfig

Provide canary run configuration

runtimeVersion String

Runtime version of Synthetics Library

schedule CanarySchedule

Frequency to run your canaries

startCanaryAfterCreation Boolean

Runs canary if set to True. Default is False

state String

State of the canary

successRetentionPeriod Integer

Retention period of successful canary runs represented in number of days

tags List<CanaryTag>
vPCConfig CanaryVPCConfig

Provide VPC Configuration if enabled.

visualReference CanaryVisualReference

Visual reference configuration for visual testing

artifactConfig CanaryArtifactConfig

Provide artifact configuration

artifactS3Location string

Provide the s3 bucket output location for test results

code CanaryCode

Provide the canary script source

deleteLambdaResourcesOnCanaryDeletion boolean

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

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

runConfig CanaryRunConfig

Provide canary run configuration

runtimeVersion string

Runtime version of Synthetics Library

schedule CanarySchedule

Frequency to run your canaries

startCanaryAfterCreation boolean

Runs canary if set to True. Default is False

state string

State of the canary

successRetentionPeriod number

Retention period of successful canary runs represented in number of days

tags CanaryTag[]
vPCConfig CanaryVPCConfig

Provide VPC Configuration if enabled.

visualReference CanaryVisualReference

Visual reference configuration for visual testing

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

delete_lambda_resources_on_canary_deletion bool

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

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

run_config CanaryRunConfig

Provide canary run configuration

runtime_version str

Runtime version of Synthetics Library

schedule CanarySchedule

Frequency to run your canaries

start_canary_after_creation bool

Runs canary if set to True. Default is False

state str

State of the canary

success_retention_period int

Retention period of successful canary runs represented in number of days

tags Sequence[CanaryTag]
v_pc_config CanaryVPCConfig

Provide VPC Configuration if enabled.

visual_reference CanaryVisualReference

Visual reference configuration for visual testing

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

deleteLambdaResourcesOnCanaryDeletion Boolean

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

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

runConfig Property Map

Provide canary run configuration

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

state String

State of the canary

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

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