github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/synthetics/canary.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package synthetics

import (
	"context"
	"reflect"

	"errors"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Provides a Synthetics Canary resource.
//
// > **NOTE:** When you create a canary, AWS creates supporting implicit resources. See the Amazon CloudWatch Synthetics documentation on [DeleteCanary](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html) for a full list. Neither AWS nor this provider deletes these implicit resources automatically when the canary is deleted. Before deleting a canary, ensure you have all the information about the canary that you need to delete the implicit resources using the AWS Console, or AWS CLI.
//
// ## Example Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/synthetics"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			_, err := synthetics.NewCanary(ctx, "some", &synthetics.CanaryArgs{
//				Name:               pulumi.String("some-canary"),
//				ArtifactS3Location: pulumi.String("s3://some-bucket/"),
//				ExecutionRoleArn:   pulumi.String("some-role"),
//				Handler:            pulumi.String("exports.handler"),
//				ZipFile:            pulumi.String("test-fixtures/lambdatest.zip"),
//				RuntimeVersion:     pulumi.String("syn-1.0"),
//				Schedule: &synthetics.CanaryScheduleArgs{
//					Expression: pulumi.String("rate(0 minute)"),
//				},
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ## Import
//
// Using `pulumi import`, import Synthetics Canaries using the `name`. For example:
//
// ```sh
// $ pulumi import aws:synthetics/canary:Canary some some-canary
// ```
type Canary struct {
	pulumi.CustomResourceState

	// Amazon Resource Name (ARN) of the Canary.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.
	ArtifactConfig CanaryArtifactConfigPtrOutput `pulumi:"artifactConfig"`
	// Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
	ArtifactS3Location pulumi.StringOutput `pulumi:"artifactS3Location"`
	// Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.
	DeleteLambda pulumi.BoolPtrOutput `pulumi:"deleteLambda"`
	// ARN of the Lambda function that is used as your canary's engine.
	EngineArn pulumi.StringOutput `pulumi:"engineArn"`
	// ARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.
	ExecutionRoleArn pulumi.StringOutput `pulumi:"executionRoleArn"`
	// Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
	FailureRetentionPeriod pulumi.IntPtrOutput `pulumi:"failureRetentionPeriod"`
	// Entry point to use for the source code when running the canary. This value must end with the string `.handler` .
	Handler pulumi.StringOutput `pulumi:"handler"`
	// Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.
	Name pulumi.StringOutput `pulumi:"name"`
	// Configuration block for individual canary runs. Detailed below.
	RunConfig CanaryRunConfigOutput `pulumi:"runConfig"`
	// Runtime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.
	RuntimeVersion pulumi.StringOutput `pulumi:"runtimeVersion"`
	// Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**
	S3Bucket pulumi.StringPtrOutput `pulumi:"s3Bucket"`
	// S3 key of your script. **Conflicts with `zipFile`.**
	S3Key pulumi.StringPtrOutput `pulumi:"s3Key"`
	// S3 version ID of your script. **Conflicts with `zipFile`.**
	S3Version pulumi.StringPtrOutput `pulumi:"s3Version"`
	// Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.
	//
	// The following arguments are optional:
	Schedule CanaryScheduleOutput `pulumi:"schedule"`
	// ARN of the Lambda layer where Synthetics stores the canary script code.
	SourceLocationArn pulumi.StringOutput `pulumi:"sourceLocationArn"`
	// Whether to run or stop the canary.
	StartCanary pulumi.BoolPtrOutput `pulumi:"startCanary"`
	// Canary status.
	Status pulumi.StringOutput `pulumi:"status"`
	// Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
	SuccessRetentionPeriod pulumi.IntPtrOutput `pulumi:"successRetentionPeriod"`
	// Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
	// Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.
	Timelines CanaryTimelineArrayOutput `pulumi:"timelines"`
	// Configuration block. Detailed below.
	VpcConfig CanaryVpcConfigPtrOutput `pulumi:"vpcConfig"`
	// ZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**
	ZipFile pulumi.StringPtrOutput `pulumi:"zipFile"`
}

// NewCanary registers a new resource with the given unique name, arguments, and options.
func NewCanary(ctx *pulumi.Context,
	name string, args *CanaryArgs, opts ...pulumi.ResourceOption) (*Canary, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.ArtifactS3Location == nil {
		return nil, errors.New("invalid value for required argument 'ArtifactS3Location'")
	}
	if args.ExecutionRoleArn == nil {
		return nil, errors.New("invalid value for required argument 'ExecutionRoleArn'")
	}
	if args.Handler == nil {
		return nil, errors.New("invalid value for required argument 'Handler'")
	}
	if args.RuntimeVersion == nil {
		return nil, errors.New("invalid value for required argument 'RuntimeVersion'")
	}
	if args.Schedule == nil {
		return nil, errors.New("invalid value for required argument 'Schedule'")
	}
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource Canary
	err := ctx.RegisterResource("aws:synthetics/canary:Canary", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetCanary gets an existing Canary resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetCanary(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CanaryState, opts ...pulumi.ResourceOption) (*Canary, error) {
	var resource Canary
	err := ctx.ReadResource("aws:synthetics/canary:Canary", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering Canary resources.
type canaryState struct {
	// Amazon Resource Name (ARN) of the Canary.
	Arn *string `pulumi:"arn"`
	// configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.
	ArtifactConfig *CanaryArtifactConfig `pulumi:"artifactConfig"`
	// Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
	ArtifactS3Location *string `pulumi:"artifactS3Location"`
	// Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.
	DeleteLambda *bool `pulumi:"deleteLambda"`
	// ARN of the Lambda function that is used as your canary's engine.
	EngineArn *string `pulumi:"engineArn"`
	// ARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.
	ExecutionRoleArn *string `pulumi:"executionRoleArn"`
	// Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
	FailureRetentionPeriod *int `pulumi:"failureRetentionPeriod"`
	// Entry point to use for the source code when running the canary. This value must end with the string `.handler` .
	Handler *string `pulumi:"handler"`
	// Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.
	Name *string `pulumi:"name"`
	// Configuration block for individual canary runs. Detailed below.
	RunConfig *CanaryRunConfig `pulumi:"runConfig"`
	// Runtime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.
	RuntimeVersion *string `pulumi:"runtimeVersion"`
	// Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**
	S3Bucket *string `pulumi:"s3Bucket"`
	// S3 key of your script. **Conflicts with `zipFile`.**
	S3Key *string `pulumi:"s3Key"`
	// S3 version ID of your script. **Conflicts with `zipFile`.**
	S3Version *string `pulumi:"s3Version"`
	// Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.
	//
	// The following arguments are optional:
	Schedule *CanarySchedule `pulumi:"schedule"`
	// ARN of the Lambda layer where Synthetics stores the canary script code.
	SourceLocationArn *string `pulumi:"sourceLocationArn"`
	// Whether to run or stop the canary.
	StartCanary *bool `pulumi:"startCanary"`
	// Canary status.
	Status *string `pulumi:"status"`
	// Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
	SuccessRetentionPeriod *int `pulumi:"successRetentionPeriod"`
	// Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags map[string]string `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll map[string]string `pulumi:"tagsAll"`
	// Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.
	Timelines []CanaryTimeline `pulumi:"timelines"`
	// Configuration block. Detailed below.
	VpcConfig *CanaryVpcConfig `pulumi:"vpcConfig"`
	// ZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**
	ZipFile *string `pulumi:"zipFile"`
}

type CanaryState struct {
	// Amazon Resource Name (ARN) of the Canary.
	Arn pulumi.StringPtrInput
	// configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.
	ArtifactConfig CanaryArtifactConfigPtrInput
	// Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
	ArtifactS3Location pulumi.StringPtrInput
	// Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.
	DeleteLambda pulumi.BoolPtrInput
	// ARN of the Lambda function that is used as your canary's engine.
	EngineArn pulumi.StringPtrInput
	// ARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.
	ExecutionRoleArn pulumi.StringPtrInput
	// Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
	FailureRetentionPeriod pulumi.IntPtrInput
	// Entry point to use for the source code when running the canary. This value must end with the string `.handler` .
	Handler pulumi.StringPtrInput
	// Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.
	Name pulumi.StringPtrInput
	// Configuration block for individual canary runs. Detailed below.
	RunConfig CanaryRunConfigPtrInput
	// Runtime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.
	RuntimeVersion pulumi.StringPtrInput
	// Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**
	S3Bucket pulumi.StringPtrInput
	// S3 key of your script. **Conflicts with `zipFile`.**
	S3Key pulumi.StringPtrInput
	// S3 version ID of your script. **Conflicts with `zipFile`.**
	S3Version pulumi.StringPtrInput
	// Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.
	//
	// The following arguments are optional:
	Schedule CanarySchedulePtrInput
	// ARN of the Lambda layer where Synthetics stores the canary script code.
	SourceLocationArn pulumi.StringPtrInput
	// Whether to run or stop the canary.
	StartCanary pulumi.BoolPtrInput
	// Canary status.
	Status pulumi.StringPtrInput
	// Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
	SuccessRetentionPeriod pulumi.IntPtrInput
	// Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapInput
	// Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.
	Timelines CanaryTimelineArrayInput
	// Configuration block. Detailed below.
	VpcConfig CanaryVpcConfigPtrInput
	// ZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**
	ZipFile pulumi.StringPtrInput
}

func (CanaryState) ElementType() reflect.Type {
	return reflect.TypeOf((*canaryState)(nil)).Elem()
}

type canaryArgs struct {
	// configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.
	ArtifactConfig *CanaryArtifactConfig `pulumi:"artifactConfig"`
	// Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
	ArtifactS3Location string `pulumi:"artifactS3Location"`
	// Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.
	DeleteLambda *bool `pulumi:"deleteLambda"`
	// ARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.
	ExecutionRoleArn string `pulumi:"executionRoleArn"`
	// Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
	FailureRetentionPeriod *int `pulumi:"failureRetentionPeriod"`
	// Entry point to use for the source code when running the canary. This value must end with the string `.handler` .
	Handler string `pulumi:"handler"`
	// Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.
	Name *string `pulumi:"name"`
	// Configuration block for individual canary runs. Detailed below.
	RunConfig *CanaryRunConfig `pulumi:"runConfig"`
	// Runtime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.
	RuntimeVersion string `pulumi:"runtimeVersion"`
	// Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**
	S3Bucket *string `pulumi:"s3Bucket"`
	// S3 key of your script. **Conflicts with `zipFile`.**
	S3Key *string `pulumi:"s3Key"`
	// S3 version ID of your script. **Conflicts with `zipFile`.**
	S3Version *string `pulumi:"s3Version"`
	// Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.
	//
	// The following arguments are optional:
	Schedule CanarySchedule `pulumi:"schedule"`
	// Whether to run or stop the canary.
	StartCanary *bool `pulumi:"startCanary"`
	// Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
	SuccessRetentionPeriod *int `pulumi:"successRetentionPeriod"`
	// Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags map[string]string `pulumi:"tags"`
	// Configuration block. Detailed below.
	VpcConfig *CanaryVpcConfig `pulumi:"vpcConfig"`
	// ZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**
	ZipFile *string `pulumi:"zipFile"`
}

// The set of arguments for constructing a Canary resource.
type CanaryArgs struct {
	// configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.
	ArtifactConfig CanaryArtifactConfigPtrInput
	// Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
	ArtifactS3Location pulumi.StringInput
	// Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.
	DeleteLambda pulumi.BoolPtrInput
	// ARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.
	ExecutionRoleArn pulumi.StringInput
	// Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
	FailureRetentionPeriod pulumi.IntPtrInput
	// Entry point to use for the source code when running the canary. This value must end with the string `.handler` .
	Handler pulumi.StringInput
	// Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.
	Name pulumi.StringPtrInput
	// Configuration block for individual canary runs. Detailed below.
	RunConfig CanaryRunConfigPtrInput
	// Runtime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.
	RuntimeVersion pulumi.StringInput
	// Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**
	S3Bucket pulumi.StringPtrInput
	// S3 key of your script. **Conflicts with `zipFile`.**
	S3Key pulumi.StringPtrInput
	// S3 version ID of your script. **Conflicts with `zipFile`.**
	S3Version pulumi.StringPtrInput
	// Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.
	//
	// The following arguments are optional:
	Schedule CanaryScheduleInput
	// Whether to run or stop the canary.
	StartCanary pulumi.BoolPtrInput
	// Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
	SuccessRetentionPeriod pulumi.IntPtrInput
	// Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// Configuration block. Detailed below.
	VpcConfig CanaryVpcConfigPtrInput
	// ZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**
	ZipFile pulumi.StringPtrInput
}

func (CanaryArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*canaryArgs)(nil)).Elem()
}

type CanaryInput interface {
	pulumi.Input

	ToCanaryOutput() CanaryOutput
	ToCanaryOutputWithContext(ctx context.Context) CanaryOutput
}

func (*Canary) ElementType() reflect.Type {
	return reflect.TypeOf((**Canary)(nil)).Elem()
}

func (i *Canary) ToCanaryOutput() CanaryOutput {
	return i.ToCanaryOutputWithContext(context.Background())
}

func (i *Canary) ToCanaryOutputWithContext(ctx context.Context) CanaryOutput {
	return pulumi.ToOutputWithContext(ctx, i).(CanaryOutput)
}

// CanaryArrayInput is an input type that accepts CanaryArray and CanaryArrayOutput values.
// You can construct a concrete instance of `CanaryArrayInput` via:
//
//	CanaryArray{ CanaryArgs{...} }
type CanaryArrayInput interface {
	pulumi.Input

	ToCanaryArrayOutput() CanaryArrayOutput
	ToCanaryArrayOutputWithContext(context.Context) CanaryArrayOutput
}

type CanaryArray []CanaryInput

func (CanaryArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*Canary)(nil)).Elem()
}

func (i CanaryArray) ToCanaryArrayOutput() CanaryArrayOutput {
	return i.ToCanaryArrayOutputWithContext(context.Background())
}

func (i CanaryArray) ToCanaryArrayOutputWithContext(ctx context.Context) CanaryArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(CanaryArrayOutput)
}

// CanaryMapInput is an input type that accepts CanaryMap and CanaryMapOutput values.
// You can construct a concrete instance of `CanaryMapInput` via:
//
//	CanaryMap{ "key": CanaryArgs{...} }
type CanaryMapInput interface {
	pulumi.Input

	ToCanaryMapOutput() CanaryMapOutput
	ToCanaryMapOutputWithContext(context.Context) CanaryMapOutput
}

type CanaryMap map[string]CanaryInput

func (CanaryMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*Canary)(nil)).Elem()
}

func (i CanaryMap) ToCanaryMapOutput() CanaryMapOutput {
	return i.ToCanaryMapOutputWithContext(context.Background())
}

func (i CanaryMap) ToCanaryMapOutputWithContext(ctx context.Context) CanaryMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(CanaryMapOutput)
}

type CanaryOutput struct{ *pulumi.OutputState }

func (CanaryOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**Canary)(nil)).Elem()
}

func (o CanaryOutput) ToCanaryOutput() CanaryOutput {
	return o
}

func (o CanaryOutput) ToCanaryOutputWithContext(ctx context.Context) CanaryOutput {
	return o
}

// Amazon Resource Name (ARN) of the Canary.
func (o CanaryOutput) Arn() pulumi.StringOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput)
}

// configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.
func (o CanaryOutput) ArtifactConfig() CanaryArtifactConfigPtrOutput {
	return o.ApplyT(func(v *Canary) CanaryArtifactConfigPtrOutput { return v.ArtifactConfig }).(CanaryArtifactConfigPtrOutput)
}

// Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
func (o CanaryOutput) ArtifactS3Location() pulumi.StringOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringOutput { return v.ArtifactS3Location }).(pulumi.StringOutput)
}

// Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.
func (o CanaryOutput) DeleteLambda() pulumi.BoolPtrOutput {
	return o.ApplyT(func(v *Canary) pulumi.BoolPtrOutput { return v.DeleteLambda }).(pulumi.BoolPtrOutput)
}

// ARN of the Lambda function that is used as your canary's engine.
func (o CanaryOutput) EngineArn() pulumi.StringOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringOutput { return v.EngineArn }).(pulumi.StringOutput)
}

// ARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.
func (o CanaryOutput) ExecutionRoleArn() pulumi.StringOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringOutput { return v.ExecutionRoleArn }).(pulumi.StringOutput)
}

// Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
func (o CanaryOutput) FailureRetentionPeriod() pulumi.IntPtrOutput {
	return o.ApplyT(func(v *Canary) pulumi.IntPtrOutput { return v.FailureRetentionPeriod }).(pulumi.IntPtrOutput)
}

// Entry point to use for the source code when running the canary. This value must end with the string `.handler` .
func (o CanaryOutput) Handler() pulumi.StringOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringOutput { return v.Handler }).(pulumi.StringOutput)
}

// Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.
func (o CanaryOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}

// Configuration block for individual canary runs. Detailed below.
func (o CanaryOutput) RunConfig() CanaryRunConfigOutput {
	return o.ApplyT(func(v *Canary) CanaryRunConfigOutput { return v.RunConfig }).(CanaryRunConfigOutput)
}

// Runtime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.
func (o CanaryOutput) RuntimeVersion() pulumi.StringOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringOutput { return v.RuntimeVersion }).(pulumi.StringOutput)
}

// Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**
func (o CanaryOutput) S3Bucket() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringPtrOutput { return v.S3Bucket }).(pulumi.StringPtrOutput)
}

// S3 key of your script. **Conflicts with `zipFile`.**
func (o CanaryOutput) S3Key() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringPtrOutput { return v.S3Key }).(pulumi.StringPtrOutput)
}

// S3 version ID of your script. **Conflicts with `zipFile`.**
func (o CanaryOutput) S3Version() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringPtrOutput { return v.S3Version }).(pulumi.StringPtrOutput)
}

// Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.
//
// The following arguments are optional:
func (o CanaryOutput) Schedule() CanaryScheduleOutput {
	return o.ApplyT(func(v *Canary) CanaryScheduleOutput { return v.Schedule }).(CanaryScheduleOutput)
}

// ARN of the Lambda layer where Synthetics stores the canary script code.
func (o CanaryOutput) SourceLocationArn() pulumi.StringOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringOutput { return v.SourceLocationArn }).(pulumi.StringOutput)
}

// Whether to run or stop the canary.
func (o CanaryOutput) StartCanary() pulumi.BoolPtrOutput {
	return o.ApplyT(func(v *Canary) pulumi.BoolPtrOutput { return v.StartCanary }).(pulumi.BoolPtrOutput)
}

// Canary status.
func (o CanaryOutput) Status() pulumi.StringOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringOutput { return v.Status }).(pulumi.StringOutput)
}

// Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
func (o CanaryOutput) SuccessRetentionPeriod() pulumi.IntPtrOutput {
	return o.ApplyT(func(v *Canary) pulumi.IntPtrOutput { return v.SuccessRetentionPeriod }).(pulumi.IntPtrOutput)
}

// Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (o CanaryOutput) Tags() pulumi.StringMapOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringMapOutput { return v.Tags }).(pulumi.StringMapOutput)
}

// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
//
// Deprecated: Please use `tags` instead.
func (o CanaryOutput) TagsAll() pulumi.StringMapOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringMapOutput { return v.TagsAll }).(pulumi.StringMapOutput)
}

// Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.
func (o CanaryOutput) Timelines() CanaryTimelineArrayOutput {
	return o.ApplyT(func(v *Canary) CanaryTimelineArrayOutput { return v.Timelines }).(CanaryTimelineArrayOutput)
}

// Configuration block. Detailed below.
func (o CanaryOutput) VpcConfig() CanaryVpcConfigPtrOutput {
	return o.ApplyT(func(v *Canary) CanaryVpcConfigPtrOutput { return v.VpcConfig }).(CanaryVpcConfigPtrOutput)
}

// ZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**
func (o CanaryOutput) ZipFile() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *Canary) pulumi.StringPtrOutput { return v.ZipFile }).(pulumi.StringPtrOutput)
}

type CanaryArrayOutput struct{ *pulumi.OutputState }

func (CanaryArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*Canary)(nil)).Elem()
}

func (o CanaryArrayOutput) ToCanaryArrayOutput() CanaryArrayOutput {
	return o
}

func (o CanaryArrayOutput) ToCanaryArrayOutputWithContext(ctx context.Context) CanaryArrayOutput {
	return o
}

func (o CanaryArrayOutput) Index(i pulumi.IntInput) CanaryOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *Canary {
		return vs[0].([]*Canary)[vs[1].(int)]
	}).(CanaryOutput)
}

type CanaryMapOutput struct{ *pulumi.OutputState }

func (CanaryMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*Canary)(nil)).Elem()
}

func (o CanaryMapOutput) ToCanaryMapOutput() CanaryMapOutput {
	return o
}

func (o CanaryMapOutput) ToCanaryMapOutputWithContext(ctx context.Context) CanaryMapOutput {
	return o
}

func (o CanaryMapOutput) MapIndex(k pulumi.StringInput) CanaryOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *Canary {
		return vs[0].(map[string]*Canary)[vs[1].(string)]
	}).(CanaryOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*CanaryInput)(nil)).Elem(), &Canary{})
	pulumi.RegisterInputType(reflect.TypeOf((*CanaryArrayInput)(nil)).Elem(), CanaryArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*CanaryMapInput)(nil)).Elem(), CanaryMap{})
	pulumi.RegisterOutputType(CanaryOutput{})
	pulumi.RegisterOutputType(CanaryArrayOutput{})
	pulumi.RegisterOutputType(CanaryMapOutput{})
}