aws_backup_plan

package
v5.45.0 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 AdvancedBackupSetting

type AdvancedBackupSetting struct {
	// BackupOptions: map of string, required
	BackupOptions terra.MapValue[terra.StringValue] `hcl:"backup_options,attr" validate:"required"`
	// ResourceType: string, required
	ResourceType terra.StringValue `hcl:"resource_type,attr" validate:"required"`
}

type AdvancedBackupSettingAttributes

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

func (AdvancedBackupSettingAttributes) BackupOptions

func (AdvancedBackupSettingAttributes) InternalRef

func (AdvancedBackupSettingAttributes) InternalTokens

func (abs AdvancedBackupSettingAttributes) InternalTokens() (hclwrite.Tokens, error)

func (AdvancedBackupSettingAttributes) InternalWithRef

func (AdvancedBackupSettingAttributes) ResourceType

type AdvancedBackupSettingState

type AdvancedBackupSettingState struct {
	BackupOptions map[string]string `json:"backup_options"`
	ResourceType  string            `json:"resource_type"`
}

type Args

type Args struct {
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// 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"`
	// AdvancedBackupSetting: min=0
	AdvancedBackupSetting []AdvancedBackupSetting `hcl:"advanced_backup_setting,block" validate:"min=0"`
	// Rule: min=1
	Rule []Rule `hcl:"rule,block" validate:"min=1"`
}

Args contains the configurations for aws_backup_plan.

type DataArgs

type DataArgs struct {
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// PlanId: string, required
	PlanId terra.StringValue `hcl:"plan_id,attr" validate:"required"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
}

DataArgs contains the configurations for aws_backup_plan.

type DataSource

type DataSource struct {
	Name string
	Args DataArgs
}

DataSource represents the Terraform data resource aws_backup_plan.

func Data

func Data(name string, args DataArgs) *DataSource

Data creates a new instance of DataSource.

func (*DataSource) Attributes

func (abp *DataSource) Attributes() dataAwsBackupPlanAttributes

Attributes returns the attributes for DataSource.

func (*DataSource) Configuration

func (abp *DataSource) Configuration() interface{}

Configuration returns the configuration (args) for DataSource.

func (*DataSource) DataSource

func (abp *DataSource) DataSource() string

DataSource returns the Terraform object type for DataSource.

func (*DataSource) LocalName

func (abp *DataSource) LocalName() string

LocalName returns the local name for DataSource.

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

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (abp *Resource) Attributes() awsBackupPlanAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (abp *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (abp *Resource) State() (*awsBackupPlanState, bool)

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

func (*Resource) StateMust

func (abp *Resource) StateMust() *awsBackupPlanState

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

func (*Resource) Type

func (abp *Resource) Type() string

Type returns the Terraform object type for Resource.

type Rule

type Rule struct {
	// CompletionWindow: number, optional
	CompletionWindow terra.NumberValue `hcl:"completion_window,attr"`
	// EnableContinuousBackup: bool, optional
	EnableContinuousBackup terra.BoolValue `hcl:"enable_continuous_backup,attr"`
	// RecoveryPointTags: map of string, optional
	RecoveryPointTags terra.MapValue[terra.StringValue] `hcl:"recovery_point_tags,attr"`
	// RuleName: string, required
	RuleName terra.StringValue `hcl:"rule_name,attr" validate:"required"`
	// Schedule: string, optional
	Schedule terra.StringValue `hcl:"schedule,attr"`
	// StartWindow: number, optional
	StartWindow terra.NumberValue `hcl:"start_window,attr"`
	// TargetVaultName: string, required
	TargetVaultName terra.StringValue `hcl:"target_vault_name,attr" validate:"required"`
	// RuleCopyAction: min=0
	CopyAction []RuleCopyAction `hcl:"copy_action,block" validate:"min=0"`
	// RuleLifecycle: optional
	Lifecycle *RuleLifecycle `hcl:"lifecycle,block"`
}

type RuleAttributes

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

func (RuleAttributes) CompletionWindow

func (r RuleAttributes) CompletionWindow() terra.NumberValue

func (RuleAttributes) CopyAction

func (RuleAttributes) EnableContinuousBackup

func (r RuleAttributes) EnableContinuousBackup() terra.BoolValue

func (RuleAttributes) InternalRef

func (r RuleAttributes) InternalRef() (terra.Reference, error)

func (RuleAttributes) InternalTokens

func (r RuleAttributes) InternalTokens() (hclwrite.Tokens, error)

func (RuleAttributes) InternalWithRef

func (r RuleAttributes) InternalWithRef(ref terra.Reference) RuleAttributes

func (RuleAttributes) Lifecycle

func (RuleAttributes) RecoveryPointTags

func (r RuleAttributes) RecoveryPointTags() terra.MapValue[terra.StringValue]

func (RuleAttributes) RuleName

func (r RuleAttributes) RuleName() terra.StringValue

func (RuleAttributes) Schedule

func (r RuleAttributes) Schedule() terra.StringValue

func (RuleAttributes) StartWindow

func (r RuleAttributes) StartWindow() terra.NumberValue

func (RuleAttributes) TargetVaultName

func (r RuleAttributes) TargetVaultName() terra.StringValue

type RuleCopyAction

type RuleCopyAction struct {
	// DestinationVaultArn: string, required
	DestinationVaultArn terra.StringValue `hcl:"destination_vault_arn,attr" validate:"required"`
	// RuleCopyActionLifecycle: optional
	Lifecycle *RuleCopyActionLifecycle `hcl:"lifecycle,block"`
}

type RuleCopyActionAttributes

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

func (RuleCopyActionAttributes) DestinationVaultArn

func (ca RuleCopyActionAttributes) DestinationVaultArn() terra.StringValue

func (RuleCopyActionAttributes) InternalRef

func (ca RuleCopyActionAttributes) InternalRef() (terra.Reference, error)

func (RuleCopyActionAttributes) InternalTokens

func (ca RuleCopyActionAttributes) InternalTokens() (hclwrite.Tokens, error)

func (RuleCopyActionAttributes) InternalWithRef

func (RuleCopyActionAttributes) Lifecycle

type RuleCopyActionLifecycle

type RuleCopyActionLifecycle struct {
	// ColdStorageAfter: number, optional
	ColdStorageAfter terra.NumberValue `hcl:"cold_storage_after,attr"`
	// DeleteAfter: number, optional
	DeleteAfter terra.NumberValue `hcl:"delete_after,attr"`
}

type RuleCopyActionLifecycleAttributes

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

func (RuleCopyActionLifecycleAttributes) ColdStorageAfter

func (RuleCopyActionLifecycleAttributes) DeleteAfter

func (RuleCopyActionLifecycleAttributes) InternalRef

func (RuleCopyActionLifecycleAttributes) InternalTokens

func (RuleCopyActionLifecycleAttributes) InternalWithRef

type RuleCopyActionLifecycleState

type RuleCopyActionLifecycleState struct {
	ColdStorageAfter float64 `json:"cold_storage_after"`
	DeleteAfter      float64 `json:"delete_after"`
}

type RuleCopyActionState

type RuleCopyActionState struct {
	DestinationVaultArn string                         `json:"destination_vault_arn"`
	Lifecycle           []RuleCopyActionLifecycleState `json:"lifecycle"`
}

type RuleLifecycle

type RuleLifecycle struct {
	// ColdStorageAfter: number, optional
	ColdStorageAfter terra.NumberValue `hcl:"cold_storage_after,attr"`
	// DeleteAfter: number, optional
	DeleteAfter terra.NumberValue `hcl:"delete_after,attr"`
}

type RuleLifecycleAttributes

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

func (RuleLifecycleAttributes) ColdStorageAfter

func (l RuleLifecycleAttributes) ColdStorageAfter() terra.NumberValue

func (RuleLifecycleAttributes) DeleteAfter

func (l RuleLifecycleAttributes) DeleteAfter() terra.NumberValue

func (RuleLifecycleAttributes) InternalRef

func (l RuleLifecycleAttributes) InternalRef() (terra.Reference, error)

func (RuleLifecycleAttributes) InternalTokens

func (l RuleLifecycleAttributes) InternalTokens() (hclwrite.Tokens, error)

func (RuleLifecycleAttributes) InternalWithRef

type RuleLifecycleState

type RuleLifecycleState struct {
	ColdStorageAfter float64 `json:"cold_storage_after"`
	DeleteAfter      float64 `json:"delete_after"`
}

type RuleState

type RuleState struct {
	CompletionWindow       float64               `json:"completion_window"`
	EnableContinuousBackup bool                  `json:"enable_continuous_backup"`
	RecoveryPointTags      map[string]string     `json:"recovery_point_tags"`
	RuleName               string                `json:"rule_name"`
	Schedule               string                `json:"schedule"`
	StartWindow            float64               `json:"start_window"`
	TargetVaultName        string                `json:"target_vault_name"`
	CopyAction             []RuleCopyActionState `json:"copy_action"`
	Lifecycle              []RuleLifecycleState  `json:"lifecycle"`
}

Jump to

Keyboard shortcuts

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