synthetics

package
v6.32.0 Latest Latest
Warning

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

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

Provides a Synthetics Canary resource.

> **NOTE:** When you create a canary, AWS creates supporting implicit resources. See the Amazon CloudWatch Synthetics documentation on [DeleteCanary](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html) for a full list. Neither AWS nor this provider deletes these implicit resources automatically when the canary is deleted. Before deleting a canary, ensure you have all the information about the canary that you need to delete the implicit resources using the AWS Console, or AWS CLI.

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import (

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

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synthetics.NewCanary(ctx, "some", &synthetics.CanaryArgs{
			Name:               pulumi.String("some-canary"),
			ArtifactS3Location: pulumi.String("s3://some-bucket/"),
			ExecutionRoleArn:   pulumi.String("some-role"),
			Handler:            pulumi.String("exports.handler"),
			ZipFile:            pulumi.String("test-fixtures/lambdatest.zip"),
			RuntimeVersion:     pulumi.String("syn-1.0"),
			Schedule: &synthetics.CanaryScheduleArgs{
				Expression: pulumi.String("rate(0 minute)"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Using `pulumi import`, import Synthetics Canaries using the `name`. For example:

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

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

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 (CanaryArrayOutput) ToCanaryArrayOutput

func (o CanaryArrayOutput) ToCanaryArrayOutput() CanaryArrayOutput

func (CanaryArrayOutput) ToCanaryArrayOutputWithContext

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

type CanaryArtifactConfig

type CanaryArtifactConfig struct {
	// Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.
	S3Encryption *CanaryArtifactConfigS3Encryption `pulumi:"s3Encryption"`
}

type CanaryArtifactConfigArgs

type CanaryArtifactConfigArgs struct {
	// Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.
	S3Encryption CanaryArtifactConfigS3EncryptionPtrInput `pulumi:"s3Encryption"`
}

func (CanaryArtifactConfigArgs) ElementType

func (CanaryArtifactConfigArgs) ElementType() reflect.Type

func (CanaryArtifactConfigArgs) ToCanaryArtifactConfigOutput

func (i CanaryArtifactConfigArgs) ToCanaryArtifactConfigOutput() CanaryArtifactConfigOutput

func (CanaryArtifactConfigArgs) ToCanaryArtifactConfigOutputWithContext

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

func (CanaryArtifactConfigArgs) ToCanaryArtifactConfigPtrOutput

func (i CanaryArtifactConfigArgs) ToCanaryArtifactConfigPtrOutput() CanaryArtifactConfigPtrOutput

func (CanaryArtifactConfigArgs) ToCanaryArtifactConfigPtrOutputWithContext

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

type CanaryArtifactConfigInput

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

type CanaryArtifactConfigOutput struct{ *pulumi.OutputState }

func (CanaryArtifactConfigOutput) ElementType

func (CanaryArtifactConfigOutput) ElementType() reflect.Type

func (CanaryArtifactConfigOutput) S3Encryption

Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

func (CanaryArtifactConfigOutput) ToCanaryArtifactConfigOutput

func (o CanaryArtifactConfigOutput) ToCanaryArtifactConfigOutput() CanaryArtifactConfigOutput

func (CanaryArtifactConfigOutput) ToCanaryArtifactConfigOutputWithContext

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

func (CanaryArtifactConfigOutput) ToCanaryArtifactConfigPtrOutput

func (o CanaryArtifactConfigOutput) ToCanaryArtifactConfigPtrOutput() CanaryArtifactConfigPtrOutput

func (CanaryArtifactConfigOutput) ToCanaryArtifactConfigPtrOutputWithContext

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

type CanaryArtifactConfigPtrInput

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

type CanaryArtifactConfigPtrOutput

type CanaryArtifactConfigPtrOutput struct{ *pulumi.OutputState }

func (CanaryArtifactConfigPtrOutput) Elem

func (CanaryArtifactConfigPtrOutput) ElementType

func (CanaryArtifactConfigPtrOutput) S3Encryption

Configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See S3 Encryption.

func (CanaryArtifactConfigPtrOutput) ToCanaryArtifactConfigPtrOutput

func (o CanaryArtifactConfigPtrOutput) ToCanaryArtifactConfigPtrOutput() CanaryArtifactConfigPtrOutput

func (CanaryArtifactConfigPtrOutput) ToCanaryArtifactConfigPtrOutputWithContext

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

type CanaryArtifactConfigS3Encryption

type CanaryArtifactConfigS3Encryption struct {
	// The encryption method to use for artifacts created by this canary. Valid values are: `SSE_S3` and `SSE_KMS`.
	EncryptionMode *string `pulumi:"encryptionMode"`
	// The ARN of the customer-managed KMS key to use, if you specify `SSE_KMS` for `encryptionMode`.
	KmsKeyArn *string `pulumi:"kmsKeyArn"`
}

type CanaryArtifactConfigS3EncryptionArgs

type CanaryArtifactConfigS3EncryptionArgs struct {
	// The encryption method to use for artifacts created by this canary. Valid values are: `SSE_S3` and `SSE_KMS`.
	EncryptionMode pulumi.StringPtrInput `pulumi:"encryptionMode"`
	// The ARN of the customer-managed KMS key to use, if you specify `SSE_KMS` for `encryptionMode`.
	KmsKeyArn pulumi.StringPtrInput `pulumi:"kmsKeyArn"`
}

func (CanaryArtifactConfigS3EncryptionArgs) ElementType

func (CanaryArtifactConfigS3EncryptionArgs) ToCanaryArtifactConfigS3EncryptionOutput

func (i CanaryArtifactConfigS3EncryptionArgs) ToCanaryArtifactConfigS3EncryptionOutput() CanaryArtifactConfigS3EncryptionOutput

func (CanaryArtifactConfigS3EncryptionArgs) ToCanaryArtifactConfigS3EncryptionOutputWithContext

func (i CanaryArtifactConfigS3EncryptionArgs) ToCanaryArtifactConfigS3EncryptionOutputWithContext(ctx context.Context) CanaryArtifactConfigS3EncryptionOutput

func (CanaryArtifactConfigS3EncryptionArgs) ToCanaryArtifactConfigS3EncryptionPtrOutput

func (i CanaryArtifactConfigS3EncryptionArgs) ToCanaryArtifactConfigS3EncryptionPtrOutput() CanaryArtifactConfigS3EncryptionPtrOutput

func (CanaryArtifactConfigS3EncryptionArgs) ToCanaryArtifactConfigS3EncryptionPtrOutputWithContext

func (i CanaryArtifactConfigS3EncryptionArgs) ToCanaryArtifactConfigS3EncryptionPtrOutputWithContext(ctx context.Context) CanaryArtifactConfigS3EncryptionPtrOutput

type CanaryArtifactConfigS3EncryptionInput

type CanaryArtifactConfigS3EncryptionInput interface {
	pulumi.Input

	ToCanaryArtifactConfigS3EncryptionOutput() CanaryArtifactConfigS3EncryptionOutput
	ToCanaryArtifactConfigS3EncryptionOutputWithContext(context.Context) CanaryArtifactConfigS3EncryptionOutput
}

CanaryArtifactConfigS3EncryptionInput is an input type that accepts CanaryArtifactConfigS3EncryptionArgs and CanaryArtifactConfigS3EncryptionOutput values. You can construct a concrete instance of `CanaryArtifactConfigS3EncryptionInput` via:

CanaryArtifactConfigS3EncryptionArgs{...}

type CanaryArtifactConfigS3EncryptionOutput

type CanaryArtifactConfigS3EncryptionOutput struct{ *pulumi.OutputState }

func (CanaryArtifactConfigS3EncryptionOutput) ElementType

func (CanaryArtifactConfigS3EncryptionOutput) EncryptionMode

The encryption method to use for artifacts created by this canary. Valid values are: `SSE_S3` and `SSE_KMS`.

func (CanaryArtifactConfigS3EncryptionOutput) KmsKeyArn

The ARN of the customer-managed KMS key to use, if you specify `SSE_KMS` for `encryptionMode`.

func (CanaryArtifactConfigS3EncryptionOutput) ToCanaryArtifactConfigS3EncryptionOutput

func (o CanaryArtifactConfigS3EncryptionOutput) ToCanaryArtifactConfigS3EncryptionOutput() CanaryArtifactConfigS3EncryptionOutput

func (CanaryArtifactConfigS3EncryptionOutput) ToCanaryArtifactConfigS3EncryptionOutputWithContext

func (o CanaryArtifactConfigS3EncryptionOutput) ToCanaryArtifactConfigS3EncryptionOutputWithContext(ctx context.Context) CanaryArtifactConfigS3EncryptionOutput

func (CanaryArtifactConfigS3EncryptionOutput) ToCanaryArtifactConfigS3EncryptionPtrOutput

func (o CanaryArtifactConfigS3EncryptionOutput) ToCanaryArtifactConfigS3EncryptionPtrOutput() CanaryArtifactConfigS3EncryptionPtrOutput

func (CanaryArtifactConfigS3EncryptionOutput) ToCanaryArtifactConfigS3EncryptionPtrOutputWithContext

func (o CanaryArtifactConfigS3EncryptionOutput) ToCanaryArtifactConfigS3EncryptionPtrOutputWithContext(ctx context.Context) CanaryArtifactConfigS3EncryptionPtrOutput

type CanaryArtifactConfigS3EncryptionPtrInput

type CanaryArtifactConfigS3EncryptionPtrInput interface {
	pulumi.Input

	ToCanaryArtifactConfigS3EncryptionPtrOutput() CanaryArtifactConfigS3EncryptionPtrOutput
	ToCanaryArtifactConfigS3EncryptionPtrOutputWithContext(context.Context) CanaryArtifactConfigS3EncryptionPtrOutput
}

CanaryArtifactConfigS3EncryptionPtrInput is an input type that accepts CanaryArtifactConfigS3EncryptionArgs, CanaryArtifactConfigS3EncryptionPtr and CanaryArtifactConfigS3EncryptionPtrOutput values. You can construct a concrete instance of `CanaryArtifactConfigS3EncryptionPtrInput` via:

        CanaryArtifactConfigS3EncryptionArgs{...}

or:

        nil

type CanaryArtifactConfigS3EncryptionPtrOutput

type CanaryArtifactConfigS3EncryptionPtrOutput struct{ *pulumi.OutputState }

func (CanaryArtifactConfigS3EncryptionPtrOutput) Elem

func (CanaryArtifactConfigS3EncryptionPtrOutput) ElementType

func (CanaryArtifactConfigS3EncryptionPtrOutput) EncryptionMode

The encryption method to use for artifacts created by this canary. Valid values are: `SSE_S3` and `SSE_KMS`.

func (CanaryArtifactConfigS3EncryptionPtrOutput) KmsKeyArn

The ARN of the customer-managed KMS key to use, if you specify `SSE_KMS` for `encryptionMode`.

func (CanaryArtifactConfigS3EncryptionPtrOutput) ToCanaryArtifactConfigS3EncryptionPtrOutput

func (o CanaryArtifactConfigS3EncryptionPtrOutput) ToCanaryArtifactConfigS3EncryptionPtrOutput() CanaryArtifactConfigS3EncryptionPtrOutput

func (CanaryArtifactConfigS3EncryptionPtrOutput) ToCanaryArtifactConfigS3EncryptionPtrOutputWithContext

func (o CanaryArtifactConfigS3EncryptionPtrOutput) ToCanaryArtifactConfigS3EncryptionPtrOutputWithContext(ctx context.Context) CanaryArtifactConfigS3EncryptionPtrOutput

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 (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) Arn

Amazon Resource Name (ARN) of the Canary.

func (CanaryOutput) ArtifactConfig

func (o CanaryOutput) ArtifactConfig() CanaryArtifactConfigPtrOutput

configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. See Artifact Config.

func (CanaryOutput) ArtifactS3Location

func (o CanaryOutput) ArtifactS3Location() pulumi.StringOutput

Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

func (CanaryOutput) DeleteLambda

func (o CanaryOutput) DeleteLambda() pulumi.BoolPtrOutput

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`.

func (CanaryOutput) ElementType

func (CanaryOutput) ElementType() reflect.Type

func (CanaryOutput) EngineArn

func (o CanaryOutput) EngineArn() pulumi.StringOutput

ARN of the Lambda function that is used as your canary's engine.

func (CanaryOutput) ExecutionRoleArn

func (o CanaryOutput) ExecutionRoleArn() pulumi.StringOutput

ARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role.

func (CanaryOutput) FailureRetentionPeriod

func (o CanaryOutput) FailureRetentionPeriod() pulumi.IntPtrOutput

Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

func (CanaryOutput) Handler

func (o CanaryOutput) Handler() pulumi.StringOutput

Entry point to use for the source code when running the canary. This value must end with the string `.handler` .

func (CanaryOutput) Name

func (o CanaryOutput) Name() pulumi.StringOutput

Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore.

func (CanaryOutput) RunConfig

func (o CanaryOutput) RunConfig() CanaryRunConfigOutput

Configuration block for individual canary runs. Detailed below.

func (CanaryOutput) RuntimeVersion

func (o CanaryOutput) RuntimeVersion() pulumi.StringOutput

Runtime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`.

func (CanaryOutput) S3Bucket

func (o CanaryOutput) S3Bucket() pulumi.StringPtrOutput

Full bucket name which is used if your canary script is located in S3. The bucket must already exist. **Conflicts with `zipFile`.**

func (CanaryOutput) S3Key

S3 key of your script. **Conflicts with `zipFile`.**

func (CanaryOutput) S3Version

func (o CanaryOutput) S3Version() pulumi.StringPtrOutput

S3 version ID of your script. **Conflicts with `zipFile`.**

func (CanaryOutput) Schedule

func (o CanaryOutput) Schedule() CanaryScheduleOutput

Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below.

The following arguments are optional:

func (CanaryOutput) SourceLocationArn

func (o CanaryOutput) SourceLocationArn() pulumi.StringOutput

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

func (CanaryOutput) StartCanary

func (o CanaryOutput) StartCanary() pulumi.BoolPtrOutput

Whether to run or stop the canary.

func (CanaryOutput) Status

func (o CanaryOutput) Status() pulumi.StringOutput

Canary status.

func (CanaryOutput) SuccessRetentionPeriod

func (o CanaryOutput) SuccessRetentionPeriod() pulumi.IntPtrOutput

Number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

func (CanaryOutput) Tags

Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

func (CanaryOutput) TagsAll deprecated

func (o CanaryOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

Deprecated: Please use `tags` instead.

func (CanaryOutput) Timelines

Structure that contains information about when the canary was created, modified, and most recently run. see Timeline.

func (CanaryOutput) ToCanaryOutput

func (o CanaryOutput) ToCanaryOutput() CanaryOutput

func (CanaryOutput) ToCanaryOutputWithContext

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

func (CanaryOutput) VpcConfig

func (o CanaryOutput) VpcConfig() CanaryVpcConfigPtrOutput

Configuration block. Detailed below.

func (CanaryOutput) ZipFile

func (o CanaryOutput) ZipFile() pulumi.StringPtrOutput

ZIP file that contains the script, if you input your canary script directly into the canary instead of referring to an S3 location. It can be up to 225KB. **Conflicts with `s3Bucket`, `s3Key`, and `s3Version`.**

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"`
	// Map of environment variables that are accessible from the canary during execution. Please see [AWS Docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) for variables reserved for Lambda.
	EnvironmentVariables map[string]string `pulumi:"environmentVariables"`
	// 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"`
	// Map of environment variables that are accessible from the canary during execution. Please see [AWS Docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) for variables reserved for Lambda.
	EnvironmentVariables pulumi.StringMapInput `pulumi:"environmentVariables"`
	// 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) EnvironmentVariables

func (o CanaryRunConfigOutput) EnvironmentVariables() pulumi.StringMapOutput

Map of environment variables that are accessible from the canary during execution. Please see [AWS Docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) for variables reserved for Lambda.

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

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 (CanaryRunConfigPtrOutput) ElementType

func (CanaryRunConfigPtrOutput) ElementType() reflect.Type

func (CanaryRunConfigPtrOutput) EnvironmentVariables

func (o CanaryRunConfigPtrOutput) EnvironmentVariables() pulumi.StringMapOutput

Map of environment variables that are accessible from the canary during execution. Please see [AWS Docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) for variables reserved for Lambda.

func (CanaryRunConfigPtrOutput) MemoryInMb

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 or cron expression that defines how often the canary is to run. For rate expression, the syntax is `rate(number unit)`. _unit_ can be `minute`, `minutes`, or `hour`. For cron expression, the syntax is `cron(expression)`. For more 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 {
	// 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 or cron expression that defines how often the canary is to run. For rate expression, the syntax is `rate(number unit)`. _unit_ can be `minute`, `minutes`, or `hour`. For cron expression, the syntax is `cron(expression)`. For more 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

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 or cron expression that defines how often the canary is to run. For rate expression, the syntax is `rate(number unit)`. _unit_ can be `minute`, `minutes`, or `hour`. For cron expression, the syntax is `cron(expression)`. For more 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

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

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 (CanarySchedulePtrOutput) ElementType

func (CanarySchedulePtrOutput) ElementType() reflect.Type

func (CanarySchedulePtrOutput) Expression

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

func (CanaryState) ElementType

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 (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

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

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

func (CanaryTimelineOutput) LastStopped

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

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

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

type CanaryVpcConfigPtrOutput

type CanaryVpcConfigPtrOutput struct{ *pulumi.OutputState }

func (CanaryVpcConfigPtrOutput) Elem

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

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

ID of the VPC where this canary is to run.

type Group

type Group struct {
	pulumi.CustomResourceState

	// ARN of the Group.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// ID of the Group.
	GroupId pulumi.StringOutput `pulumi:"groupId"`
	// Name of the group.
	//
	// The following arguments are optional:
	Name pulumi.StringOutput `pulumi:"name"`
	// Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

Provides a Synthetics Group resource.

## Example Usage

### Basic Usage

<!--Start PulumiCodeChooser --> ```go package main

import (

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

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synthetics.NewGroup(ctx, "example", &synthetics.GroupArgs{
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Using `pulumi import`, import CloudWatch Synthetics Group using the `name`. For example:

```sh $ pulumi import aws:synthetics/group:Group example example ```

func GetGroup

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

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

func (*Group) ElementType() reflect.Type

func (*Group) ToGroupOutput

func (i *Group) ToGroupOutput() GroupOutput

func (*Group) ToGroupOutputWithContext

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

type GroupArgs

type GroupArgs struct {
	// Name of the group.
	//
	// The following arguments are optional:
	Name pulumi.StringPtrInput
	// Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Group resource.

func (GroupArgs) ElementType

func (GroupArgs) ElementType() reflect.Type

type GroupArray

type GroupArray []GroupInput

func (GroupArray) ElementType

func (GroupArray) ElementType() reflect.Type

func (GroupArray) ToGroupArrayOutput

func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput

func (GroupArray) ToGroupArrayOutputWithContext

func (i GroupArray) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupArrayInput

type GroupArrayInput interface {
	pulumi.Input

	ToGroupArrayOutput() GroupArrayOutput
	ToGroupArrayOutputWithContext(context.Context) GroupArrayOutput
}

GroupArrayInput is an input type that accepts GroupArray and GroupArrayOutput values. You can construct a concrete instance of `GroupArrayInput` via:

GroupArray{ GroupArgs{...} }

type GroupArrayOutput

type GroupArrayOutput struct{ *pulumi.OutputState }

func (GroupArrayOutput) ElementType

func (GroupArrayOutput) ElementType() reflect.Type

func (GroupArrayOutput) Index

func (GroupArrayOutput) ToGroupArrayOutput

func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput

func (GroupArrayOutput) ToGroupArrayOutputWithContext

func (o GroupArrayOutput) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupAssociation

type GroupAssociation struct {
	pulumi.CustomResourceState

	// ARN of the canary.
	CanaryArn pulumi.StringOutput `pulumi:"canaryArn"`
	GroupArn  pulumi.StringOutput `pulumi:"groupArn"`
	// ID of the Group.
	GroupId pulumi.StringOutput `pulumi:"groupId"`
	// Name of the group that the canary will be associated with.
	GroupName pulumi.StringOutput `pulumi:"groupName"`
}

Provides a Synthetics Group Association resource.

## Example Usage

### Basic Usage

<!--Start PulumiCodeChooser --> ```go package main

import (

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

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synthetics.NewGroupAssociation(ctx, "example", &synthetics.GroupAssociationArgs{
			GroupName: pulumi.Any(exampleAwsSyntheticsGroup.Name),
			CanaryArn: pulumi.Any(exampleAwsSyntheticsCanary.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Using `pulumi import`, import CloudWatch Synthetics Group Association using the `canary_arn,group_name`. For example:

```sh $ pulumi import aws:synthetics/groupAssociation:GroupAssociation example arn:aws:synthetics:us-west-2:123456789012:canary:tf-acc-test-abcd1234,examplename ```

func GetGroupAssociation

func GetGroupAssociation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GroupAssociationState, opts ...pulumi.ResourceOption) (*GroupAssociation, error)

GetGroupAssociation gets an existing GroupAssociation 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 NewGroupAssociation

func NewGroupAssociation(ctx *pulumi.Context,
	name string, args *GroupAssociationArgs, opts ...pulumi.ResourceOption) (*GroupAssociation, error)

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

func (*GroupAssociation) ElementType

func (*GroupAssociation) ElementType() reflect.Type

func (*GroupAssociation) ToGroupAssociationOutput

func (i *GroupAssociation) ToGroupAssociationOutput() GroupAssociationOutput

func (*GroupAssociation) ToGroupAssociationOutputWithContext

func (i *GroupAssociation) ToGroupAssociationOutputWithContext(ctx context.Context) GroupAssociationOutput

type GroupAssociationArgs

type GroupAssociationArgs struct {
	// ARN of the canary.
	CanaryArn pulumi.StringInput
	// Name of the group that the canary will be associated with.
	GroupName pulumi.StringInput
}

The set of arguments for constructing a GroupAssociation resource.

func (GroupAssociationArgs) ElementType

func (GroupAssociationArgs) ElementType() reflect.Type

type GroupAssociationArray

type GroupAssociationArray []GroupAssociationInput

func (GroupAssociationArray) ElementType

func (GroupAssociationArray) ElementType() reflect.Type

func (GroupAssociationArray) ToGroupAssociationArrayOutput

func (i GroupAssociationArray) ToGroupAssociationArrayOutput() GroupAssociationArrayOutput

func (GroupAssociationArray) ToGroupAssociationArrayOutputWithContext

func (i GroupAssociationArray) ToGroupAssociationArrayOutputWithContext(ctx context.Context) GroupAssociationArrayOutput

type GroupAssociationArrayInput

type GroupAssociationArrayInput interface {
	pulumi.Input

	ToGroupAssociationArrayOutput() GroupAssociationArrayOutput
	ToGroupAssociationArrayOutputWithContext(context.Context) GroupAssociationArrayOutput
}

GroupAssociationArrayInput is an input type that accepts GroupAssociationArray and GroupAssociationArrayOutput values. You can construct a concrete instance of `GroupAssociationArrayInput` via:

GroupAssociationArray{ GroupAssociationArgs{...} }

type GroupAssociationArrayOutput

type GroupAssociationArrayOutput struct{ *pulumi.OutputState }

func (GroupAssociationArrayOutput) ElementType

func (GroupAssociationArrayOutput) Index

func (GroupAssociationArrayOutput) ToGroupAssociationArrayOutput

func (o GroupAssociationArrayOutput) ToGroupAssociationArrayOutput() GroupAssociationArrayOutput

func (GroupAssociationArrayOutput) ToGroupAssociationArrayOutputWithContext

func (o GroupAssociationArrayOutput) ToGroupAssociationArrayOutputWithContext(ctx context.Context) GroupAssociationArrayOutput

type GroupAssociationInput

type GroupAssociationInput interface {
	pulumi.Input

	ToGroupAssociationOutput() GroupAssociationOutput
	ToGroupAssociationOutputWithContext(ctx context.Context) GroupAssociationOutput
}

type GroupAssociationMap

type GroupAssociationMap map[string]GroupAssociationInput

func (GroupAssociationMap) ElementType

func (GroupAssociationMap) ElementType() reflect.Type

func (GroupAssociationMap) ToGroupAssociationMapOutput

func (i GroupAssociationMap) ToGroupAssociationMapOutput() GroupAssociationMapOutput

func (GroupAssociationMap) ToGroupAssociationMapOutputWithContext

func (i GroupAssociationMap) ToGroupAssociationMapOutputWithContext(ctx context.Context) GroupAssociationMapOutput

type GroupAssociationMapInput

type GroupAssociationMapInput interface {
	pulumi.Input

	ToGroupAssociationMapOutput() GroupAssociationMapOutput
	ToGroupAssociationMapOutputWithContext(context.Context) GroupAssociationMapOutput
}

GroupAssociationMapInput is an input type that accepts GroupAssociationMap and GroupAssociationMapOutput values. You can construct a concrete instance of `GroupAssociationMapInput` via:

GroupAssociationMap{ "key": GroupAssociationArgs{...} }

type GroupAssociationMapOutput

type GroupAssociationMapOutput struct{ *pulumi.OutputState }

func (GroupAssociationMapOutput) ElementType

func (GroupAssociationMapOutput) ElementType() reflect.Type

func (GroupAssociationMapOutput) MapIndex

func (GroupAssociationMapOutput) ToGroupAssociationMapOutput

func (o GroupAssociationMapOutput) ToGroupAssociationMapOutput() GroupAssociationMapOutput

func (GroupAssociationMapOutput) ToGroupAssociationMapOutputWithContext

func (o GroupAssociationMapOutput) ToGroupAssociationMapOutputWithContext(ctx context.Context) GroupAssociationMapOutput

type GroupAssociationOutput

type GroupAssociationOutput struct{ *pulumi.OutputState }

func (GroupAssociationOutput) CanaryArn

ARN of the canary.

func (GroupAssociationOutput) ElementType

func (GroupAssociationOutput) ElementType() reflect.Type

func (GroupAssociationOutput) GroupArn

func (GroupAssociationOutput) GroupId

ID of the Group.

func (GroupAssociationOutput) GroupName

Name of the group that the canary will be associated with.

func (GroupAssociationOutput) ToGroupAssociationOutput

func (o GroupAssociationOutput) ToGroupAssociationOutput() GroupAssociationOutput

func (GroupAssociationOutput) ToGroupAssociationOutputWithContext

func (o GroupAssociationOutput) ToGroupAssociationOutputWithContext(ctx context.Context) GroupAssociationOutput

type GroupAssociationState

type GroupAssociationState struct {
	// ARN of the canary.
	CanaryArn pulumi.StringPtrInput
	GroupArn  pulumi.StringPtrInput
	// ID of the Group.
	GroupId pulumi.StringPtrInput
	// Name of the group that the canary will be associated with.
	GroupName pulumi.StringPtrInput
}

func (GroupAssociationState) ElementType

func (GroupAssociationState) ElementType() reflect.Type

type GroupInput

type GroupInput interface {
	pulumi.Input

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

type GroupMap

type GroupMap map[string]GroupInput

func (GroupMap) ElementType

func (GroupMap) ElementType() reflect.Type

func (GroupMap) ToGroupMapOutput

func (i GroupMap) ToGroupMapOutput() GroupMapOutput

func (GroupMap) ToGroupMapOutputWithContext

func (i GroupMap) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupMapInput

type GroupMapInput interface {
	pulumi.Input

	ToGroupMapOutput() GroupMapOutput
	ToGroupMapOutputWithContext(context.Context) GroupMapOutput
}

GroupMapInput is an input type that accepts GroupMap and GroupMapOutput values. You can construct a concrete instance of `GroupMapInput` via:

GroupMap{ "key": GroupArgs{...} }

type GroupMapOutput

type GroupMapOutput struct{ *pulumi.OutputState }

func (GroupMapOutput) ElementType

func (GroupMapOutput) ElementType() reflect.Type

func (GroupMapOutput) MapIndex

func (GroupMapOutput) ToGroupMapOutput

func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput

func (GroupMapOutput) ToGroupMapOutputWithContext

func (o GroupMapOutput) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupOutput

type GroupOutput struct{ *pulumi.OutputState }

func (GroupOutput) Arn

ARN of the Group.

func (GroupOutput) ElementType

func (GroupOutput) ElementType() reflect.Type

func (GroupOutput) GroupId

func (o GroupOutput) GroupId() pulumi.StringOutput

ID of the Group.

func (GroupOutput) Name

func (o GroupOutput) Name() pulumi.StringOutput

Name of the group.

The following arguments are optional:

func (GroupOutput) Tags

Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

func (GroupOutput) TagsAll deprecated

func (o GroupOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

Deprecated: Please use `tags` instead.

func (GroupOutput) ToGroupOutput

func (o GroupOutput) ToGroupOutput() GroupOutput

func (GroupOutput) ToGroupOutputWithContext

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

type GroupState

type GroupState struct {
	// ARN of the Group.
	Arn pulumi.StringPtrInput
	// ID of the Group.
	GroupId pulumi.StringPtrInput
	// Name of the group.
	//
	// The following arguments are optional:
	Name pulumi.StringPtrInput
	// Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapInput
}

func (GroupState) ElementType

func (GroupState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL