synthetics

package
v1.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 14, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	CanaryResourceToTagLambdaFunction = CanaryResourceToTag("lambda-function")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Canary 

type Canary struct {
	pulumi.CustomResourceState

	// Provide artifact configuration
	ArtifactConfig CanaryArtifactConfigPtrOutput `pulumi:"artifactConfig"`
	// Provide the s3 bucket output location for test results
	ArtifactS3Location pulumi.StringOutput `pulumi:"artifactS3Location"`
	// Id of the canary
	AwsId pulumi.StringOutput `pulumi:"awsId"`
	// Provide the canary script source
	Code CanaryCodeOutput `pulumi:"code"`
	// Deletes associated lambda resources created by Synthetics if set to True. Default is False
	DeleteLambdaResourcesOnCanaryDeletion pulumi.BoolPtrOutput `pulumi:"deleteLambdaResourcesOnCanaryDeletion"`
	// Lambda Execution role used to run your canaries
	ExecutionRoleArn pulumi.StringOutput `pulumi:"executionRoleArn"`
	// Retention period of failed canary runs represented in number of days
	FailureRetentionPeriod pulumi.IntPtrOutput `pulumi:"failureRetentionPeriod"`
	// Name of the canary.
	Name pulumi.StringOutput `pulumi:"name"`
	// List of resources which canary tags should be replicated to.
	ResourcesToReplicateTags CanaryResourceToTagArrayOutput `pulumi:"resourcesToReplicateTags"`
	// Provide canary run configuration
	RunConfig CanaryRunConfigPtrOutput `pulumi:"runConfig"`
	// Runtime version of Synthetics Library
	RuntimeVersion pulumi.StringOutput `pulumi:"runtimeVersion"`
	// Frequency to run your canaries
	Schedule CanaryScheduleOutput `pulumi:"schedule"`
	// Runs canary if set to True. Default is False
	StartCanaryAfterCreation pulumi.BoolPtrOutput `pulumi:"startCanaryAfterCreation"`
	// State of the canary
	State pulumi.StringOutput `pulumi:"state"`
	// Retention period of successful canary runs represented in number of days
	SuccessRetentionPeriod pulumi.IntPtrOutput `pulumi:"successRetentionPeriod"`
	// The list of key-value pairs that are associated with the canary.
	Tags aws.TagArrayOutput `pulumi:"tags"`
	// Visual reference configuration for visual testing
	VisualReference CanaryVisualReferencePtrOutput `pulumi:"visualReference"`
	// Provide VPC Configuration if enabled.
	VpcConfig CanaryVpcConfigPtrOutput `pulumi:"vpcConfig"`
}

Resource Type definition for AWS::Synthetics::Canary

## Example Usage ### Example

```go package main

import ( 

awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/synthetics"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synthetics.NewCanary(ctx, "syntheticsCanary", &synthetics.CanaryArgs{
			Name:             pulumi.String("samplecanary"),
			ExecutionRoleArn: pulumi.String("arn:aws:iam::123456789012:role/my-lambda-execution-role-to-run-canary"),
			Code: &synthetics.CanaryCodeArgs{
				Handler:  pulumi.String("pageLoadBlueprint.handler"),
				S3Bucket: pulumi.String("aws-synthetics-code-myaccount-canary1"),
				S3Key:    pulumi.String("my-script-location"),
			},
			ArtifactS3Location: pulumi.String("s3://my-results-bucket"),
			RuntimeVersion:     pulumi.String("syn-nodejs-puppeteer-3.3"),
			Schedule: &synthetics.CanaryScheduleArgs{
				Expression:        pulumi.String("rate(1 minute)"),
				DurationInSeconds: pulumi.String("3600"),
			},
			RunConfig: &synthetics.CanaryRunConfigArgs{
				TimeoutInSeconds: pulumi.Int(60),
			},
			FailureRetentionPeriod: pulumi.Int(30),
			SuccessRetentionPeriod: pulumi.Int(30),
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("key00AtCreate"),
					Value: pulumi.String("value001AtCreate"),
				},
			},
			StartCanaryAfterCreation: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import ( 

awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/synthetics"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synthetics.NewCanary(ctx, "syntheticsCanary", &synthetics.CanaryArgs{
			Name:             pulumi.String("samplecanary"),
			ExecutionRoleArn: pulumi.String("arn:aws:iam::123456789012:role/my-lambda-execution-role-to-run-canary"),
			Code: &synthetics.CanaryCodeArgs{
				Handler: pulumi.String("pageLoadBlueprint.handler"),
				Script: pulumi.String(`var synthetics = require('Synthetics');

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: pulumi.String("s3://my-results-bucket"),
			RuntimeVersion:     pulumi.String("syn-nodejs-puppeteer-3.3"),
			Schedule: &synthetics.CanaryScheduleArgs{
				Expression:        pulumi.String("rate(1 minute)"),
				DurationInSeconds: pulumi.String("3600"),
			},
			RunConfig: &synthetics.CanaryRunConfigArgs{
				TimeoutInSeconds: pulumi.Int(60),
			},
			FailureRetentionPeriod: pulumi.Int(30),
			SuccessRetentionPeriod: pulumi.Int(30),
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("key00AtCreate"),
					Value: pulumi.String("value001AtCreate"),
				},
			},
			StartCanaryAfterCreation: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetCanary 

func GetCanary(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CanaryState, opts ...pulumi.ResourceOption) (*Canary, error)

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 NewCanary 

func NewCanary(ctx *pulumi.Context,
	name string, args *CanaryArgs, opts ...pulumi.ResourceOption) (*Canary, error)

NewCanary registers a new resource with the given unique name, arguments, and options.

func (*Canary) ElementType 

func (*Canary) ElementType() reflect.Type

func (*Canary) ToCanaryOutput 

func (i *Canary) ToCanaryOutput() CanaryOutput

func (*Canary) ToCanaryOutputWithContext 

func (i *Canary) ToCanaryOutputWithContext(ctx context.Context) CanaryOutput

type CanaryArgs 

type CanaryArgs struct {
	// Provide artifact configuration
	ArtifactConfig CanaryArtifactConfigPtrInput
	// Provide the s3 bucket output location for test results
	ArtifactS3Location pulumi.StringInput
	// Provide the canary script source
	Code CanaryCodeInput
	// Deletes associated lambda resources created by Synthetics if set to True. Default is False
	DeleteLambdaResourcesOnCanaryDeletion pulumi.BoolPtrInput
	// Lambda Execution role used to run your canaries
	ExecutionRoleArn pulumi.StringInput
	// Retention period of failed canary runs represented in number of days
	FailureRetentionPeriod pulumi.IntPtrInput
	// Name of the canary.
	Name pulumi.StringPtrInput
	// List of resources which canary tags should be replicated to.
	ResourcesToReplicateTags CanaryResourceToTagArrayInput
	// Provide canary run configuration
	RunConfig CanaryRunConfigPtrInput
	// Runtime version of Synthetics Library
	RuntimeVersion pulumi.StringInput
	// Frequency to run your canaries
	Schedule CanaryScheduleInput
	// Runs canary if set to True. Default is False
	StartCanaryAfterCreation pulumi.BoolPtrInput
	// Retention period of successful canary runs represented in number of days
	SuccessRetentionPeriod pulumi.IntPtrInput
	// The list of key-value pairs that are associated with the canary.
	Tags aws.TagArrayInput
	// Visual reference configuration for visual testing
	VisualReference CanaryVisualReferencePtrInput
	// Provide VPC Configuration if enabled.
	VpcConfig CanaryVpcConfigPtrInput
}

The set of arguments for constructing a Canary resource.

func (CanaryArgs) ElementType 

func (CanaryArgs) ElementType() reflect.Type

type CanaryArtifactConfig added in v0.2.0 

type CanaryArtifactConfig struct {
	// Encryption configuration for uploading artifacts to S3
	S3Encryption *CanaryS3Encryption `pulumi:"s3Encryption"`
}

type CanaryArtifactConfigArgs added in v0.2.0 

type CanaryArtifactConfigArgs struct {
	// Encryption configuration for uploading artifacts to S3
	S3Encryption CanaryS3EncryptionPtrInput `pulumi:"s3Encryption"`
}

func (CanaryArtifactConfigArgs) ElementType added in v0.2.0 

func (CanaryArtifactConfigArgs) ElementType() reflect.Type

func (CanaryArtifactConfigArgs) ToCanaryArtifactConfigOutput added in v0.2.0 

func (i CanaryArtifactConfigArgs) ToCanaryArtifactConfigOutput() CanaryArtifactConfigOutput

func (CanaryArtifactConfigArgs) ToCanaryArtifactConfigOutputWithContext added in v0.2.0 

func (i CanaryArtifactConfigArgs) ToCanaryArtifactConfigOutputWithContext(ctx context.Context) CanaryArtifactConfigOutput

func (CanaryArtifactConfigArgs) ToCanaryArtifactConfigPtrOutput added in v0.2.0 

func (i CanaryArtifactConfigArgs) ToCanaryArtifactConfigPtrOutput() CanaryArtifactConfigPtrOutput

func (CanaryArtifactConfigArgs) ToCanaryArtifactConfigPtrOutputWithContext added in v0.2.0 

func (i CanaryArtifactConfigArgs) ToCanaryArtifactConfigPtrOutputWithContext(ctx context.Context) CanaryArtifactConfigPtrOutput

type CanaryArtifactConfigInput added in v0.2.0 

type CanaryArtifactConfigInput interface {
	pulumi.Input

	ToCanaryArtifactConfigOutput() CanaryArtifactConfigOutput
	ToCanaryArtifactConfigOutputWithContext(context.Context) CanaryArtifactConfigOutput
}

CanaryArtifactConfigInput is an input type that accepts CanaryArtifactConfigArgs and CanaryArtifactConfigOutput values. You can construct a concrete instance of `CanaryArtifactConfigInput` via: 

CanaryArtifactConfigArgs{...}

type CanaryArtifactConfigOutput added in v0.2.0 

type CanaryArtifactConfigOutput struct{ *pulumi.OutputState }

func (CanaryArtifactConfigOutput) ElementType added in v0.2.0 

func (CanaryArtifactConfigOutput) ElementType() reflect.Type

func (CanaryArtifactConfigOutput) S3Encryption added in v0.2.0 

func (o CanaryArtifactConfigOutput) S3Encryption() CanaryS3EncryptionPtrOutput

Encryption configuration for uploading artifacts to S3

func (CanaryArtifactConfigOutput) ToCanaryArtifactConfigOutput added in v0.2.0 

func (o CanaryArtifactConfigOutput) ToCanaryArtifactConfigOutput() CanaryArtifactConfigOutput

func (CanaryArtifactConfigOutput) ToCanaryArtifactConfigOutputWithContext added in v0.2.0 

func (o CanaryArtifactConfigOutput) ToCanaryArtifactConfigOutputWithContext(ctx context.Context) CanaryArtifactConfigOutput

func (CanaryArtifactConfigOutput) ToCanaryArtifactConfigPtrOutput added in v0.2.0 

func (o CanaryArtifactConfigOutput) ToCanaryArtifactConfigPtrOutput() CanaryArtifactConfigPtrOutput

func (CanaryArtifactConfigOutput) ToCanaryArtifactConfigPtrOutputWithContext added in v0.2.0 

func (o CanaryArtifactConfigOutput) ToCanaryArtifactConfigPtrOutputWithContext(ctx context.Context) CanaryArtifactConfigPtrOutput

type CanaryArtifactConfigPtrInput added in v0.2.0 

type CanaryArtifactConfigPtrInput interface {
	pulumi.Input

	ToCanaryArtifactConfigPtrOutput() CanaryArtifactConfigPtrOutput
	ToCanaryArtifactConfigPtrOutputWithContext(context.Context) CanaryArtifactConfigPtrOutput
}

CanaryArtifactConfigPtrInput is an input type that accepts CanaryArtifactConfigArgs, CanaryArtifactConfigPtr and CanaryArtifactConfigPtrOutput values. You can construct a concrete instance of `CanaryArtifactConfigPtrInput` via: 

        CanaryArtifactConfigArgs{...}

or:

        nil

func CanaryArtifactConfigPtr added in v0.2.0 

func CanaryArtifactConfigPtr(v *CanaryArtifactConfigArgs) CanaryArtifactConfigPtrInput

type CanaryArtifactConfigPtrOutput added in v0.2.0 

type CanaryArtifactConfigPtrOutput struct{ *pulumi.OutputState }

func (CanaryArtifactConfigPtrOutput) Elem added in v0.2.0 

func (o CanaryArtifactConfigPtrOutput) Elem() CanaryArtifactConfigOutput

func (CanaryArtifactConfigPtrOutput) ElementType added in v0.2.0 

func (CanaryArtifactConfigPtrOutput) ElementType() reflect.Type

func (CanaryArtifactConfigPtrOutput) S3Encryption added in v0.2.0 

func (o CanaryArtifactConfigPtrOutput) S3Encryption() CanaryS3EncryptionPtrOutput

Encryption configuration for uploading artifacts to S3

func (CanaryArtifactConfigPtrOutput) ToCanaryArtifactConfigPtrOutput added in v0.2.0 

func (o CanaryArtifactConfigPtrOutput) ToCanaryArtifactConfigPtrOutput() CanaryArtifactConfigPtrOutput

func (CanaryArtifactConfigPtrOutput) ToCanaryArtifactConfigPtrOutputWithContext added in v0.2.0 

func (o CanaryArtifactConfigPtrOutput) ToCanaryArtifactConfigPtrOutputWithContext(ctx context.Context) CanaryArtifactConfigPtrOutput

type CanaryBaseScreenshot 

type CanaryBaseScreenshot struct {
	// List of coordinates of rectangles to be ignored during visual testing
	IgnoreCoordinates []string `pulumi:"ignoreCoordinates"`
	// Name of the screenshot to be used as base reference for visual testing
	ScreenshotName string `pulumi:"screenshotName"`
}

type CanaryBaseScreenshotArgs 

type CanaryBaseScreenshotArgs struct {
	// List of coordinates of rectangles to be ignored during visual testing
	IgnoreCoordinates pulumi.StringArrayInput `pulumi:"ignoreCoordinates"`
	// Name of the screenshot to be used as base reference for visual testing
	ScreenshotName pulumi.StringInput `pulumi:"screenshotName"`
}

func (CanaryBaseScreenshotArgs) ElementType 

func (CanaryBaseScreenshotArgs) ElementType() reflect.Type

func (CanaryBaseScreenshotArgs) ToCanaryBaseScreenshotOutput 

func (i CanaryBaseScreenshotArgs) ToCanaryBaseScreenshotOutput() CanaryBaseScreenshotOutput

func (CanaryBaseScreenshotArgs) ToCanaryBaseScreenshotOutputWithContext 

func (i CanaryBaseScreenshotArgs) ToCanaryBaseScreenshotOutputWithContext(ctx context.Context) CanaryBaseScreenshotOutput

type CanaryBaseScreenshotArray 

type CanaryBaseScreenshotArray []CanaryBaseScreenshotInput

func (CanaryBaseScreenshotArray) ElementType 

func (CanaryBaseScreenshotArray) ElementType() reflect.Type

func (CanaryBaseScreenshotArray) ToCanaryBaseScreenshotArrayOutput 

func (i CanaryBaseScreenshotArray) ToCanaryBaseScreenshotArrayOutput() CanaryBaseScreenshotArrayOutput

func (CanaryBaseScreenshotArray) ToCanaryBaseScreenshotArrayOutputWithContext 

func (i CanaryBaseScreenshotArray) ToCanaryBaseScreenshotArrayOutputWithContext(ctx context.Context) CanaryBaseScreenshotArrayOutput

type CanaryBaseScreenshotArrayInput 

type CanaryBaseScreenshotArrayInput interface {
	pulumi.Input

	ToCanaryBaseScreenshotArrayOutput() CanaryBaseScreenshotArrayOutput
	ToCanaryBaseScreenshotArrayOutputWithContext(context.Context) CanaryBaseScreenshotArrayOutput
}

CanaryBaseScreenshotArrayInput is an input type that accepts CanaryBaseScreenshotArray and CanaryBaseScreenshotArrayOutput values. You can construct a concrete instance of `CanaryBaseScreenshotArrayInput` via: 

CanaryBaseScreenshotArray{ CanaryBaseScreenshotArgs{...} }

type CanaryBaseScreenshotArrayOutput 

type CanaryBaseScreenshotArrayOutput struct{ *pulumi.OutputState }

func (CanaryBaseScreenshotArrayOutput) ElementType 

func (CanaryBaseScreenshotArrayOutput) ElementType() reflect.Type

func (CanaryBaseScreenshotArrayOutput) Index 

func (o CanaryBaseScreenshotArrayOutput) Index(i pulumi.IntInput) CanaryBaseScreenshotOutput

func (CanaryBaseScreenshotArrayOutput) ToCanaryBaseScreenshotArrayOutput 

func (o CanaryBaseScreenshotArrayOutput) ToCanaryBaseScreenshotArrayOutput() CanaryBaseScreenshotArrayOutput

func (CanaryBaseScreenshotArrayOutput) ToCanaryBaseScreenshotArrayOutputWithContext 

func (o CanaryBaseScreenshotArrayOutput) ToCanaryBaseScreenshotArrayOutputWithContext(ctx context.Context) CanaryBaseScreenshotArrayOutput

type CanaryBaseScreenshotInput 

type CanaryBaseScreenshotInput interface {
	pulumi.Input

	ToCanaryBaseScreenshotOutput() CanaryBaseScreenshotOutput
	ToCanaryBaseScreenshotOutputWithContext(context.Context) CanaryBaseScreenshotOutput
}

CanaryBaseScreenshotInput is an input type that accepts CanaryBaseScreenshotArgs and CanaryBaseScreenshotOutput values. You can construct a concrete instance of `CanaryBaseScreenshotInput` via: 

CanaryBaseScreenshotArgs{...}

type CanaryBaseScreenshotOutput 

type CanaryBaseScreenshotOutput struct{ *pulumi.OutputState }

func (CanaryBaseScreenshotOutput) ElementType 

func (CanaryBaseScreenshotOutput) ElementType() reflect.Type

func (CanaryBaseScreenshotOutput) IgnoreCoordinates 

func (o CanaryBaseScreenshotOutput) IgnoreCoordinates() pulumi.StringArrayOutput

List of coordinates of rectangles to be ignored during visual testing

func (CanaryBaseScreenshotOutput) ScreenshotName 

func (o CanaryBaseScreenshotOutput) ScreenshotName() pulumi.StringOutput

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

func (CanaryBaseScreenshotOutput) ToCanaryBaseScreenshotOutput 

func (o CanaryBaseScreenshotOutput) ToCanaryBaseScreenshotOutput() CanaryBaseScreenshotOutput

func (CanaryBaseScreenshotOutput) ToCanaryBaseScreenshotOutputWithContext 

func (o CanaryBaseScreenshotOutput) ToCanaryBaseScreenshotOutputWithContext(ctx context.Context) CanaryBaseScreenshotOutput

type CanaryCode 

type CanaryCode struct {
	// 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*` .
	Handler string `pulumi:"handler"`
	// If your canary script is located in S3, specify the bucket name here. The bucket must already exist.
	S3Bucket *string `pulumi:"s3Bucket"`
	// The S3 key of your script. For more information, see [Working with Amazon S3 Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html) .
	S3Key *string `pulumi:"s3Key"`
	// The S3 version ID of your script.
	S3ObjectVersion *string `pulumi:"s3ObjectVersion"`
	// 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.
	Script *string `pulumi:"script"`
	// The ARN of the Lambda layer where Synthetics stores the canary script code.
	SourceLocationArn *string `pulumi:"sourceLocationArn"`
}

type CanaryCodeArgs 

type CanaryCodeArgs struct {
	// 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*` .
	Handler pulumi.StringInput `pulumi:"handler"`
	// If your canary script is located in S3, specify the bucket name here. The bucket must already exist.
	S3Bucket pulumi.StringPtrInput `pulumi:"s3Bucket"`
	// The S3 key of your script. For more information, see [Working with Amazon S3 Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html) .
	S3Key pulumi.StringPtrInput `pulumi:"s3Key"`
	// The S3 version ID of your script.
	S3ObjectVersion pulumi.StringPtrInput `pulumi:"s3ObjectVersion"`
	// 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.
	Script pulumi.StringPtrInput `pulumi:"script"`
	// The ARN of the Lambda layer where Synthetics stores the canary script code.
	SourceLocationArn pulumi.StringPtrInput `pulumi:"sourceLocationArn"`
}

func (CanaryCodeArgs) ElementType 

func (CanaryCodeArgs) ElementType() reflect.Type

func (CanaryCodeArgs) ToCanaryCodeOutput 

func (i CanaryCodeArgs) ToCanaryCodeOutput() CanaryCodeOutput

func (CanaryCodeArgs) ToCanaryCodeOutputWithContext 

func (i CanaryCodeArgs) ToCanaryCodeOutputWithContext(ctx context.Context) CanaryCodeOutput

type CanaryCodeInput 

type CanaryCodeInput interface {
	pulumi.Input

	ToCanaryCodeOutput() CanaryCodeOutput
	ToCanaryCodeOutputWithContext(context.Context) CanaryCodeOutput
}

CanaryCodeInput is an input type that accepts CanaryCodeArgs and CanaryCodeOutput values. You can construct a concrete instance of `CanaryCodeInput` via: 

CanaryCodeArgs{...}

type CanaryCodeOutput 

type CanaryCodeOutput struct{ *pulumi.OutputState }

func (CanaryCodeOutput) ElementType 

func (CanaryCodeOutput) ElementType() reflect.Type

func (CanaryCodeOutput) Handler 

func (o CanaryCodeOutput) Handler() pulumi.StringOutput

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*` .

func (CanaryCodeOutput) S3Bucket 

func (o CanaryCodeOutput) S3Bucket() pulumi.StringPtrOutput

If your canary script is located in S3, specify the bucket name here. The bucket must already exist.

func (CanaryCodeOutput) S3Key 

func (o CanaryCodeOutput) S3Key() pulumi.StringPtrOutput

The S3 key of your script. For more information, see [Working with Amazon S3 Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html) .

func (CanaryCodeOutput) S3ObjectVersion 

func (o CanaryCodeOutput) S3ObjectVersion() pulumi.StringPtrOutput

The S3 version ID of your script.

func (CanaryCodeOutput) Script 

func (o CanaryCodeOutput) Script() pulumi.StringPtrOutput

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.

func (CanaryCodeOutput) SourceLocationArn added in v0.62.0 

func (o CanaryCodeOutput) SourceLocationArn() pulumi.StringPtrOutput

The ARN of the Lambda layer where Synthetics stores the canary script code.

func (CanaryCodeOutput) ToCanaryCodeOutput 

func (o CanaryCodeOutput) ToCanaryCodeOutput() CanaryCodeOutput

func (CanaryCodeOutput) ToCanaryCodeOutputWithContext 

func (o CanaryCodeOutput) ToCanaryCodeOutputWithContext(ctx context.Context) CanaryCodeOutput

type CanaryCodePtrOutput 

type CanaryCodePtrOutput struct{ *pulumi.OutputState }

func (CanaryCodePtrOutput) Elem 

func (o CanaryCodePtrOutput) Elem() CanaryCodeOutput

func (CanaryCodePtrOutput) ElementType 

func (CanaryCodePtrOutput) ElementType() reflect.Type

func (CanaryCodePtrOutput) Handler 

func (o CanaryCodePtrOutput) Handler() pulumi.StringPtrOutput

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*` .

func (CanaryCodePtrOutput) S3Bucket 

func (o CanaryCodePtrOutput) S3Bucket() pulumi.StringPtrOutput

If your canary script is located in S3, specify the bucket name here. The bucket must already exist.

func (CanaryCodePtrOutput) S3Key 

func (o CanaryCodePtrOutput) S3Key() pulumi.StringPtrOutput

The S3 key of your script. For more information, see [Working with Amazon S3 Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html) .

func (CanaryCodePtrOutput) S3ObjectVersion 

func (o CanaryCodePtrOutput) S3ObjectVersion() pulumi.StringPtrOutput

The S3 version ID of your script.

func (CanaryCodePtrOutput) Script 

func (o CanaryCodePtrOutput) Script() pulumi.StringPtrOutput

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.

func (CanaryCodePtrOutput) SourceLocationArn added in v0.62.0 

func (o CanaryCodePtrOutput) SourceLocationArn() pulumi.StringPtrOutput

The ARN of the Lambda layer where Synthetics stores the canary script code.

func (CanaryCodePtrOutput) ToCanaryCodePtrOutput 

func (o CanaryCodePtrOutput) ToCanaryCodePtrOutput() CanaryCodePtrOutput

func (CanaryCodePtrOutput) ToCanaryCodePtrOutputWithContext 

func (o CanaryCodePtrOutput) ToCanaryCodePtrOutputWithContext(ctx context.Context) CanaryCodePtrOutput

type CanaryInput 

type CanaryInput interface {
	pulumi.Input

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

type CanaryOutput 

type CanaryOutput struct{ *pulumi.OutputState }

func (CanaryOutput) ArtifactConfig added in v0.17.0 

func (o CanaryOutput) ArtifactConfig() CanaryArtifactConfigPtrOutput

Provide artifact configuration

func (CanaryOutput) ArtifactS3Location added in v0.17.0 

func (o CanaryOutput) ArtifactS3Location() pulumi.StringOutput

Provide the s3 bucket output location for test results

func (CanaryOutput) AwsId added in v0.99.0 

func (o CanaryOutput) AwsId() pulumi.StringOutput

Id of the canary

func (CanaryOutput) Code added in v0.17.0 

func (o CanaryOutput) Code() CanaryCodeOutput

Provide the canary script source

func (CanaryOutput) DeleteLambdaResourcesOnCanaryDeletion added in v0.17.0 

func (o CanaryOutput) DeleteLambdaResourcesOnCanaryDeletion() pulumi.BoolPtrOutput

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

func (CanaryOutput) ElementType 

func (CanaryOutput) ElementType() reflect.Type

func (CanaryOutput) ExecutionRoleArn added in v0.17.0 

func (o CanaryOutput) ExecutionRoleArn() pulumi.StringOutput

Lambda Execution role used to run your canaries

func (CanaryOutput) FailureRetentionPeriod added in v0.17.0 

func (o CanaryOutput) FailureRetentionPeriod() pulumi.IntPtrOutput

Retention period of failed canary runs represented in number of days

func (CanaryOutput) Name added in v0.17.0 

func (o CanaryOutput) Name() pulumi.StringOutput

Name of the canary.

func (CanaryOutput) ResourcesToReplicateTags added in v0.124.0 

func (o CanaryOutput) ResourcesToReplicateTags() CanaryResourceToTagArrayOutput

List of resources which canary tags should be replicated to.

func (CanaryOutput) RunConfig added in v0.17.0 

func (o CanaryOutput) RunConfig() CanaryRunConfigPtrOutput

Provide canary run configuration

func (CanaryOutput) RuntimeVersion added in v0.17.0 

func (o CanaryOutput) RuntimeVersion() pulumi.StringOutput

Runtime version of Synthetics Library

func (CanaryOutput) Schedule added in v0.17.0 

func (o CanaryOutput) Schedule() CanaryScheduleOutput

Frequency to run your canaries

func (CanaryOutput) StartCanaryAfterCreation added in v0.17.0 

func (o CanaryOutput) StartCanaryAfterCreation() pulumi.BoolPtrOutput

Runs canary if set to True. Default is False

func (CanaryOutput) State added in v0.17.0 

func (o CanaryOutput) State() pulumi.StringOutput

State of the canary

func (CanaryOutput) SuccessRetentionPeriod added in v0.17.0 

func (o CanaryOutput) SuccessRetentionPeriod() pulumi.IntPtrOutput

Retention period of successful canary runs represented in number of days

func (CanaryOutput) Tags added in v0.17.0 

func (o CanaryOutput) Tags() aws.TagArrayOutput

The list of key-value pairs that are associated with the canary.

func (CanaryOutput) ToCanaryOutput 

func (o CanaryOutput) ToCanaryOutput() CanaryOutput

func (CanaryOutput) ToCanaryOutputWithContext 

func (o CanaryOutput) ToCanaryOutputWithContext(ctx context.Context) CanaryOutput

func (CanaryOutput) VisualReference added in v0.17.0 

func (o CanaryOutput) VisualReference() CanaryVisualReferencePtrOutput

Visual reference configuration for visual testing

func (CanaryOutput) VpcConfig added in v0.72.0 

func (o CanaryOutput) VpcConfig() CanaryVpcConfigPtrOutput

Provide VPC Configuration if enabled.

type CanaryResourceToTag added in v0.124.0 

type CanaryResourceToTag string

Specifies which resources canary tags should be replicated to.

func (CanaryResourceToTag) ElementType added in v0.124.0 

func (CanaryResourceToTag) ElementType() reflect.Type

func (CanaryResourceToTag) ToCanaryResourceToTagOutput added in v0.124.0 

func (e CanaryResourceToTag) ToCanaryResourceToTagOutput() CanaryResourceToTagOutput

func (CanaryResourceToTag) ToCanaryResourceToTagOutputWithContext added in v0.124.0 

func (e CanaryResourceToTag) ToCanaryResourceToTagOutputWithContext(ctx context.Context) CanaryResourceToTagOutput

func (CanaryResourceToTag) ToCanaryResourceToTagPtrOutput added in v0.124.0 

func (e CanaryResourceToTag) ToCanaryResourceToTagPtrOutput() CanaryResourceToTagPtrOutput

func (CanaryResourceToTag) ToCanaryResourceToTagPtrOutputWithContext added in v0.124.0 

func (e CanaryResourceToTag) ToCanaryResourceToTagPtrOutputWithContext(ctx context.Context) CanaryResourceToTagPtrOutput

func (CanaryResourceToTag) ToStringOutput added in v0.124.0 

func (e CanaryResourceToTag) ToStringOutput() pulumi.StringOutput

func (CanaryResourceToTag) ToStringOutputWithContext added in v0.124.0 

func (e CanaryResourceToTag) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (CanaryResourceToTag) ToStringPtrOutput added in v0.124.0 

func (e CanaryResourceToTag) ToStringPtrOutput() pulumi.StringPtrOutput

func (CanaryResourceToTag) ToStringPtrOutputWithContext added in v0.124.0 

func (e CanaryResourceToTag) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type CanaryResourceToTagArray added in v0.124.0 

type CanaryResourceToTagArray []CanaryResourceToTag

func (CanaryResourceToTagArray) ElementType added in v0.124.0 

func (CanaryResourceToTagArray) ElementType() reflect.Type

func (CanaryResourceToTagArray) ToCanaryResourceToTagArrayOutput added in v0.124.0 

func (i CanaryResourceToTagArray) ToCanaryResourceToTagArrayOutput() CanaryResourceToTagArrayOutput

func (CanaryResourceToTagArray) ToCanaryResourceToTagArrayOutputWithContext added in v0.124.0 

func (i CanaryResourceToTagArray) ToCanaryResourceToTagArrayOutputWithContext(ctx context.Context) CanaryResourceToTagArrayOutput

type CanaryResourceToTagArrayInput added in v0.124.0 

type CanaryResourceToTagArrayInput interface {
	pulumi.Input

	ToCanaryResourceToTagArrayOutput() CanaryResourceToTagArrayOutput
	ToCanaryResourceToTagArrayOutputWithContext(context.Context) CanaryResourceToTagArrayOutput
}

CanaryResourceToTagArrayInput is an input type that accepts CanaryResourceToTagArray and CanaryResourceToTagArrayOutput values. You can construct a concrete instance of `CanaryResourceToTagArrayInput` via: 

CanaryResourceToTagArray{ CanaryResourceToTagArgs{...} }

type CanaryResourceToTagArrayOutput added in v0.124.0 

type CanaryResourceToTagArrayOutput struct{ *pulumi.OutputState }

func (CanaryResourceToTagArrayOutput) ElementType added in v0.124.0 

func (CanaryResourceToTagArrayOutput) ElementType() reflect.Type

func (CanaryResourceToTagArrayOutput) Index added in v0.124.0 

func (o CanaryResourceToTagArrayOutput) Index(i pulumi.IntInput) CanaryResourceToTagOutput

func (CanaryResourceToTagArrayOutput) ToCanaryResourceToTagArrayOutput added in v0.124.0 

func (o CanaryResourceToTagArrayOutput) ToCanaryResourceToTagArrayOutput() CanaryResourceToTagArrayOutput

func (CanaryResourceToTagArrayOutput) ToCanaryResourceToTagArrayOutputWithContext added in v0.124.0 

func (o CanaryResourceToTagArrayOutput) ToCanaryResourceToTagArrayOutputWithContext(ctx context.Context) CanaryResourceToTagArrayOutput

type CanaryResourceToTagInput added in v0.124.0 

type CanaryResourceToTagInput interface {
	pulumi.Input

	ToCanaryResourceToTagOutput() CanaryResourceToTagOutput
	ToCanaryResourceToTagOutputWithContext(context.Context) CanaryResourceToTagOutput
}

CanaryResourceToTagInput is an input type that accepts values of the CanaryResourceToTag enum A concrete instance of `CanaryResourceToTagInput` can be one of the following: 

CanaryResourceToTagLambdaFunction

type CanaryResourceToTagOutput added in v0.124.0 

type CanaryResourceToTagOutput struct{ *pulumi.OutputState }

func (CanaryResourceToTagOutput) ElementType added in v0.124.0 

func (CanaryResourceToTagOutput) ElementType() reflect.Type

func (CanaryResourceToTagOutput) ToCanaryResourceToTagOutput added in v0.124.0 

func (o CanaryResourceToTagOutput) ToCanaryResourceToTagOutput() CanaryResourceToTagOutput

func (CanaryResourceToTagOutput) ToCanaryResourceToTagOutputWithContext added in v0.124.0 

func (o CanaryResourceToTagOutput) ToCanaryResourceToTagOutputWithContext(ctx context.Context) CanaryResourceToTagOutput

func (CanaryResourceToTagOutput) ToCanaryResourceToTagPtrOutput added in v0.124.0 

func (o CanaryResourceToTagOutput) ToCanaryResourceToTagPtrOutput() CanaryResourceToTagPtrOutput

func (CanaryResourceToTagOutput) ToCanaryResourceToTagPtrOutputWithContext added in v0.124.0 

func (o CanaryResourceToTagOutput) ToCanaryResourceToTagPtrOutputWithContext(ctx context.Context) CanaryResourceToTagPtrOutput

func (CanaryResourceToTagOutput) ToStringOutput added in v0.124.0 

func (o CanaryResourceToTagOutput) ToStringOutput() pulumi.StringOutput

func (CanaryResourceToTagOutput) ToStringOutputWithContext added in v0.124.0 

func (o CanaryResourceToTagOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (CanaryResourceToTagOutput) ToStringPtrOutput added in v0.124.0 

func (o CanaryResourceToTagOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (CanaryResourceToTagOutput) ToStringPtrOutputWithContext added in v0.124.0 

func (o CanaryResourceToTagOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type CanaryResourceToTagPtrInput added in v0.124.0 

type CanaryResourceToTagPtrInput interface {
	pulumi.Input

	ToCanaryResourceToTagPtrOutput() CanaryResourceToTagPtrOutput
	ToCanaryResourceToTagPtrOutputWithContext(context.Context) CanaryResourceToTagPtrOutput
}

func CanaryResourceToTagPtr added in v0.124.0 

func CanaryResourceToTagPtr(v string) CanaryResourceToTagPtrInput

type CanaryResourceToTagPtrOutput added in v0.124.0 

type CanaryResourceToTagPtrOutput struct{ *pulumi.OutputState }

func (CanaryResourceToTagPtrOutput) Elem added in v0.124.0 

func (o CanaryResourceToTagPtrOutput) Elem() CanaryResourceToTagOutput

func (CanaryResourceToTagPtrOutput) ElementType added in v0.124.0 

func (CanaryResourceToTagPtrOutput) ElementType() reflect.Type

func (CanaryResourceToTagPtrOutput) ToCanaryResourceToTagPtrOutput added in v0.124.0 

func (o CanaryResourceToTagPtrOutput) ToCanaryResourceToTagPtrOutput() CanaryResourceToTagPtrOutput

func (CanaryResourceToTagPtrOutput) ToCanaryResourceToTagPtrOutputWithContext added in v0.124.0 

func (o CanaryResourceToTagPtrOutput) ToCanaryResourceToTagPtrOutputWithContext(ctx context.Context) CanaryResourceToTagPtrOutput

func (CanaryResourceToTagPtrOutput) ToStringPtrOutput added in v0.124.0 

func (o CanaryResourceToTagPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (CanaryResourceToTagPtrOutput) ToStringPtrOutputWithContext added in v0.124.0 

func (o CanaryResourceToTagPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type CanaryRunConfig 

type CanaryRunConfig struct {
	// Enable active tracing if set to true
	ActiveTracing *bool `pulumi:"activeTracing"`
	// Environment variable key-value pairs.
	EnvironmentVariables map[string]string `pulumi:"environmentVariables"`
	// Provide maximum memory available for canary in MB
	MemoryInMb *int `pulumi:"memoryInMb"`
	// Provide maximum canary timeout per run in seconds
	TimeoutInSeconds *int `pulumi:"timeoutInSeconds"`
}

type CanaryRunConfigArgs 

type CanaryRunConfigArgs struct {
	// Enable active tracing if set to true
	ActiveTracing pulumi.BoolPtrInput `pulumi:"activeTracing"`
	// Environment variable key-value pairs.
	EnvironmentVariables pulumi.StringMapInput `pulumi:"environmentVariables"`
	// Provide maximum memory available for canary in MB
	MemoryInMb pulumi.IntPtrInput `pulumi:"memoryInMb"`
	// Provide maximum canary timeout per run in seconds
	TimeoutInSeconds pulumi.IntPtrInput `pulumi:"timeoutInSeconds"`
}

func (CanaryRunConfigArgs) ElementType 

func (CanaryRunConfigArgs) ElementType() reflect.Type

func (CanaryRunConfigArgs) ToCanaryRunConfigOutput 

func (i CanaryRunConfigArgs) ToCanaryRunConfigOutput() CanaryRunConfigOutput

func (CanaryRunConfigArgs) ToCanaryRunConfigOutputWithContext 

func (i CanaryRunConfigArgs) ToCanaryRunConfigOutputWithContext(ctx context.Context) CanaryRunConfigOutput

func (CanaryRunConfigArgs) ToCanaryRunConfigPtrOutput 

func (i CanaryRunConfigArgs) ToCanaryRunConfigPtrOutput() CanaryRunConfigPtrOutput

func (CanaryRunConfigArgs) ToCanaryRunConfigPtrOutputWithContext 

func (i CanaryRunConfigArgs) ToCanaryRunConfigPtrOutputWithContext(ctx context.Context) CanaryRunConfigPtrOutput

type CanaryRunConfigInput 

type CanaryRunConfigInput interface {
	pulumi.Input

	ToCanaryRunConfigOutput() CanaryRunConfigOutput
	ToCanaryRunConfigOutputWithContext(context.Context) CanaryRunConfigOutput
}

CanaryRunConfigInput is an input type that accepts CanaryRunConfigArgs and CanaryRunConfigOutput values. You can construct a concrete instance of `CanaryRunConfigInput` via: 

CanaryRunConfigArgs{...}

type CanaryRunConfigOutput 

type CanaryRunConfigOutput struct{ *pulumi.OutputState }

func (CanaryRunConfigOutput) ActiveTracing 

func (o CanaryRunConfigOutput) ActiveTracing() pulumi.BoolPtrOutput

Enable active tracing if set to true

func (CanaryRunConfigOutput) ElementType 

func (CanaryRunConfigOutput) ElementType() reflect.Type

func (CanaryRunConfigOutput) EnvironmentVariables 

func (o CanaryRunConfigOutput) EnvironmentVariables() pulumi.StringMapOutput

Environment variable key-value pairs.

func (CanaryRunConfigOutput) MemoryInMb added in v0.72.0 

func (o CanaryRunConfigOutput) MemoryInMb() pulumi.IntPtrOutput

Provide maximum memory available for canary in MB

func (CanaryRunConfigOutput) TimeoutInSeconds 

func (o CanaryRunConfigOutput) TimeoutInSeconds() pulumi.IntPtrOutput

Provide maximum canary timeout per run in seconds

func (CanaryRunConfigOutput) ToCanaryRunConfigOutput 

func (o CanaryRunConfigOutput) ToCanaryRunConfigOutput() CanaryRunConfigOutput

func (CanaryRunConfigOutput) ToCanaryRunConfigOutputWithContext 

func (o CanaryRunConfigOutput) ToCanaryRunConfigOutputWithContext(ctx context.Context) CanaryRunConfigOutput

func (CanaryRunConfigOutput) ToCanaryRunConfigPtrOutput 

func (o CanaryRunConfigOutput) ToCanaryRunConfigPtrOutput() CanaryRunConfigPtrOutput

func (CanaryRunConfigOutput) ToCanaryRunConfigPtrOutputWithContext 

func (o CanaryRunConfigOutput) ToCanaryRunConfigPtrOutputWithContext(ctx context.Context) CanaryRunConfigPtrOutput

type CanaryRunConfigPtrInput 

type CanaryRunConfigPtrInput interface {
	pulumi.Input

	ToCanaryRunConfigPtrOutput() CanaryRunConfigPtrOutput
	ToCanaryRunConfigPtrOutputWithContext(context.Context) CanaryRunConfigPtrOutput
}

CanaryRunConfigPtrInput is an input type that accepts CanaryRunConfigArgs, CanaryRunConfigPtr and CanaryRunConfigPtrOutput values. You can construct a concrete instance of `CanaryRunConfigPtrInput` via: 

        CanaryRunConfigArgs{...}

or:

        nil

func CanaryRunConfigPtr 

func CanaryRunConfigPtr(v *CanaryRunConfigArgs) CanaryRunConfigPtrInput

type CanaryRunConfigPtrOutput 

type CanaryRunConfigPtrOutput struct{ *pulumi.OutputState }

func (CanaryRunConfigPtrOutput) ActiveTracing 

func (o CanaryRunConfigPtrOutput) ActiveTracing() pulumi.BoolPtrOutput

Enable active tracing if set to true

func (CanaryRunConfigPtrOutput) Elem 

func (o CanaryRunConfigPtrOutput) Elem() CanaryRunConfigOutput

func (CanaryRunConfigPtrOutput) ElementType 

func (CanaryRunConfigPtrOutput) ElementType() reflect.Type

func (CanaryRunConfigPtrOutput) EnvironmentVariables 

func (o CanaryRunConfigPtrOutput) EnvironmentVariables() pulumi.StringMapOutput

Environment variable key-value pairs.

func (CanaryRunConfigPtrOutput) MemoryInMb added in v0.72.0 

func (o CanaryRunConfigPtrOutput) MemoryInMb() pulumi.IntPtrOutput

Provide maximum memory available for canary in MB

func (CanaryRunConfigPtrOutput) TimeoutInSeconds 

func (o CanaryRunConfigPtrOutput) TimeoutInSeconds() pulumi.IntPtrOutput

Provide maximum canary timeout per run in seconds

func (CanaryRunConfigPtrOutput) ToCanaryRunConfigPtrOutput 

func (o CanaryRunConfigPtrOutput) ToCanaryRunConfigPtrOutput() CanaryRunConfigPtrOutput

func (CanaryRunConfigPtrOutput) ToCanaryRunConfigPtrOutputWithContext 

func (o CanaryRunConfigPtrOutput) ToCanaryRunConfigPtrOutputWithContext(ctx context.Context) CanaryRunConfigPtrOutput

type CanaryS3Encryption added in v0.2.0 

type CanaryS3Encryption struct {
	// Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
	EncryptionMode *string `pulumi:"encryptionMode"`
	// KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
	KmsKeyArn *string `pulumi:"kmsKeyArn"`
}

type CanaryS3EncryptionArgs added in v0.2.0 

type CanaryS3EncryptionArgs struct {
	// Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
	EncryptionMode pulumi.StringPtrInput `pulumi:"encryptionMode"`
	// KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
	KmsKeyArn pulumi.StringPtrInput `pulumi:"kmsKeyArn"`
}

func (CanaryS3EncryptionArgs) ElementType added in v0.2.0 

func (CanaryS3EncryptionArgs) ElementType() reflect.Type

func (CanaryS3EncryptionArgs) ToCanaryS3EncryptionOutput added in v0.2.0 

func (i CanaryS3EncryptionArgs) ToCanaryS3EncryptionOutput() CanaryS3EncryptionOutput

func (CanaryS3EncryptionArgs) ToCanaryS3EncryptionOutputWithContext added in v0.2.0 

func (i CanaryS3EncryptionArgs) ToCanaryS3EncryptionOutputWithContext(ctx context.Context) CanaryS3EncryptionOutput

func (CanaryS3EncryptionArgs) ToCanaryS3EncryptionPtrOutput added in v0.2.0 

func (i CanaryS3EncryptionArgs) ToCanaryS3EncryptionPtrOutput() CanaryS3EncryptionPtrOutput

func (CanaryS3EncryptionArgs) ToCanaryS3EncryptionPtrOutputWithContext added in v0.2.0 

func (i CanaryS3EncryptionArgs) ToCanaryS3EncryptionPtrOutputWithContext(ctx context.Context) CanaryS3EncryptionPtrOutput

type CanaryS3EncryptionInput added in v0.2.0 

type CanaryS3EncryptionInput interface {
	pulumi.Input

	ToCanaryS3EncryptionOutput() CanaryS3EncryptionOutput
	ToCanaryS3EncryptionOutputWithContext(context.Context) CanaryS3EncryptionOutput
}

CanaryS3EncryptionInput is an input type that accepts CanaryS3EncryptionArgs and CanaryS3EncryptionOutput values. You can construct a concrete instance of `CanaryS3EncryptionInput` via: 

CanaryS3EncryptionArgs{...}

type CanaryS3EncryptionOutput added in v0.2.0 

type CanaryS3EncryptionOutput struct{ *pulumi.OutputState }

func (CanaryS3EncryptionOutput) ElementType added in v0.2.0 

func (CanaryS3EncryptionOutput) ElementType() reflect.Type

func (CanaryS3EncryptionOutput) EncryptionMode added in v0.2.0 

func (o CanaryS3EncryptionOutput) EncryptionMode() pulumi.StringPtrOutput

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

func (CanaryS3EncryptionOutput) KmsKeyArn added in v0.2.0 

func (o CanaryS3EncryptionOutput) KmsKeyArn() pulumi.StringPtrOutput

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

func (CanaryS3EncryptionOutput) ToCanaryS3EncryptionOutput added in v0.2.0 

func (o CanaryS3EncryptionOutput) ToCanaryS3EncryptionOutput() CanaryS3EncryptionOutput

func (CanaryS3EncryptionOutput) ToCanaryS3EncryptionOutputWithContext added in v0.2.0 

func (o CanaryS3EncryptionOutput) ToCanaryS3EncryptionOutputWithContext(ctx context.Context) CanaryS3EncryptionOutput

func (CanaryS3EncryptionOutput) ToCanaryS3EncryptionPtrOutput added in v0.2.0 

func (o CanaryS3EncryptionOutput) ToCanaryS3EncryptionPtrOutput() CanaryS3EncryptionPtrOutput

func (CanaryS3EncryptionOutput) ToCanaryS3EncryptionPtrOutputWithContext added in v0.2.0 

func (o CanaryS3EncryptionOutput) ToCanaryS3EncryptionPtrOutputWithContext(ctx context.Context) CanaryS3EncryptionPtrOutput

type CanaryS3EncryptionPtrInput added in v0.2.0 

type CanaryS3EncryptionPtrInput interface {
	pulumi.Input

	ToCanaryS3EncryptionPtrOutput() CanaryS3EncryptionPtrOutput
	ToCanaryS3EncryptionPtrOutputWithContext(context.Context) CanaryS3EncryptionPtrOutput
}

CanaryS3EncryptionPtrInput is an input type that accepts CanaryS3EncryptionArgs, CanaryS3EncryptionPtr and CanaryS3EncryptionPtrOutput values. You can construct a concrete instance of `CanaryS3EncryptionPtrInput` via: 

        CanaryS3EncryptionArgs{...}

or:

        nil

func CanaryS3EncryptionPtr added in v0.2.0 

func CanaryS3EncryptionPtr(v *CanaryS3EncryptionArgs) CanaryS3EncryptionPtrInput

type CanaryS3EncryptionPtrOutput added in v0.2.0 

type CanaryS3EncryptionPtrOutput struct{ *pulumi.OutputState }

func (CanaryS3EncryptionPtrOutput) Elem added in v0.2.0 

func (o CanaryS3EncryptionPtrOutput) Elem() CanaryS3EncryptionOutput

func (CanaryS3EncryptionPtrOutput) ElementType added in v0.2.0 

func (CanaryS3EncryptionPtrOutput) ElementType() reflect.Type

func (CanaryS3EncryptionPtrOutput) EncryptionMode added in v0.2.0 

func (o CanaryS3EncryptionPtrOutput) EncryptionMode() pulumi.StringPtrOutput

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

func (CanaryS3EncryptionPtrOutput) KmsKeyArn added in v0.2.0 

func (o CanaryS3EncryptionPtrOutput) KmsKeyArn() pulumi.StringPtrOutput

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

func (CanaryS3EncryptionPtrOutput) ToCanaryS3EncryptionPtrOutput added in v0.2.0 

func (o CanaryS3EncryptionPtrOutput) ToCanaryS3EncryptionPtrOutput() CanaryS3EncryptionPtrOutput

func (CanaryS3EncryptionPtrOutput) ToCanaryS3EncryptionPtrOutputWithContext added in v0.2.0 

func (o CanaryS3EncryptionPtrOutput) ToCanaryS3EncryptionPtrOutputWithContext(ctx context.Context) CanaryS3EncryptionPtrOutput

type CanarySchedule 

type CanarySchedule struct {
	// 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.
	DurationInSeconds *string `pulumi:"durationInSeconds"`
	// 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html) .
	Expression string `pulumi:"expression"`
}

type CanaryScheduleArgs 

type CanaryScheduleArgs struct {
	// 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.
	DurationInSeconds pulumi.StringPtrInput `pulumi:"durationInSeconds"`
	// 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html) .
	Expression pulumi.StringInput `pulumi:"expression"`
}

func (CanaryScheduleArgs) ElementType 

func (CanaryScheduleArgs) ElementType() reflect.Type

func (CanaryScheduleArgs) ToCanaryScheduleOutput 

func (i CanaryScheduleArgs) ToCanaryScheduleOutput() CanaryScheduleOutput

func (CanaryScheduleArgs) ToCanaryScheduleOutputWithContext 

func (i CanaryScheduleArgs) ToCanaryScheduleOutputWithContext(ctx context.Context) CanaryScheduleOutput

type CanaryScheduleInput 

type CanaryScheduleInput interface {
	pulumi.Input

	ToCanaryScheduleOutput() CanaryScheduleOutput
	ToCanaryScheduleOutputWithContext(context.Context) CanaryScheduleOutput
}

CanaryScheduleInput is an input type that accepts CanaryScheduleArgs and CanaryScheduleOutput values. You can construct a concrete instance of `CanaryScheduleInput` via: 

CanaryScheduleArgs{...}

type CanaryScheduleOutput 

type CanaryScheduleOutput struct{ *pulumi.OutputState }

func (CanaryScheduleOutput) DurationInSeconds 

func (o CanaryScheduleOutput) DurationInSeconds() pulumi.StringPtrOutput

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.

func (CanaryScheduleOutput) ElementType 

func (CanaryScheduleOutput) ElementType() reflect.Type

func (CanaryScheduleOutput) Expression 

func (o CanaryScheduleOutput) Expression() pulumi.StringOutput

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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html) .

func (CanaryScheduleOutput) ToCanaryScheduleOutput 

func (o CanaryScheduleOutput) ToCanaryScheduleOutput() CanaryScheduleOutput

func (CanaryScheduleOutput) ToCanaryScheduleOutputWithContext 

func (o CanaryScheduleOutput) ToCanaryScheduleOutputWithContext(ctx context.Context) CanaryScheduleOutput

type CanarySchedulePtrOutput 

type CanarySchedulePtrOutput struct{ *pulumi.OutputState }

func (CanarySchedulePtrOutput) DurationInSeconds 

func (o CanarySchedulePtrOutput) DurationInSeconds() pulumi.StringPtrOutput

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.

func (CanarySchedulePtrOutput) Elem 

func (o CanarySchedulePtrOutput) Elem() CanaryScheduleOutput

func (CanarySchedulePtrOutput) ElementType 

func (CanarySchedulePtrOutput) ElementType() reflect.Type

func (CanarySchedulePtrOutput) Expression 

func (o CanarySchedulePtrOutput) Expression() pulumi.StringPtrOutput

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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html) .

func (CanarySchedulePtrOutput) ToCanarySchedulePtrOutput 

func (o CanarySchedulePtrOutput) ToCanarySchedulePtrOutput() CanarySchedulePtrOutput

func (CanarySchedulePtrOutput) ToCanarySchedulePtrOutputWithContext 

func (o CanarySchedulePtrOutput) ToCanarySchedulePtrOutputWithContext(ctx context.Context) CanarySchedulePtrOutput

type CanaryState 

type CanaryState struct {
}

func (CanaryState) ElementType 

func (CanaryState) ElementType() reflect.Type

type CanaryTag 

type CanaryTag struct {
	// 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 -.
	Key string `pulumi:"key"`
	// 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 -.
	Value string `pulumi:"value"`
}

A key-value pair to associate with a resource.

type CanaryVisualReference 

type CanaryVisualReference struct {
	// Canary run id to be used as base reference for visual testing
	BaseCanaryRunId string `pulumi:"baseCanaryRunId"`
	// List of screenshots used as base reference for visual testing
	BaseScreenshots []CanaryBaseScreenshot `pulumi:"baseScreenshots"`
}

type CanaryVisualReferenceArgs 

type CanaryVisualReferenceArgs struct {
	// Canary run id to be used as base reference for visual testing
	BaseCanaryRunId pulumi.StringInput `pulumi:"baseCanaryRunId"`
	// List of screenshots used as base reference for visual testing
	BaseScreenshots CanaryBaseScreenshotArrayInput `pulumi:"baseScreenshots"`
}

func (CanaryVisualReferenceArgs) ElementType 

func (CanaryVisualReferenceArgs) ElementType() reflect.Type

func (CanaryVisualReferenceArgs) ToCanaryVisualReferenceOutput 

func (i CanaryVisualReferenceArgs) ToCanaryVisualReferenceOutput() CanaryVisualReferenceOutput

func (CanaryVisualReferenceArgs) ToCanaryVisualReferenceOutputWithContext 

func (i CanaryVisualReferenceArgs) ToCanaryVisualReferenceOutputWithContext(ctx context.Context) CanaryVisualReferenceOutput

func (CanaryVisualReferenceArgs) ToCanaryVisualReferencePtrOutput 

func (i CanaryVisualReferenceArgs) ToCanaryVisualReferencePtrOutput() CanaryVisualReferencePtrOutput

func (CanaryVisualReferenceArgs) ToCanaryVisualReferencePtrOutputWithContext 

func (i CanaryVisualReferenceArgs) ToCanaryVisualReferencePtrOutputWithContext(ctx context.Context) CanaryVisualReferencePtrOutput

type CanaryVisualReferenceInput 

type CanaryVisualReferenceInput interface {
	pulumi.Input

	ToCanaryVisualReferenceOutput() CanaryVisualReferenceOutput
	ToCanaryVisualReferenceOutputWithContext(context.Context) CanaryVisualReferenceOutput
}

CanaryVisualReferenceInput is an input type that accepts CanaryVisualReferenceArgs and CanaryVisualReferenceOutput values. You can construct a concrete instance of `CanaryVisualReferenceInput` via: 

CanaryVisualReferenceArgs{...}

type CanaryVisualReferenceOutput 

type CanaryVisualReferenceOutput struct{ *pulumi.OutputState }

func (CanaryVisualReferenceOutput) BaseCanaryRunId 

func (o CanaryVisualReferenceOutput) BaseCanaryRunId() pulumi.StringOutput

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

func (CanaryVisualReferenceOutput) BaseScreenshots 

func (o CanaryVisualReferenceOutput) BaseScreenshots() CanaryBaseScreenshotArrayOutput

List of screenshots used as base reference for visual testing

func (CanaryVisualReferenceOutput) ElementType 

func (CanaryVisualReferenceOutput) ElementType() reflect.Type

func (CanaryVisualReferenceOutput) ToCanaryVisualReferenceOutput 

func (o CanaryVisualReferenceOutput) ToCanaryVisualReferenceOutput() CanaryVisualReferenceOutput

func (CanaryVisualReferenceOutput) ToCanaryVisualReferenceOutputWithContext 

func (o CanaryVisualReferenceOutput) ToCanaryVisualReferenceOutputWithContext(ctx context.Context) CanaryVisualReferenceOutput

func (CanaryVisualReferenceOutput) ToCanaryVisualReferencePtrOutput 

func (o CanaryVisualReferenceOutput) ToCanaryVisualReferencePtrOutput() CanaryVisualReferencePtrOutput

func (CanaryVisualReferenceOutput) ToCanaryVisualReferencePtrOutputWithContext 

func (o CanaryVisualReferenceOutput) ToCanaryVisualReferencePtrOutputWithContext(ctx context.Context) CanaryVisualReferencePtrOutput

type CanaryVisualReferencePtrInput 

type CanaryVisualReferencePtrInput interface {
	pulumi.Input

	ToCanaryVisualReferencePtrOutput() CanaryVisualReferencePtrOutput
	ToCanaryVisualReferencePtrOutputWithContext(context.Context) CanaryVisualReferencePtrOutput
}

CanaryVisualReferencePtrInput is an input type that accepts CanaryVisualReferenceArgs, CanaryVisualReferencePtr and CanaryVisualReferencePtrOutput values. You can construct a concrete instance of `CanaryVisualReferencePtrInput` via: 

        CanaryVisualReferenceArgs{...}

or:

        nil

func CanaryVisualReferencePtr 

func CanaryVisualReferencePtr(v *CanaryVisualReferenceArgs) CanaryVisualReferencePtrInput

type CanaryVisualReferencePtrOutput 

type CanaryVisualReferencePtrOutput struct{ *pulumi.OutputState }

func (CanaryVisualReferencePtrOutput) BaseCanaryRunId 

func (o CanaryVisualReferencePtrOutput) BaseCanaryRunId() pulumi.StringPtrOutput

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

func (CanaryVisualReferencePtrOutput) BaseScreenshots 

func (o CanaryVisualReferencePtrOutput) BaseScreenshots() CanaryBaseScreenshotArrayOutput

List of screenshots used as base reference for visual testing

func (CanaryVisualReferencePtrOutput) Elem 

func (o CanaryVisualReferencePtrOutput) Elem() CanaryVisualReferenceOutput

func (CanaryVisualReferencePtrOutput) ElementType 

func (CanaryVisualReferencePtrOutput) ElementType() reflect.Type

func (CanaryVisualReferencePtrOutput) ToCanaryVisualReferencePtrOutput 

func (o CanaryVisualReferencePtrOutput) ToCanaryVisualReferencePtrOutput() CanaryVisualReferencePtrOutput

func (CanaryVisualReferencePtrOutput) ToCanaryVisualReferencePtrOutputWithContext 

func (o CanaryVisualReferencePtrOutput) ToCanaryVisualReferencePtrOutputWithContext(ctx context.Context) CanaryVisualReferencePtrOutput

type CanaryVpcConfig added in v0.72.0 

type CanaryVpcConfig struct {
	// The IDs of the security groups for this canary.
	SecurityGroupIds []string `pulumi:"securityGroupIds"`
	// The IDs of the subnets where this canary is to run.
	SubnetIds []string `pulumi:"subnetIds"`
	// The ID of the VPC where this canary is to run.
	VpcId *string `pulumi:"vpcId"`
}

type CanaryVpcConfigArgs added in v0.72.0 

type CanaryVpcConfigArgs struct {
	// The IDs of the security groups for this canary.
	SecurityGroupIds pulumi.StringArrayInput `pulumi:"securityGroupIds"`
	// The IDs of the subnets where this canary is to run.
	SubnetIds pulumi.StringArrayInput `pulumi:"subnetIds"`
	// The ID of the VPC where this canary is to run.
	VpcId pulumi.StringPtrInput `pulumi:"vpcId"`
}

func (CanaryVpcConfigArgs) ElementType added in v0.72.0 

func (CanaryVpcConfigArgs) ElementType() reflect.Type

func (CanaryVpcConfigArgs) ToCanaryVpcConfigOutput added in v0.72.0 

func (i CanaryVpcConfigArgs) ToCanaryVpcConfigOutput() CanaryVpcConfigOutput

func (CanaryVpcConfigArgs) ToCanaryVpcConfigOutputWithContext added in v0.72.0 

func (i CanaryVpcConfigArgs) ToCanaryVpcConfigOutputWithContext(ctx context.Context) CanaryVpcConfigOutput

func (CanaryVpcConfigArgs) ToCanaryVpcConfigPtrOutput added in v0.72.0 

func (i CanaryVpcConfigArgs) ToCanaryVpcConfigPtrOutput() CanaryVpcConfigPtrOutput

func (CanaryVpcConfigArgs) ToCanaryVpcConfigPtrOutputWithContext added in v0.72.0 

func (i CanaryVpcConfigArgs) ToCanaryVpcConfigPtrOutputWithContext(ctx context.Context) CanaryVpcConfigPtrOutput

type CanaryVpcConfigInput added in v0.72.0 

type CanaryVpcConfigInput interface {
	pulumi.Input

	ToCanaryVpcConfigOutput() CanaryVpcConfigOutput
	ToCanaryVpcConfigOutputWithContext(context.Context) CanaryVpcConfigOutput
}

CanaryVpcConfigInput is an input type that accepts CanaryVpcConfigArgs and CanaryVpcConfigOutput values. You can construct a concrete instance of `CanaryVpcConfigInput` via: 

CanaryVpcConfigArgs{...}

type CanaryVpcConfigOutput added in v0.72.0 

type CanaryVpcConfigOutput struct{ *pulumi.OutputState }

func (CanaryVpcConfigOutput) ElementType added in v0.72.0 

func (CanaryVpcConfigOutput) ElementType() reflect.Type

func (CanaryVpcConfigOutput) SecurityGroupIds added in v0.72.0 

func (o CanaryVpcConfigOutput) SecurityGroupIds() pulumi.StringArrayOutput

The IDs of the security groups for this canary.

func (CanaryVpcConfigOutput) SubnetIds added in v0.72.0 

func (o CanaryVpcConfigOutput) SubnetIds() pulumi.StringArrayOutput

The IDs of the subnets where this canary is to run.

func (CanaryVpcConfigOutput) ToCanaryVpcConfigOutput added in v0.72.0 

func (o CanaryVpcConfigOutput) ToCanaryVpcConfigOutput() CanaryVpcConfigOutput

func (CanaryVpcConfigOutput) ToCanaryVpcConfigOutputWithContext added in v0.72.0 

func (o CanaryVpcConfigOutput) ToCanaryVpcConfigOutputWithContext(ctx context.Context) CanaryVpcConfigOutput

func (CanaryVpcConfigOutput) ToCanaryVpcConfigPtrOutput added in v0.72.0 

func (o CanaryVpcConfigOutput) ToCanaryVpcConfigPtrOutput() CanaryVpcConfigPtrOutput

func (CanaryVpcConfigOutput) ToCanaryVpcConfigPtrOutputWithContext added in v0.72.0 

func (o CanaryVpcConfigOutput) ToCanaryVpcConfigPtrOutputWithContext(ctx context.Context) CanaryVpcConfigPtrOutput

func (CanaryVpcConfigOutput) VpcId added in v0.72.0 

func (o CanaryVpcConfigOutput) VpcId() pulumi.StringPtrOutput

The ID of the VPC where this canary is to run.

type CanaryVpcConfigPtrInput added in v0.72.0 

type CanaryVpcConfigPtrInput interface {
	pulumi.Input

	ToCanaryVpcConfigPtrOutput() CanaryVpcConfigPtrOutput
	ToCanaryVpcConfigPtrOutputWithContext(context.Context) CanaryVpcConfigPtrOutput
}

CanaryVpcConfigPtrInput is an input type that accepts CanaryVpcConfigArgs, CanaryVpcConfigPtr and CanaryVpcConfigPtrOutput values. You can construct a concrete instance of `CanaryVpcConfigPtrInput` via: 

        CanaryVpcConfigArgs{...}

or:

        nil

func CanaryVpcConfigPtr added in v0.72.0 

func CanaryVpcConfigPtr(v *CanaryVpcConfigArgs) CanaryVpcConfigPtrInput

type CanaryVpcConfigPtrOutput added in v0.72.0 

type CanaryVpcConfigPtrOutput struct{ *pulumi.OutputState }

func (CanaryVpcConfigPtrOutput) Elem added in v0.72.0 

func (o CanaryVpcConfigPtrOutput) Elem() CanaryVpcConfigOutput

func (CanaryVpcConfigPtrOutput) ElementType added in v0.72.0 

func (CanaryVpcConfigPtrOutput) ElementType() reflect.Type

func (CanaryVpcConfigPtrOutput) SecurityGroupIds added in v0.72.0 

func (o CanaryVpcConfigPtrOutput) SecurityGroupIds() pulumi.StringArrayOutput

The IDs of the security groups for this canary.

func (CanaryVpcConfigPtrOutput) SubnetIds added in v0.72.0 

func (o CanaryVpcConfigPtrOutput) SubnetIds() pulumi.StringArrayOutput

The IDs of the subnets where this canary is to run.

func (CanaryVpcConfigPtrOutput) ToCanaryVpcConfigPtrOutput added in v0.72.0 

func (o CanaryVpcConfigPtrOutput) ToCanaryVpcConfigPtrOutput() CanaryVpcConfigPtrOutput

func (CanaryVpcConfigPtrOutput) ToCanaryVpcConfigPtrOutputWithContext added in v0.72.0 

func (o CanaryVpcConfigPtrOutput) ToCanaryVpcConfigPtrOutputWithContext(ctx context.Context) CanaryVpcConfigPtrOutput

func (CanaryVpcConfigPtrOutput) VpcId added in v0.72.0 

func (o CanaryVpcConfigPtrOutput) VpcId() pulumi.StringPtrOutput

The ID of the VPC where this canary is to run.

type Group added in v0.21.0 

type Group struct {
	pulumi.CustomResourceState

	// Id of the group.
	AwsId pulumi.StringOutput `pulumi:"awsId"`
	// Name of the group.
	Name pulumi.StringOutput `pulumi:"name"`
	// The ARNs of the canaries that you want to associate with this group.
	ResourceArns pulumi.StringArrayOutput `pulumi:"resourceArns"`
	// The list of key-value pairs that are associated with the group.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

Resource Type definition for AWS::Synthetics::Group

func GetGroup added in v0.21.0 

func GetGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GroupState, opts ...pulumi.ResourceOption) (*Group, error)

GetGroup gets an existing Group 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 NewGroup added in v0.21.0 

func NewGroup(ctx *pulumi.Context,
	name string, args *GroupArgs, opts ...pulumi.ResourceOption) (*Group, error)

NewGroup registers a new resource with the given unique name, arguments, and options.

func (*Group) ElementType added in v0.21.0 

func (*Group) ElementType() reflect.Type

func (*Group) ToGroupOutput added in v0.21.0 

func (i *Group) ToGroupOutput() GroupOutput

func (*Group) ToGroupOutputWithContext added in v0.21.0 

func (i *Group) ToGroupOutputWithContext(ctx context.Context) GroupOutput

type GroupArgs added in v0.21.0 

type GroupArgs struct {
	// Name of the group.
	Name pulumi.StringPtrInput
	// The ARNs of the canaries that you want to associate with this group.
	ResourceArns pulumi.StringArrayInput
	// The list of key-value pairs that are associated with the group.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a Group resource.

func (GroupArgs) ElementType added in v0.21.0 

func (GroupArgs) ElementType() reflect.Type

type GroupInput added in v0.21.0 

type GroupInput interface {
	pulumi.Input

	ToGroupOutput() GroupOutput
	ToGroupOutputWithContext(ctx context.Context) GroupOutput
}

type GroupOutput added in v0.21.0 

type GroupOutput struct{ *pulumi.OutputState }

func (GroupOutput) AwsId added in v0.99.0 

func (o GroupOutput) AwsId() pulumi.StringOutput

Id of the group.

func (GroupOutput) ElementType added in v0.21.0 

func (GroupOutput) ElementType() reflect.Type

func (GroupOutput) Name added in v0.21.0 

func (o GroupOutput) Name() pulumi.StringOutput

Name of the group.

func (GroupOutput) ResourceArns added in v0.21.0 

func (o GroupOutput) ResourceArns() pulumi.StringArrayOutput

The ARNs of the canaries that you want to associate with this group.

func (GroupOutput) Tags added in v0.21.0 

func (o GroupOutput) Tags() aws.TagArrayOutput

The list of key-value pairs that are associated with the group.

func (GroupOutput) ToGroupOutput added in v0.21.0 

func (o GroupOutput) ToGroupOutput() GroupOutput

func (GroupOutput) ToGroupOutputWithContext added in v0.21.0 

func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput

type GroupState added in v0.21.0 

type GroupState struct {
}

func (GroupState) ElementType added in v0.21.0 

func (GroupState) ElementType() reflect.Type

type GroupTag added in v0.21.0 

type GroupTag struct {
	// 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 -.
	Key string `pulumi:"key"`
	// 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 -.
	Value string `pulumi:"value"`
}

A key-value pair to associate with a resource.

type LookupCanaryArgs added in v0.12.0 

type LookupCanaryArgs struct {
	// Name of the canary.
	Name string `pulumi:"name"`
}

type LookupCanaryOutputArgs added in v0.12.0 

type LookupCanaryOutputArgs struct {
	// Name of the canary.
	Name pulumi.StringInput `pulumi:"name"`
}

func (LookupCanaryOutputArgs) ElementType added in v0.12.0 

func (LookupCanaryOutputArgs) ElementType() reflect.Type

type LookupCanaryResult added in v0.12.0 

type LookupCanaryResult struct {
	// Provide artifact configuration
	ArtifactConfig *CanaryArtifactConfig `pulumi:"artifactConfig"`
	// Provide the s3 bucket output location for test results
	ArtifactS3Location *string `pulumi:"artifactS3Location"`
	// Provide the canary script source
	Code *CanaryCode `pulumi:"code"`
	// Lambda Execution role used to run your canaries
	ExecutionRoleArn *string `pulumi:"executionRoleArn"`
	// Retention period of failed canary runs represented in number of days
	FailureRetentionPeriod *int `pulumi:"failureRetentionPeriod"`
	// Id of the canary
	Id *string `pulumi:"id"`
	// Provide canary run configuration
	RunConfig *CanaryRunConfig `pulumi:"runConfig"`
	// Runtime version of Synthetics Library
	RuntimeVersion *string `pulumi:"runtimeVersion"`
	// Frequency to run your canaries
	Schedule *CanarySchedule `pulumi:"schedule"`
	// State of the canary
	State *string `pulumi:"state"`
	// Retention period of successful canary runs represented in number of days
	SuccessRetentionPeriod *int `pulumi:"successRetentionPeriod"`
	// The list of key-value pairs that are associated with the canary.
	Tags []aws.Tag `pulumi:"tags"`
	// Provide VPC Configuration if enabled.
	VpcConfig *CanaryVpcConfig `pulumi:"vpcConfig"`
}

func LookupCanary added in v0.12.0 

func LookupCanary(ctx *pulumi.Context, args *LookupCanaryArgs, opts ...pulumi.InvokeOption) (*LookupCanaryResult, error)

Resource Type definition for AWS::Synthetics::Canary

type LookupCanaryResultOutput added in v0.12.0 

type LookupCanaryResultOutput struct{ *pulumi.OutputState }

func LookupCanaryOutput added in v0.12.0 

func LookupCanaryOutput(ctx *pulumi.Context, args LookupCanaryOutputArgs, opts ...pulumi.InvokeOption) LookupCanaryResultOutput

func (LookupCanaryResultOutput) ArtifactConfig added in v0.12.0 

func (o LookupCanaryResultOutput) ArtifactConfig() CanaryArtifactConfigPtrOutput

Provide artifact configuration

func (LookupCanaryResultOutput) ArtifactS3Location added in v0.12.0 

func (o LookupCanaryResultOutput) ArtifactS3Location() pulumi.StringPtrOutput

Provide the s3 bucket output location for test results

func (LookupCanaryResultOutput) Code added in v0.12.0 

func (o LookupCanaryResultOutput) Code() CanaryCodePtrOutput

Provide the canary script source

func (LookupCanaryResultOutput) ElementType added in v0.12.0 

func (LookupCanaryResultOutput) ElementType() reflect.Type

func (LookupCanaryResultOutput) ExecutionRoleArn added in v0.12.0 

func (o LookupCanaryResultOutput) ExecutionRoleArn() pulumi.StringPtrOutput

Lambda Execution role used to run your canaries

func (LookupCanaryResultOutput) FailureRetentionPeriod added in v0.12.0 

func (o LookupCanaryResultOutput) FailureRetentionPeriod() pulumi.IntPtrOutput

Retention period of failed canary runs represented in number of days

func (LookupCanaryResultOutput) Id added in v0.12.0 

func (o LookupCanaryResultOutput) Id() pulumi.StringPtrOutput

Id of the canary

func (LookupCanaryResultOutput) RunConfig added in v0.12.0 

func (o LookupCanaryResultOutput) RunConfig() CanaryRunConfigPtrOutput

Provide canary run configuration

func (LookupCanaryResultOutput) RuntimeVersion added in v0.12.0 

func (o LookupCanaryResultOutput) RuntimeVersion() pulumi.StringPtrOutput

Runtime version of Synthetics Library

func (LookupCanaryResultOutput) Schedule added in v0.12.0 

func (o LookupCanaryResultOutput) Schedule() CanarySchedulePtrOutput

Frequency to run your canaries

func (LookupCanaryResultOutput) State added in v0.12.0 

func (o LookupCanaryResultOutput) State() pulumi.StringPtrOutput

State of the canary

func (LookupCanaryResultOutput) SuccessRetentionPeriod added in v0.12.0 

func (o LookupCanaryResultOutput) SuccessRetentionPeriod() pulumi.IntPtrOutput

Retention period of successful canary runs represented in number of days

func (LookupCanaryResultOutput) Tags added in v0.12.0 

func (o LookupCanaryResultOutput) Tags() aws.TagArrayOutput

The list of key-value pairs that are associated with the canary.

func (LookupCanaryResultOutput) ToLookupCanaryResultOutput added in v0.12.0 

func (o LookupCanaryResultOutput) ToLookupCanaryResultOutput() LookupCanaryResultOutput

func (LookupCanaryResultOutput) ToLookupCanaryResultOutputWithContext added in v0.12.0 

func (o LookupCanaryResultOutput) ToLookupCanaryResultOutputWithContext(ctx context.Context) LookupCanaryResultOutput

func (LookupCanaryResultOutput) VpcConfig added in v0.72.0 

func (o LookupCanaryResultOutput) VpcConfig() CanaryVpcConfigPtrOutput

Provide VPC Configuration if enabled.

type LookupGroupArgs added in v0.21.0 

type LookupGroupArgs struct {
	// Name of the group.
	Name string `pulumi:"name"`
}

type LookupGroupOutputArgs added in v0.21.0 

type LookupGroupOutputArgs struct {
	// Name of the group.
	Name pulumi.StringInput `pulumi:"name"`
}

func (LookupGroupOutputArgs) ElementType added in v0.21.0 

func (LookupGroupOutputArgs) ElementType() reflect.Type

type LookupGroupResult added in v0.21.0 

type LookupGroupResult struct {
	// Id of the group.
	Id *string `pulumi:"id"`
	// The ARNs of the canaries that you want to associate with this group.
	ResourceArns []string `pulumi:"resourceArns"`
	// The list of key-value pairs that are associated with the group.
	Tags []aws.Tag `pulumi:"tags"`
}

func LookupGroup added in v0.21.0 

func LookupGroup(ctx *pulumi.Context, args *LookupGroupArgs, opts ...pulumi.InvokeOption) (*LookupGroupResult, error)

Resource Type definition for AWS::Synthetics::Group

type LookupGroupResultOutput added in v0.21.0 

type LookupGroupResultOutput struct{ *pulumi.OutputState }

func LookupGroupOutput added in v0.21.0 

func LookupGroupOutput(ctx *pulumi.Context, args LookupGroupOutputArgs, opts ...pulumi.InvokeOption) LookupGroupResultOutput

func (LookupGroupResultOutput) ElementType added in v0.21.0 

func (LookupGroupResultOutput) ElementType() reflect.Type

func (LookupGroupResultOutput) Id added in v0.21.0 

func (o LookupGroupResultOutput) Id() pulumi.StringPtrOutput

Id of the group.

func (LookupGroupResultOutput) ResourceArns added in v0.21.0 

func (o LookupGroupResultOutput) ResourceArns() pulumi.StringArrayOutput

The ARNs of the canaries that you want to associate with this group.

func (LookupGroupResultOutput) Tags added in v0.21.0 

func (o LookupGroupResultOutput) Tags() aws.TagArrayOutput

The list of key-value pairs that are associated with the group.

func (LookupGroupResultOutput) ToLookupGroupResultOutput added in v0.21.0 

func (o LookupGroupResultOutput) ToLookupGroupResultOutput() LookupGroupResultOutput

func (LookupGroupResultOutput) ToLookupGroupResultOutputWithContext added in v0.21.0 

func (o LookupGroupResultOutput) ToLookupGroupResultOutputWithContext(ctx context.Context) LookupGroupResultOutput

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.