package types

import "github.com/aws/aws-sdk-go-v2/service/dlm/types"

Index

Types

type CreateRule

type CreateRule struct {
	// The time, in UTC, to start the operation. The supported format is hh:mm. The
	// operation occurs within a one-hour window following the specified time. If you
	// do not specify a time, Amazon DLM selects a time within the next 24 hours.
	Times []*string
	// The schedule, as a Cron expression. The schedule interval must be between 1 hour
	// and 1 year. For more information, see Cron expressions
	// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions)
	// in the Amazon CloudWatch User Guide.
	CronExpression *string
	// The interval unit.
	IntervalUnit IntervalUnitValues
	// The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12,
	// and 24.
	Interval *int32
}

Specifies when to create snapshots of EBS volumes. You must specify either a Cron expression or an interval, interval unit, and start time. You cannot specify both.

type CrossRegionCopyRetainRule

type CrossRegionCopyRetainRule struct {
	// The unit of time for time-based retention.
	IntervalUnit RetentionIntervalUnitValues
	// The amount of time to retain each snapshot. The maximum is 100 years. This is
	// equivalent to 1200 months, 5200 weeks, or 36500 days.
	Interval *int32
}

Specifies the retention rule for cross-Region snapshot copies.

type CrossRegionCopyRule

type CrossRegionCopyRule struct {
	// To encrypt a copy of an unencrypted snapshot if encryption by default is not
	// enabled, enable encryption using this parameter. Copies of encrypted snapshots
	// are encrypted, even if this parameter is false or if encryption by default is
	// not enabled.
	Encrypted *bool
	// The retention rule.
	RetainRule *CrossRegionCopyRetainRule
	// The target Region.
	TargetRegion *string
	// Copy all user-defined tags from the source snapshot to the copied snapshot.
	CopyTags *bool
	// The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use
	// for EBS encryption. If this parameter is not specified, your AWS managed CMK for
	// EBS is used.
	CmkArn *string
}

Specifies a rule for cross-Region snapshot copies.

type FastRestoreRule

type FastRestoreRule struct {
	// The number of snapshots to be enabled with fast snapshot restore.
	Count *int32
	// The unit of time for enabling fast snapshot restore.
	IntervalUnit RetentionIntervalUnitValues
	// The amount of time to enable fast snapshot restore. The maximum is 100 years.
	// This is equivalent to 1200 months, 5200 weeks, or 36500 days.
	Interval *int32
	// The Availability Zones in which to enable fast snapshot restore.
	AvailabilityZones []*string
}

Specifies a rule for enabling fast snapshot restore. You can enable fast snapshot restore based on either a count or a time interval.

type GettablePolicyStateValues

type GettablePolicyStateValues string
const (
	GettablePolicyStateValuesEnabled  GettablePolicyStateValues = "ENABLED"
	GettablePolicyStateValuesDisabled GettablePolicyStateValues = "DISABLED"
	GettablePolicyStateValuesError    GettablePolicyStateValues = "ERROR"
)

Enum values for GettablePolicyStateValues

type InternalServerException

type InternalServerException struct {
	Message *string

	Code *string
}

The service failed in an unexpected way.

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

func (*InternalServerException) GetCode

func (e *InternalServerException) GetCode() string

func (*InternalServerException) GetMessage

func (e *InternalServerException) GetMessage() string

func (*InternalServerException) HasCode

func (e *InternalServerException) HasCode() bool

func (*InternalServerException) HasMessage

func (e *InternalServerException) HasMessage() bool

type IntervalUnitValues

type IntervalUnitValues string
const (
	IntervalUnitValuesHours IntervalUnitValues = "HOURS"
)

Enum values for IntervalUnitValues

type InvalidRequestException

type InvalidRequestException struct {
	Message *string

	MutuallyExclusiveParameters []*string
	Code                        *string
	RequiredParameters          []*string
}

Bad request. The request is missing required parameters or has invalid parameters.

func (*InvalidRequestException) Error

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage

func (e *InvalidRequestException) ErrorMessage() string

func (*InvalidRequestException) GetCode

func (e *InvalidRequestException) GetCode() string

func (*InvalidRequestException) GetMessage

func (e *InvalidRequestException) GetMessage() string

func (*InvalidRequestException) GetMutuallyExclusiveParameters

func (e *InvalidRequestException) GetMutuallyExclusiveParameters() []*string

func (*InvalidRequestException) GetRequiredParameters

func (e *InvalidRequestException) GetRequiredParameters() []*string

func (*InvalidRequestException) HasCode

func (e *InvalidRequestException) HasCode() bool

func (*InvalidRequestException) HasMessage

func (e *InvalidRequestException) HasMessage() bool

func (*InvalidRequestException) HasMutuallyExclusiveParameters

func (e *InvalidRequestException) HasMutuallyExclusiveParameters() bool

func (*InvalidRequestException) HasRequiredParameters

func (e *InvalidRequestException) HasRequiredParameters() bool

type LifecyclePolicy

type LifecyclePolicy struct {
	// The Amazon Resource Name (ARN) of the policy.
	PolicyArn *string
	// The identifier of the lifecycle policy.
	PolicyId *string
	// The local date and time when the lifecycle policy was last modified.
	DateModified *time.Time
	// The description of the status.
	StatusMessage *string
	// The tags.
	Tags map[string]*string
	// The Amazon Resource Name (ARN) of the IAM role used to run the operations
	// specified by the lifecycle policy.
	ExecutionRoleArn *string
	// The activation state of the lifecycle policy.
	State GettablePolicyStateValues
	// The local date and time when the lifecycle policy was created.
	DateCreated *time.Time
	// The configuration of the lifecycle policy
	PolicyDetails *PolicyDetails
	// The description of the lifecycle policy.
	Description *string
}

Detailed information about a lifecycle policy.

type LifecyclePolicySummary

type LifecyclePolicySummary struct {
	// The description of the lifecycle policy.
	Description *string
	// The tags.
	Tags map[string]*string
	// The identifier of the lifecycle policy.
	PolicyId *string
	// The activation state of the lifecycle policy.
	State GettablePolicyStateValues
}

Summary information about a lifecycle policy.

type LimitExceededException

type LimitExceededException struct {
	Message *string

	Code         *string
	ResourceType *string
}

The request failed because a limit was exceeded.

func (*LimitExceededException) Error

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage

func (e *LimitExceededException) ErrorMessage() string

func (*LimitExceededException) GetCode

func (e *LimitExceededException) GetCode() string

func (*LimitExceededException) GetMessage

func (e *LimitExceededException) GetMessage() string

func (*LimitExceededException) GetResourceType

func (e *LimitExceededException) GetResourceType() string

func (*LimitExceededException) HasCode

func (e *LimitExceededException) HasCode() bool

func (*LimitExceededException) HasMessage

func (e *LimitExceededException) HasMessage() bool

func (*LimitExceededException) HasResourceType

func (e *LimitExceededException) HasResourceType() bool

type Parameters

type Parameters struct {
	// [EBS Snapshot Management – Instance policies only] Indicates whether to exclude
	// the root volume from snapshots created using CreateSnapshots
	// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html).
	// The default is false.
	ExcludeBootVolume *bool
}

Specifies optional parameters to add to a policy. The set of valid parameters depends on the combination of policy type and resource type.

type PolicyDetails

type PolicyDetails struct {
	// A set of optional parameters for the policy.
	Parameters *Parameters
	// The resource type. Use VOLUME to create snapshots of individual volumes or use
	// INSTANCE to create multi-volume snapshots from the volumes for an instance.
	ResourceTypes []ResourceTypeValues
	// The valid target resource types and actions a policy can manage. The default is
	// EBS_SNAPSHOT_MANAGEMENT.
	PolicyType PolicyTypeValues
	// The schedule of policy-defined actions.
	Schedules []*Schedule
	// The single tag that identifies targeted resources for this policy.
	TargetTags []*Tag
}

Specifies the configuration of a lifecycle policy.

type PolicyTypeValues

type PolicyTypeValues string
const (
	PolicyTypeValuesEbs_snapshot_management PolicyTypeValues = "EBS_SNAPSHOT_MANAGEMENT"
)

Enum values for PolicyTypeValues

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	Code         *string
	ResourceIds  []*string
	ResourceType *string
}

A requested resource was not found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

func (*ResourceNotFoundException) GetCode

func (e *ResourceNotFoundException) GetCode() string

func (*ResourceNotFoundException) GetMessage

func (e *ResourceNotFoundException) GetMessage() string

func (*ResourceNotFoundException) GetResourceIds

func (e *ResourceNotFoundException) GetResourceIds() []*string

func (*ResourceNotFoundException) GetResourceType

func (e *ResourceNotFoundException) GetResourceType() string

func (*ResourceNotFoundException) HasCode

func (e *ResourceNotFoundException) HasCode() bool

func (*ResourceNotFoundException) HasMessage

func (e *ResourceNotFoundException) HasMessage() bool

func (*ResourceNotFoundException) HasResourceIds

func (e *ResourceNotFoundException) HasResourceIds() bool

func (*ResourceNotFoundException) HasResourceType

func (e *ResourceNotFoundException) HasResourceType() bool

type ResourceTypeValues

type ResourceTypeValues string
const (
	ResourceTypeValuesVolume   ResourceTypeValues = "VOLUME"
	ResourceTypeValuesInstance ResourceTypeValues = "INSTANCE"
)

Enum values for ResourceTypeValues

type RetainRule

type RetainRule struct {
	// The unit of time for time-based retention.
	IntervalUnit RetentionIntervalUnitValues
	// The number of snapshots to retain for each volume, up to a maximum of 1000.
	Count *int32
	// The amount of time to retain each snapshot. The maximum is 100 years. This is
	// equivalent to 1200 months, 5200 weeks, or 36500 days.
	Interval *int32
}

Specifies the retention rule for a lifecycle policy. You can retain snapshots based on either a count or a time interval.

type RetentionIntervalUnitValues

type RetentionIntervalUnitValues string
const (
	RetentionIntervalUnitValuesDays   RetentionIntervalUnitValues = "DAYS"
	RetentionIntervalUnitValuesWeeks  RetentionIntervalUnitValues = "WEEKS"
	RetentionIntervalUnitValuesMonths RetentionIntervalUnitValues = "MONTHS"
	RetentionIntervalUnitValuesYears  RetentionIntervalUnitValues = "YEARS"
)

Enum values for RetentionIntervalUnitValues

type Schedule

type Schedule struct {
	// The rule for cross-Region snapshot copies.
	CrossRegionCopyRules []*CrossRegionCopyRule
	// Copy all user-defined tags on a source volume to snapshots of the volume created
	// by this policy.
	CopyTags *bool
	// The name of the schedule.
	Name *string
	// The rule for enabling fast snapshot restore.
	FastRestoreRule *FastRestoreRule
	// The retention rule.
	RetainRule *RetainRule
	// The tags to apply to policy-created resources. These user-defined tags are in
	// addition to the AWS-added lifecycle tags.
	TagsToAdd []*Tag
	// A collection of key/value pairs with values determined dynamically when the
	// policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in
	// one of the two following formats: $(instance-id) or $(timestamp). Variable tags
	// are only valid for EBS Snapshot Management – Instance policies.
	VariableTags []*Tag
	// The creation rule.
	CreateRule *CreateRule
}

Specifies a backup schedule.

type SettablePolicyStateValues

type SettablePolicyStateValues string
const (
	SettablePolicyStateValuesEnabled  SettablePolicyStateValues = "ENABLED"
	SettablePolicyStateValuesDisabled SettablePolicyStateValues = "DISABLED"
)

Enum values for SettablePolicyStateValues

type Tag

type Tag struct {
	// The tag key.
	Key *string
	// The tag value.
	Value *string
}

Specifies a tag for a resource.

Source Files

enums.go errors.go types.go

Version
v0.1.0
Published
Sep 29, 2020
Platform
windows/amd64
Imports
4 packages
Last checked
2 weeks ago

Tools for package owners.