aws_synthetics_canary

package
v0.0.0-...-4deecce Latest Latest
Warning

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

Go to latest
Published: Apr 16, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Args

type Args struct {
	// ArtifactS3Location: string, required
	ArtifactS3Location terra.StringValue `hcl:"artifact_s3_location,attr" validate:"required"`
	// DeleteLambda: bool, optional
	DeleteLambda terra.BoolValue `hcl:"delete_lambda,attr"`
	// ExecutionRoleArn: string, required
	ExecutionRoleArn terra.StringValue `hcl:"execution_role_arn,attr" validate:"required"`
	// FailureRetentionPeriod: number, optional
	FailureRetentionPeriod terra.NumberValue `hcl:"failure_retention_period,attr"`
	// Handler: string, required
	Handler terra.StringValue `hcl:"handler,attr" validate:"required"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// RuntimeVersion: string, required
	RuntimeVersion terra.StringValue `hcl:"runtime_version,attr" validate:"required"`
	// S3Bucket: string, optional
	S3Bucket terra.StringValue `hcl:"s3_bucket,attr"`
	// S3Key: string, optional
	S3Key terra.StringValue `hcl:"s3_key,attr"`
	// S3Version: string, optional
	S3Version terra.StringValue `hcl:"s3_version,attr"`
	// StartCanary: bool, optional
	StartCanary terra.BoolValue `hcl:"start_canary,attr"`
	// SuccessRetentionPeriod: number, optional
	SuccessRetentionPeriod terra.NumberValue `hcl:"success_retention_period,attr"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
	// TagsAll: map of string, optional
	TagsAll terra.MapValue[terra.StringValue] `hcl:"tags_all,attr"`
	// ZipFile: string, optional
	ZipFile terra.StringValue `hcl:"zip_file,attr"`
	// ArtifactConfig: optional
	ArtifactConfig *ArtifactConfig `hcl:"artifact_config,block"`
	// RunConfig: optional
	RunConfig *RunConfig `hcl:"run_config,block"`
	// Schedule: required
	Schedule *Schedule `hcl:"schedule,block" validate:"required"`
	// VpcConfig: optional
	VpcConfig *VpcConfig `hcl:"vpc_config,block"`
}

Args contains the configurations for aws_synthetics_canary.

type ArtifactConfig

type ArtifactConfig struct {
	// ArtifactConfigS3Encryption: optional
	S3Encryption *ArtifactConfigS3Encryption `hcl:"s3_encryption,block"`
}

type ArtifactConfigAttributes

type ArtifactConfigAttributes struct {
	// contains filtered or unexported fields
}

func (ArtifactConfigAttributes) InternalRef

func (ac ArtifactConfigAttributes) InternalRef() (terra.Reference, error)

func (ArtifactConfigAttributes) InternalTokens

func (ac ArtifactConfigAttributes) InternalTokens() (hclwrite.Tokens, error)

func (ArtifactConfigAttributes) InternalWithRef

func (ArtifactConfigAttributes) S3Encryption

type ArtifactConfigS3Encryption

type ArtifactConfigS3Encryption struct {
	// EncryptionMode: string, optional
	EncryptionMode terra.StringValue `hcl:"encryption_mode,attr"`
	// KmsKeyArn: string, optional
	KmsKeyArn terra.StringValue `hcl:"kms_key_arn,attr"`
}

type ArtifactConfigS3EncryptionAttributes

type ArtifactConfigS3EncryptionAttributes struct {
	// contains filtered or unexported fields
}

func (ArtifactConfigS3EncryptionAttributes) EncryptionMode

func (ArtifactConfigS3EncryptionAttributes) InternalRef

func (ArtifactConfigS3EncryptionAttributes) InternalTokens

func (ArtifactConfigS3EncryptionAttributes) InternalWithRef

func (ArtifactConfigS3EncryptionAttributes) KmsKeyArn

type ArtifactConfigS3EncryptionState

type ArtifactConfigS3EncryptionState struct {
	EncryptionMode string `json:"encryption_mode"`
	KmsKeyArn      string `json:"kms_key_arn"`
}

type ArtifactConfigState

type ArtifactConfigState struct {
	S3Encryption []ArtifactConfigS3EncryptionState `json:"s3_encryption"`
}

type Resource

type Resource struct {
	Name string
	Args Args

	DependsOn terra.Dependencies
	Lifecycle *terra.Lifecycle
	// contains filtered or unexported fields
}

Resource represents the Terraform resource aws_synthetics_canary.

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (asc *Resource) Attributes() awsSyntheticsCanaryAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

func (asc *Resource) Configuration() interface{}

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

func (asc *Resource) DependOn() terra.Reference

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

func (asc *Resource) Dependencies() terra.Dependencies

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

func (asc *Resource) ImportState(state io.Reader) error

ImportState imports the given attribute values into Resource's state.

func (*Resource) LifecycleManagement

func (asc *Resource) LifecycleManagement() *terra.Lifecycle

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (asc *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (asc *Resource) State() (*awsSyntheticsCanaryState, bool)

State returns the state and a bool indicating if Resource has state.

func (*Resource) StateMust

func (asc *Resource) StateMust() *awsSyntheticsCanaryState

StateMust returns the state for Resource. Panics if the state is nil.

func (*Resource) Type

func (asc *Resource) Type() string

Type returns the Terraform object type for Resource.

type RunConfig

type RunConfig struct {
	// ActiveTracing: bool, optional
	ActiveTracing terra.BoolValue `hcl:"active_tracing,attr"`
	// EnvironmentVariables: map of string, optional
	EnvironmentVariables terra.MapValue[terra.StringValue] `hcl:"environment_variables,attr"`
	// MemoryInMb: number, optional
	MemoryInMb terra.NumberValue `hcl:"memory_in_mb,attr"`
	// TimeoutInSeconds: number, optional
	TimeoutInSeconds terra.NumberValue `hcl:"timeout_in_seconds,attr"`
}

type RunConfigAttributes

type RunConfigAttributes struct {
	// contains filtered or unexported fields
}

func (RunConfigAttributes) ActiveTracing

func (rc RunConfigAttributes) ActiveTracing() terra.BoolValue

func (RunConfigAttributes) EnvironmentVariables

func (rc RunConfigAttributes) EnvironmentVariables() terra.MapValue[terra.StringValue]

func (RunConfigAttributes) InternalRef

func (rc RunConfigAttributes) InternalRef() (terra.Reference, error)

func (RunConfigAttributes) InternalTokens

func (rc RunConfigAttributes) InternalTokens() (hclwrite.Tokens, error)

func (RunConfigAttributes) InternalWithRef

func (rc RunConfigAttributes) InternalWithRef(ref terra.Reference) RunConfigAttributes

func (RunConfigAttributes) MemoryInMb

func (rc RunConfigAttributes) MemoryInMb() terra.NumberValue

func (RunConfigAttributes) TimeoutInSeconds

func (rc RunConfigAttributes) TimeoutInSeconds() terra.NumberValue

type RunConfigState

type RunConfigState struct {
	ActiveTracing        bool              `json:"active_tracing"`
	EnvironmentVariables map[string]string `json:"environment_variables"`
	MemoryInMb           float64           `json:"memory_in_mb"`
	TimeoutInSeconds     float64           `json:"timeout_in_seconds"`
}

type Schedule

type Schedule struct {
	// DurationInSeconds: number, optional
	DurationInSeconds terra.NumberValue `hcl:"duration_in_seconds,attr"`
	// Expression: string, required
	Expression terra.StringValue `hcl:"expression,attr" validate:"required"`
}

type ScheduleAttributes

type ScheduleAttributes struct {
	// contains filtered or unexported fields
}

func (ScheduleAttributes) DurationInSeconds

func (s ScheduleAttributes) DurationInSeconds() terra.NumberValue

func (ScheduleAttributes) Expression

func (s ScheduleAttributes) Expression() terra.StringValue

func (ScheduleAttributes) InternalRef

func (s ScheduleAttributes) InternalRef() (terra.Reference, error)

func (ScheduleAttributes) InternalTokens

func (s ScheduleAttributes) InternalTokens() (hclwrite.Tokens, error)

func (ScheduleAttributes) InternalWithRef

func (s ScheduleAttributes) InternalWithRef(ref terra.Reference) ScheduleAttributes

type ScheduleState

type ScheduleState struct {
	DurationInSeconds float64 `json:"duration_in_seconds"`
	Expression        string  `json:"expression"`
}

type TimelineAttributes

type TimelineAttributes struct {
	// contains filtered or unexported fields
}

func (TimelineAttributes) Created

func (t TimelineAttributes) Created() terra.StringValue

func (TimelineAttributes) InternalRef

func (t TimelineAttributes) InternalRef() (terra.Reference, error)

func (TimelineAttributes) InternalTokens

func (t TimelineAttributes) InternalTokens() (hclwrite.Tokens, error)

func (TimelineAttributes) InternalWithRef

func (t TimelineAttributes) InternalWithRef(ref terra.Reference) TimelineAttributes

func (TimelineAttributes) LastModified

func (t TimelineAttributes) LastModified() terra.StringValue

func (TimelineAttributes) LastStarted

func (t TimelineAttributes) LastStarted() terra.StringValue

func (TimelineAttributes) LastStopped

func (t TimelineAttributes) LastStopped() terra.StringValue

type TimelineState

type TimelineState struct {
	Created      string `json:"created"`
	LastModified string `json:"last_modified"`
	LastStarted  string `json:"last_started"`
	LastStopped  string `json:"last_stopped"`
}

type VpcConfig

type VpcConfig struct {
	// SecurityGroupIds: set of string, optional
	SecurityGroupIds terra.SetValue[terra.StringValue] `hcl:"security_group_ids,attr"`
	// SubnetIds: set of string, optional
	SubnetIds terra.SetValue[terra.StringValue] `hcl:"subnet_ids,attr"`
}

type VpcConfigAttributes

type VpcConfigAttributes struct {
	// contains filtered or unexported fields
}

func (VpcConfigAttributes) InternalRef

func (vc VpcConfigAttributes) InternalRef() (terra.Reference, error)

func (VpcConfigAttributes) InternalTokens

func (vc VpcConfigAttributes) InternalTokens() (hclwrite.Tokens, error)

func (VpcConfigAttributes) InternalWithRef

func (vc VpcConfigAttributes) InternalWithRef(ref terra.Reference) VpcConfigAttributes

func (VpcConfigAttributes) SecurityGroupIds

func (vc VpcConfigAttributes) SecurityGroupIds() terra.SetValue[terra.StringValue]

func (VpcConfigAttributes) SubnetIds

func (VpcConfigAttributes) VpcId

type VpcConfigState

type VpcConfigState struct {
	SecurityGroupIds []string `json:"security_group_ids"`
	SubnetIds        []string `json:"subnet_ids"`
	VpcId            string   `json:"vpc_id"`
}

Jump to

Keyboard shortcuts

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