synthetics

package
v4.0.0-beta.2 Latest Latest
Warning

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

 Go to latest Published: Apr 8, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Canary 

type Canary struct {
	pulumi.CustomResourceState

	// Amazon Resource Name (ARN) of the Canary.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
	ArtifactS3Location pulumi.StringOutput `pulumi:"artifactS3Location"`
	// 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.
	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. Specify the full bucket name including s3:// as the start of the bucket name. **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.
	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
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// 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 5 MB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**
	ZipFile pulumi.StringPtrOutput `pulumi:"zipFile"`
}

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

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v4/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{
			ArtifactS3Location: pulumi.String("s3://some-bucket/"),
			ExecutionRoleArn:   pulumi.String("some-role"),
			Handler:            pulumi.String("exports.handler"),
			RuntimeVersion:     pulumi.String("syn-1.0"),
			Schedule: &synthetics.CanaryScheduleArgs{
				Expression: pulumi.String("rate(0 minute)"),
			},
			ZipFile: pulumi.String("test-fixtures/lambdatest.zip"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Synthetics Canaries can be imported using the `name`, e.g.

```sh 

$ pulumi import aws:synthetics/canary:Canary some some-canary

```

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

func (*Canary) ToCanaryPtrOutput 

func (i *Canary) ToCanaryPtrOutput() CanaryPtrOutput

func (*Canary) ToCanaryPtrOutputWithContext 

func (i *Canary) ToCanaryPtrOutputWithContext(ctx context.Context) CanaryPtrOutput

type CanaryArgs 

type CanaryArgs struct {
	// Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
	ArtifactS3Location pulumi.StringInput
	// 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.
	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. Specify the full bucket name including s3:// as the start of the bucket name. **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.
	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
	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 5 MB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**
	ZipFile pulumi.StringPtrInput
}

The set of arguments for constructing a Canary resource.

func (CanaryArgs) ElementType 

func (CanaryArgs) ElementType() reflect.Type

type CanaryArray 

type CanaryArray []CanaryInput

func (CanaryArray) ElementType 

func (CanaryArray) ElementType() reflect.Type

func (CanaryArray) ToCanaryArrayOutput 

func (i CanaryArray) ToCanaryArrayOutput() CanaryArrayOutput

func (CanaryArray) ToCanaryArrayOutputWithContext 

func (i CanaryArray) ToCanaryArrayOutputWithContext(ctx context.Context) CanaryArrayOutput

type CanaryArrayInput 

type CanaryArrayInput interface {
	pulumi.Input

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

CanaryArrayInput is an input type that accepts CanaryArray and CanaryArrayOutput values. You can construct a concrete instance of `CanaryArrayInput` via: 

CanaryArray{ CanaryArgs{...} }

type CanaryArrayOutput 

type CanaryArrayOutput struct{ *pulumi.OutputState }

func (CanaryArrayOutput) ElementType 

func (CanaryArrayOutput) ElementType() reflect.Type

func (CanaryArrayOutput) Index 

func (o CanaryArrayOutput) Index(i pulumi.IntInput) CanaryOutput

func (CanaryArrayOutput) ToCanaryArrayOutput 

func (o CanaryArrayOutput) ToCanaryArrayOutput() CanaryArrayOutput

func (CanaryArrayOutput) ToCanaryArrayOutputWithContext 

func (o CanaryArrayOutput) ToCanaryArrayOutputWithContext(ctx context.Context) CanaryArrayOutput

type CanaryInput 

type CanaryInput interface {
	pulumi.Input

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

type CanaryMap 

type CanaryMap map[string]CanaryInput

func (CanaryMap) ElementType 

func (CanaryMap) ElementType() reflect.Type

func (CanaryMap) ToCanaryMapOutput 

func (i CanaryMap) ToCanaryMapOutput() CanaryMapOutput

func (CanaryMap) ToCanaryMapOutputWithContext 

func (i CanaryMap) ToCanaryMapOutputWithContext(ctx context.Context) CanaryMapOutput

type CanaryMapInput 

type CanaryMapInput interface {
	pulumi.Input

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

CanaryMapInput is an input type that accepts CanaryMap and CanaryMapOutput values. You can construct a concrete instance of `CanaryMapInput` via: 

CanaryMap{ "key": CanaryArgs{...} }

type CanaryMapOutput 

type CanaryMapOutput struct{ *pulumi.OutputState }

func (CanaryMapOutput) ElementType 

func (CanaryMapOutput) ElementType() reflect.Type

func (CanaryMapOutput) MapIndex 

func (o CanaryMapOutput) MapIndex(k pulumi.StringInput) CanaryOutput

func (CanaryMapOutput) ToCanaryMapOutput 

func (o CanaryMapOutput) ToCanaryMapOutput() CanaryMapOutput

func (CanaryMapOutput) ToCanaryMapOutputWithContext 

func (o CanaryMapOutput) ToCanaryMapOutputWithContext(ctx context.Context) CanaryMapOutput

type CanaryOutput 

type CanaryOutput struct {
	*pulumi.OutputState
}

func (CanaryOutput) ElementType 

func (CanaryOutput) ElementType() reflect.Type

func (CanaryOutput) ToCanaryOutput 

func (o CanaryOutput) ToCanaryOutput() CanaryOutput

func (CanaryOutput) ToCanaryOutputWithContext 

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

func (CanaryOutput) ToCanaryPtrOutput 

func (o CanaryOutput) ToCanaryPtrOutput() CanaryPtrOutput

func (CanaryOutput) ToCanaryPtrOutputWithContext 

func (o CanaryOutput) ToCanaryPtrOutputWithContext(ctx context.Context) CanaryPtrOutput

type CanaryPtrInput 

type CanaryPtrInput interface {
	pulumi.Input

	ToCanaryPtrOutput() CanaryPtrOutput
	ToCanaryPtrOutputWithContext(ctx context.Context) CanaryPtrOutput
}

type CanaryPtrOutput 

type CanaryPtrOutput struct {
	*pulumi.OutputState
}

func (CanaryPtrOutput) ElementType 

func (CanaryPtrOutput) ElementType() reflect.Type

func (CanaryPtrOutput) ToCanaryPtrOutput 

func (o CanaryPtrOutput) ToCanaryPtrOutput() CanaryPtrOutput

func (CanaryPtrOutput) ToCanaryPtrOutputWithContext 

func (o CanaryPtrOutput) ToCanaryPtrOutputWithContext(ctx context.Context) CanaryPtrOutput

type CanaryRunConfig 

type CanaryRunConfig struct {
	// Whether this canary is to use active AWS X-Ray tracing when it runs. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.
	ActiveTracing *bool `pulumi:"activeTracing"`
	// Maximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.
	MemoryInMb *int `pulumi:"memoryInMb"`
	// Number of seconds the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used, up to a maximum of 840 (14 minutes).
	TimeoutInSeconds *int `pulumi:"timeoutInSeconds"`
}

type CanaryRunConfigArgs 

type CanaryRunConfigArgs struct {
	// Whether this canary is to use active AWS X-Ray tracing when it runs. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.
	ActiveTracing pulumi.BoolPtrInput `pulumi:"activeTracing"`
	// Maximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.
	MemoryInMb pulumi.IntPtrInput `pulumi:"memoryInMb"`
	// Number of seconds the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used, up to a maximum of 840 (14 minutes).
	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

Whether this canary is to use active AWS X-Ray tracing when it runs. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.

func (CanaryRunConfigOutput) ElementType 

func (CanaryRunConfigOutput) ElementType() reflect.Type

func (CanaryRunConfigOutput) MemoryInMb 

func (o CanaryRunConfigOutput) MemoryInMb() pulumi.IntPtrOutput

Maximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.

func (CanaryRunConfigOutput) TimeoutInSeconds 

func (o CanaryRunConfigOutput) TimeoutInSeconds() pulumi.IntPtrOutput

Number of seconds the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used, up to a maximum of 840 (14 minutes).

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

Whether this canary is to use active AWS X-Ray tracing when it runs. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.

func (CanaryRunConfigPtrOutput) Elem 

func (o CanaryRunConfigPtrOutput) Elem() CanaryRunConfigOutput

func (CanaryRunConfigPtrOutput) ElementType 

func (CanaryRunConfigPtrOutput) ElementType() reflect.Type

func (CanaryRunConfigPtrOutput) MemoryInMb 

func (o CanaryRunConfigPtrOutput) MemoryInMb() pulumi.IntPtrOutput

Maximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64.

func (CanaryRunConfigPtrOutput) TimeoutInSeconds 

func (o CanaryRunConfigPtrOutput) TimeoutInSeconds() pulumi.IntPtrOutput

Number of seconds the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used, up to a maximum of 840 (14 minutes).

func (CanaryRunConfigPtrOutput) ToCanaryRunConfigPtrOutput 

func (o CanaryRunConfigPtrOutput) ToCanaryRunConfigPtrOutput() CanaryRunConfigPtrOutput

func (CanaryRunConfigPtrOutput) ToCanaryRunConfigPtrOutputWithContext 

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

type CanarySchedule 

type CanarySchedule struct {
	// Duration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.
	DurationInSeconds *int `pulumi:"durationInSeconds"`
	// Rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour.
	Expression string `pulumi:"expression"`
}

type CanaryScheduleArgs 

type CanaryScheduleArgs struct {
	// Duration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.
	DurationInSeconds pulumi.IntPtrInput `pulumi:"durationInSeconds"`
	// Rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour.
	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

func (CanaryScheduleArgs) ToCanarySchedulePtrOutput 

func (i CanaryScheduleArgs) ToCanarySchedulePtrOutput() CanarySchedulePtrOutput

func (CanaryScheduleArgs) ToCanarySchedulePtrOutputWithContext 

func (i CanaryScheduleArgs) ToCanarySchedulePtrOutputWithContext(ctx context.Context) CanarySchedulePtrOutput

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.IntPtrOutput

Duration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

func (CanaryScheduleOutput) ElementType 

func (CanaryScheduleOutput) ElementType() reflect.Type

func (CanaryScheduleOutput) Expression 

func (o CanaryScheduleOutput) Expression() pulumi.StringOutput

Rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour.

func (CanaryScheduleOutput) ToCanaryScheduleOutput 

func (o CanaryScheduleOutput) ToCanaryScheduleOutput() CanaryScheduleOutput

func (CanaryScheduleOutput) ToCanaryScheduleOutputWithContext 

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

func (CanaryScheduleOutput) ToCanarySchedulePtrOutput 

func (o CanaryScheduleOutput) ToCanarySchedulePtrOutput() CanarySchedulePtrOutput

func (CanaryScheduleOutput) ToCanarySchedulePtrOutputWithContext 

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

type CanarySchedulePtrInput 

type CanarySchedulePtrInput interface {
	pulumi.Input

	ToCanarySchedulePtrOutput() CanarySchedulePtrOutput
	ToCanarySchedulePtrOutputWithContext(context.Context) CanarySchedulePtrOutput
}

CanarySchedulePtrInput is an input type that accepts CanaryScheduleArgs, CanarySchedulePtr and CanarySchedulePtrOutput values. You can construct a concrete instance of `CanarySchedulePtrInput` via: 

        CanaryScheduleArgs{...}

or:

        nil

func CanarySchedulePtr 

func CanarySchedulePtr(v *CanaryScheduleArgs) CanarySchedulePtrInput

type CanarySchedulePtrOutput 

type CanarySchedulePtrOutput struct{ *pulumi.OutputState }

func (CanarySchedulePtrOutput) DurationInSeconds 

func (o CanarySchedulePtrOutput) DurationInSeconds() pulumi.IntPtrOutput

Duration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

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

Rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour.

func (CanarySchedulePtrOutput) ToCanarySchedulePtrOutput 

func (o CanarySchedulePtrOutput) ToCanarySchedulePtrOutput() CanarySchedulePtrOutput

func (CanarySchedulePtrOutput) ToCanarySchedulePtrOutputWithContext 

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

type CanaryState 

type CanaryState struct {
	// Amazon Resource Name (ARN) of the Canary.
	Arn pulumi.StringPtrInput
	// Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
	ArtifactS3Location pulumi.StringPtrInput
	// 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.
	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. Specify the full bucket name including s3:// as the start of the bucket name. **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.
	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
	Tags 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 5 MB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**
	ZipFile pulumi.StringPtrInput
}

func (CanaryState) ElementType 

func (CanaryState) ElementType() reflect.Type

type CanaryTimeline 

type CanaryTimeline struct {
	// Date and time the canary was created.
	Created *string `pulumi:"created"`
	// Date and time the canary was most recently modified.
	LastModified *string `pulumi:"lastModified"`
	// Date and time that the canary's most recent run started.
	LastStarted *string `pulumi:"lastStarted"`
	// Date and time that the canary's most recent run ended.
	LastStopped *string `pulumi:"lastStopped"`
}

type CanaryTimelineArgs 

type CanaryTimelineArgs struct {
	// Date and time the canary was created.
	Created pulumi.StringPtrInput `pulumi:"created"`
	// Date and time the canary was most recently modified.
	LastModified pulumi.StringPtrInput `pulumi:"lastModified"`
	// Date and time that the canary's most recent run started.
	LastStarted pulumi.StringPtrInput `pulumi:"lastStarted"`
	// Date and time that the canary's most recent run ended.
	LastStopped pulumi.StringPtrInput `pulumi:"lastStopped"`
}

func (CanaryTimelineArgs) ElementType 

func (CanaryTimelineArgs) ElementType() reflect.Type

func (CanaryTimelineArgs) ToCanaryTimelineOutput 

func (i CanaryTimelineArgs) ToCanaryTimelineOutput() CanaryTimelineOutput

func (CanaryTimelineArgs) ToCanaryTimelineOutputWithContext 

func (i CanaryTimelineArgs) ToCanaryTimelineOutputWithContext(ctx context.Context) CanaryTimelineOutput

type CanaryTimelineArray 

type CanaryTimelineArray []CanaryTimelineInput

func (CanaryTimelineArray) ElementType 

func (CanaryTimelineArray) ElementType() reflect.Type

func (CanaryTimelineArray) ToCanaryTimelineArrayOutput 

func (i CanaryTimelineArray) ToCanaryTimelineArrayOutput() CanaryTimelineArrayOutput

func (CanaryTimelineArray) ToCanaryTimelineArrayOutputWithContext 

func (i CanaryTimelineArray) ToCanaryTimelineArrayOutputWithContext(ctx context.Context) CanaryTimelineArrayOutput

type CanaryTimelineArrayInput 

type CanaryTimelineArrayInput interface {
	pulumi.Input

	ToCanaryTimelineArrayOutput() CanaryTimelineArrayOutput
	ToCanaryTimelineArrayOutputWithContext(context.Context) CanaryTimelineArrayOutput
}

CanaryTimelineArrayInput is an input type that accepts CanaryTimelineArray and CanaryTimelineArrayOutput values. You can construct a concrete instance of `CanaryTimelineArrayInput` via: 

CanaryTimelineArray{ CanaryTimelineArgs{...} }

type CanaryTimelineArrayOutput 

type CanaryTimelineArrayOutput struct{ *pulumi.OutputState }

func (CanaryTimelineArrayOutput) ElementType 

func (CanaryTimelineArrayOutput) ElementType() reflect.Type

func (CanaryTimelineArrayOutput) Index 

func (o CanaryTimelineArrayOutput) Index(i pulumi.IntInput) CanaryTimelineOutput

func (CanaryTimelineArrayOutput) ToCanaryTimelineArrayOutput 

func (o CanaryTimelineArrayOutput) ToCanaryTimelineArrayOutput() CanaryTimelineArrayOutput

func (CanaryTimelineArrayOutput) ToCanaryTimelineArrayOutputWithContext 

func (o CanaryTimelineArrayOutput) ToCanaryTimelineArrayOutputWithContext(ctx context.Context) CanaryTimelineArrayOutput

type CanaryTimelineInput 

type CanaryTimelineInput interface {
	pulumi.Input

	ToCanaryTimelineOutput() CanaryTimelineOutput
	ToCanaryTimelineOutputWithContext(context.Context) CanaryTimelineOutput
}

CanaryTimelineInput is an input type that accepts CanaryTimelineArgs and CanaryTimelineOutput values. You can construct a concrete instance of `CanaryTimelineInput` via: 

CanaryTimelineArgs{...}

type CanaryTimelineOutput 

type CanaryTimelineOutput struct{ *pulumi.OutputState }

func (CanaryTimelineOutput) Created 

func (o CanaryTimelineOutput) Created() pulumi.StringPtrOutput

Date and time the canary was created.

func (CanaryTimelineOutput) ElementType 

func (CanaryTimelineOutput) ElementType() reflect.Type

func (CanaryTimelineOutput) LastModified 

func (o CanaryTimelineOutput) LastModified() pulumi.StringPtrOutput

Date and time the canary was most recently modified.

func (CanaryTimelineOutput) LastStarted 

func (o CanaryTimelineOutput) LastStarted() pulumi.StringPtrOutput

Date and time that the canary's most recent run started.

func (CanaryTimelineOutput) LastStopped 

func (o CanaryTimelineOutput) LastStopped() pulumi.StringPtrOutput

Date and time that the canary's most recent run ended.

func (CanaryTimelineOutput) ToCanaryTimelineOutput 

func (o CanaryTimelineOutput) ToCanaryTimelineOutput() CanaryTimelineOutput

func (CanaryTimelineOutput) ToCanaryTimelineOutputWithContext 

func (o CanaryTimelineOutput) ToCanaryTimelineOutputWithContext(ctx context.Context) CanaryTimelineOutput

type CanaryVpcConfig 

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

type CanaryVpcConfigArgs 

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

func (CanaryVpcConfigArgs) ElementType 

func (CanaryVpcConfigArgs) ElementType() reflect.Type

func (CanaryVpcConfigArgs) ToCanaryVpcConfigOutput 

func (i CanaryVpcConfigArgs) ToCanaryVpcConfigOutput() CanaryVpcConfigOutput

func (CanaryVpcConfigArgs) ToCanaryVpcConfigOutputWithContext 

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

func (CanaryVpcConfigArgs) ToCanaryVpcConfigPtrOutput 

func (i CanaryVpcConfigArgs) ToCanaryVpcConfigPtrOutput() CanaryVpcConfigPtrOutput

func (CanaryVpcConfigArgs) ToCanaryVpcConfigPtrOutputWithContext 

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

type CanaryVpcConfigInput 

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 

type CanaryVpcConfigOutput struct{ *pulumi.OutputState }

func (CanaryVpcConfigOutput) ElementType 

func (CanaryVpcConfigOutput) ElementType() reflect.Type

func (CanaryVpcConfigOutput) SecurityGroupIds 

func (o CanaryVpcConfigOutput) SecurityGroupIds() pulumi.StringArrayOutput

IDs of the security groups for this canary.

func (CanaryVpcConfigOutput) SubnetIds 

func (o CanaryVpcConfigOutput) SubnetIds() pulumi.StringArrayOutput

IDs of the subnets where this canary is to run.

func (CanaryVpcConfigOutput) ToCanaryVpcConfigOutput 

func (o CanaryVpcConfigOutput) ToCanaryVpcConfigOutput() CanaryVpcConfigOutput

func (CanaryVpcConfigOutput) ToCanaryVpcConfigOutputWithContext 

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

func (CanaryVpcConfigOutput) ToCanaryVpcConfigPtrOutput 

func (o CanaryVpcConfigOutput) ToCanaryVpcConfigPtrOutput() CanaryVpcConfigPtrOutput

func (CanaryVpcConfigOutput) ToCanaryVpcConfigPtrOutputWithContext 

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

func (CanaryVpcConfigOutput) VpcId 

func (o CanaryVpcConfigOutput) VpcId() pulumi.StringPtrOutput

ID of the VPC where this canary is to run.

type CanaryVpcConfigPtrInput 

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 

func CanaryVpcConfigPtr(v *CanaryVpcConfigArgs) CanaryVpcConfigPtrInput

type CanaryVpcConfigPtrOutput 

type CanaryVpcConfigPtrOutput struct{ *pulumi.OutputState }

func (CanaryVpcConfigPtrOutput) Elem 

func (o CanaryVpcConfigPtrOutput) Elem() CanaryVpcConfigOutput

func (CanaryVpcConfigPtrOutput) ElementType 

func (CanaryVpcConfigPtrOutput) ElementType() reflect.Type

func (CanaryVpcConfigPtrOutput) SecurityGroupIds 

func (o CanaryVpcConfigPtrOutput) SecurityGroupIds() pulumi.StringArrayOutput

IDs of the security groups for this canary.

func (CanaryVpcConfigPtrOutput) SubnetIds 

func (o CanaryVpcConfigPtrOutput) SubnetIds() pulumi.StringArrayOutput

IDs of the subnets where this canary is to run.

func (CanaryVpcConfigPtrOutput) ToCanaryVpcConfigPtrOutput 

func (o CanaryVpcConfigPtrOutput) ToCanaryVpcConfigPtrOutput() CanaryVpcConfigPtrOutput

func (CanaryVpcConfigPtrOutput) ToCanaryVpcConfigPtrOutputWithContext 

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

func (CanaryVpcConfigPtrOutput) VpcId 

func (o CanaryVpcConfigPtrOutput) VpcId() pulumi.StringPtrOutput

ID of the VPC where this canary is to run.

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.