package types

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

Index

Types

type Action

type Action struct {

	// The rule for copying shared snapshots across Regions.
	//
	// This member is required.
	CrossRegionCopy []CrossRegionCopyAction

	// A descriptive name for the action.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Specifies an action for an event-based policy.

type CreateRule

type CreateRule struct {

	// 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 between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12,
	// and 24.
	Interval int32

	// The interval unit.
	IntervalUnit IntervalUnitValues

	// Specifies the destination for snapshots created by the policy. To create
	// snapshots in the same Region as the source resource, specify CLOUD. To create
	// snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If
	// you omit this parameter, CLOUD is used by default. If the policy targets
	// resources in an Amazon Web Services Region, then you must create snapshots in
	// the same Region as the source resource. If the policy targets resources on an
	// Outpost, then you can create snapshots on the same Outpost as the source
	// resource, or in the Region of that Outpost.
	Location LocationValues

	// 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
	// contains filtered or unexported fields
}

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 CrossRegionCopyAction

type CrossRegionCopyAction struct {

	// The encryption settings for the copied snapshot.
	//
	// This member is required.
	EncryptionConfiguration *EncryptionConfiguration

	// The target Region.
	//
	// This member is required.
	Target *string

	// Specifies the retention rule for cross-Region snapshot copies.
	RetainRule *CrossRegionCopyRetainRule
	// contains filtered or unexported fields
}

Specifies a rule for copying shared snapshots across Regions.

type CrossRegionCopyDeprecateRule

type CrossRegionCopyDeprecateRule struct {

	// The period after which to deprecate the cross-Region AMI copies. The period must
	// be less than or equal to the cross-Region AMI copy retention period, and it
	// can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or
	// 3650 days.
	Interval int32

	// The unit of time in which to measure the Interval.
	IntervalUnit RetentionIntervalUnitValues
	// contains filtered or unexported fields
}

Specifies an AMI deprecation rule for cross-Region AMI copies created by a cross-Region copy rule.

type CrossRegionCopyRetainRule

type CrossRegionCopyRetainRule struct {

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

	// The unit of time for time-based retention.
	IntervalUnit RetentionIntervalUnitValues
	// contains filtered or unexported fields
}

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.
	//
	// This member is required.
	Encrypted *bool

	// The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this
	// parameter is not specified, the default KMS key for the account is used.
	CmkArn *string

	// Indicates whether to copy all user-defined tags from the source snapshot to the
	// cross-Region snapshot copy.
	CopyTags *bool

	// The AMI deprecation rule for cross-Region AMI copies created by the rule.
	DeprecateRule *CrossRegionCopyDeprecateRule

	// The retention rule that indicates how long snapshot copies are to be retained in
	// the destination Region.
	RetainRule *CrossRegionCopyRetainRule

	// The target Region or the Amazon Resource Name (ARN) of the target Outpost for
	// the snapshot copies. Use this parameter instead of TargetRegion. Do not specify
	// both.
	Target *string

	// Avoid using this parameter when creating new policies. Instead, use Target to
	// specify a target Region or a target Outpost for snapshot copies. For policies
	// created before the Target parameter was introduced, this parameter indicates the
	// target Region for snapshot copies.
	TargetRegion *string
	// contains filtered or unexported fields
}

Specifies a rule for cross-Region snapshot copies.

type DeprecateRule

type DeprecateRule struct {

	// If the schedule has a count-based retention rule, this parameter specifies the
	// number of oldest AMIs to deprecate. The count must be less than or equal to the
	// schedule's retention count, and it can't be greater than 1000.
	Count int32

	// If the schedule has an age-based retention rule, this parameter specifies the
	// period after which to deprecate AMIs created by the schedule. The period must be
	// less than or equal to the schedule's retention period, and it can't be greater
	// than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
	Interval int32

	// The unit of time in which to measure the Interval.
	IntervalUnit RetentionIntervalUnitValues
	// contains filtered or unexported fields
}

Specifies an AMI deprecation rule for a schedule.

type EncryptionConfiguration

type EncryptionConfiguration struct {

	// To encrypt a copy of an unencrypted snapshot when encryption by default is not
	// enabled, enable encryption using this parameter. Copies of encrypted snapshots
	// are encrypted, even if this parameter is false or when encryption by default is
	// not enabled.
	//
	// This member is required.
	Encrypted *bool

	// The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this
	// parameter is not specified, the default KMS key for the account is used.
	CmkArn *string
	// contains filtered or unexported fields
}

Specifies the encryption settings for shared snapshots that are copied across Regions.

type EventParameters

type EventParameters struct {

	// The snapshot description that can trigger the policy. The description pattern is
	// specified using a regular expression. The policy runs only if a snapshot with a
	// description that matches the specified pattern is shared with your account. For
	// example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$
	// configures the policy to run only if snapshots created by policy
	// policy-1234567890abcdef0 are shared with your account.
	//
	// This member is required.
	DescriptionRegex *string

	// The type of event. Currently, only snapshot sharing events are supported.
	//
	// This member is required.
	EventType EventTypeValues

	// The IDs of the Amazon Web Services accounts that can trigger policy by sharing
	// snapshots with your account. The policy only runs if one of the specified Amazon
	// Web Services accounts shares a snapshot with your account.
	//
	// This member is required.
	SnapshotOwner []string
	// contains filtered or unexported fields
}

Specifies an event that triggers an event-based policy.

type EventSource

type EventSource struct {

	// The source of the event. Currently only managed CloudWatch Events rules are
	// supported.
	//
	// This member is required.
	Type EventSourceValues

	// Information about the event.
	Parameters *EventParameters
	// contains filtered or unexported fields
}

Specifies an event that triggers an event-based policy.

type EventSourceValues

type EventSourceValues string
const (
	EventSourceValuesManagedCwe EventSourceValues = "MANAGED_CWE"
)

Enum values for EventSourceValues

func (EventSourceValues) Values

Values returns all known values for EventSourceValues. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EventTypeValues

type EventTypeValues string
const (
	EventTypeValuesShareSnapshot EventTypeValues = "shareSnapshot"
)

Enum values for EventTypeValues

func (EventTypeValues) Values

func (EventTypeValues) Values() []EventTypeValues

Values returns all known values for EventTypeValues. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FastRestoreRule

type FastRestoreRule struct {

	// The Availability Zones in which to enable fast snapshot restore.
	//
	// This member is required.
	AvailabilityZones []string

	// The number of snapshots to be enabled with fast snapshot restore.
	Count int32

	// 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 unit of time for enabling fast snapshot restore.
	IntervalUnit RetentionIntervalUnitValues
	// contains filtered or unexported fields
}

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

func (GettablePolicyStateValues) Values

Values returns all known values for GettablePolicyStateValues. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException

type InternalServerException struct {
	Message *string

	Code *string
	// contains filtered or unexported fields
}

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

type IntervalUnitValues

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

Enum values for IntervalUnitValues

func (IntervalUnitValues) Values

Values returns all known values for IntervalUnitValues. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InvalidRequestException

type InvalidRequestException struct {
	Message *string

	Code                        *string
	RequiredParameters          []string
	MutuallyExclusiveParameters []string
	// contains filtered or unexported fields
}

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

type LifecyclePolicy

type LifecyclePolicy struct {

	// The local date and time when the lifecycle policy was created.
	DateCreated *time.Time

	// The local date and time when the lifecycle policy was last modified.
	DateModified *time.Time

	// The description of the lifecycle policy.
	Description *string

	// The Amazon Resource Name (ARN) of the IAM role used to run the operations
	// specified by the lifecycle policy.
	ExecutionRoleArn *string

	// The Amazon Resource Name (ARN) of the policy.
	PolicyArn *string

	// The configuration of the lifecycle policy
	PolicyDetails *PolicyDetails

	// The identifier of the lifecycle policy.
	PolicyId *string

	// The activation state of the lifecycle policy.
	State GettablePolicyStateValues

	// The description of the status.
	StatusMessage *string

	// The tags.
	Tags map[string]string
	// contains filtered or unexported fields
}

Detailed information about a lifecycle policy.

type LifecyclePolicySummary

type LifecyclePolicySummary struct {

	// The description of the lifecycle policy.
	Description *string

	// The identifier of the lifecycle policy.
	PolicyId *string

	// The type of policy. EBS_SNAPSHOT_MANAGEMENT indicates that the policy manages
	// the lifecycle of Amazon EBS snapshots. IMAGE_MANAGEMENT indicates that the
	// policy manages the lifecycle of EBS-backed AMIs.
	PolicyType PolicyTypeValues

	// The activation state of the lifecycle policy.
	State GettablePolicyStateValues

	// The tags.
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about a lifecycle policy.

type LimitExceededException

type LimitExceededException struct {
	Message *string

	Code         *string
	ResourceType *string
	// contains filtered or unexported fields
}

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

type LocationValues

type LocationValues string
const (
	LocationValuesCloud        LocationValues = "CLOUD"
	LocationValuesOutpostLocal LocationValues = "OUTPOST_LOCAL"
)

Enum values for LocationValues

func (LocationValues) Values

func (LocationValues) Values() []LocationValues

Values returns all known values for LocationValues. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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

	// Applies to AMI lifecycle policies only. Indicates whether targeted instances are
	// rebooted when the lifecycle policy runs. true indicates that targeted instances
	// are not rebooted when the policy runs. false indicates that target instances are
	// rebooted when the policy runs. The default is true (instances are not rebooted).
	NoReboot *bool
	// contains filtered or unexported fields
}

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 {

	// The actions to be performed when the event-based policy is triggered. You can
	// specify only one action per policy. This parameter is required for event-based
	// policies only. If you are creating a snapshot or AMI policy, omit this
	// parameter.
	Actions []Action

	// The event that triggers the event-based policy. This parameter is required for
	// event-based policies only. If you are creating a snapshot or AMI policy, omit
	// this parameter.
	EventSource *EventSource

	// A set of optional parameters for snapshot and AMI lifecycle policies. This
	// parameter is required for snapshot and AMI policies only. If you are creating an
	// event-based policy, omit this parameter.
	Parameters *Parameters

	// The valid target resource types and actions a policy can manage. Specify
	// EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle
	// of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy
	// that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY  to
	// create an event-based policy that performs specific actions when a defined event
	// occurs in your Amazon Web Services account. The default is
	// EBS_SNAPSHOT_MANAGEMENT.
	PolicyType PolicyTypeValues

	// The location of the resources to backup. If the source resources are located in
	// an Amazon Web Services Region, specify CLOUD. If the source resources are
	// located on an Outpost in your account, specify OUTPOST. If you specify OUTPOST,
	// Amazon Data Lifecycle Manager backs up all resources of the specified type with
	// matching target tags across all of the Outposts in your account.
	ResourceLocations []ResourceLocationValues

	// The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to
	// create snapshots of individual volumes or use INSTANCE to create multi-volume
	// snapshots from the volumes for an instance. This parameter is required for
	// snapshot and AMI policies only. If you are creating an event-based policy, omit
	// this parameter.
	ResourceTypes []ResourceTypeValues

	// The schedules of policy-defined actions for snapshot and AMI lifecycle policies.
	// A policy can have up to four schedules—one mandatory schedule and up to three
	// optional schedules. This parameter is required for snapshot and AMI policies
	// only. If you are creating an event-based policy, omit this parameter.
	Schedules []Schedule

	// The single tag that identifies targeted resources for this policy. This
	// parameter is required for snapshot and AMI policies only. If you are creating an
	// event-based policy, omit this parameter.
	TargetTags []Tag
	// contains filtered or unexported fields
}

Specifies the configuration of a lifecycle policy.

type PolicyTypeValues

type PolicyTypeValues string
const (
	PolicyTypeValuesEbsSnapshotManagement PolicyTypeValues = "EBS_SNAPSHOT_MANAGEMENT"
	PolicyTypeValuesImageManagement       PolicyTypeValues = "IMAGE_MANAGEMENT"
	PolicyTypeValuesEventBasedPolicy      PolicyTypeValues = "EVENT_BASED_POLICY"
)

Enum values for PolicyTypeValues

func (PolicyTypeValues) Values

Values returns all known values for PolicyTypeValues. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceLocationValues

type ResourceLocationValues string
const (
	ResourceLocationValuesCloud   ResourceLocationValues = "CLOUD"
	ResourceLocationValuesOutpost ResourceLocationValues = "OUTPOST"
)

Enum values for ResourceLocationValues

func (ResourceLocationValues) Values

Values returns all known values for ResourceLocationValues. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	Code         *string
	ResourceType *string
	ResourceIds  []string
	// contains filtered or unexported fields
}

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

type ResourceTypeValues

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

Enum values for ResourceTypeValues

func (ResourceTypeValues) Values

Values returns all known values for ResourceTypeValues. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RetainRule

type RetainRule struct {

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

	// The unit of time for time-based retention.
	IntervalUnit RetentionIntervalUnitValues
	// contains filtered or unexported fields
}

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

func (RetentionIntervalUnitValues) Values

Values returns all known values for RetentionIntervalUnitValues. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Schedule

type Schedule struct {

	// Copy all user-defined tags on a source volume to snapshots of the volume created
	// by this policy.
	CopyTags bool

	// The creation rule.
	CreateRule *CreateRule

	// The rule for cross-Region snapshot copies. You can only specify cross-Region
	// copy rules for policies that create snapshots in a Region. If the policy creates
	// snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an
	// Outpost. If the policy creates snapshots in a Region, then snapshots can be
	// copied to up to three Regions or Outposts.
	CrossRegionCopyRules []CrossRegionCopyRule

	// The AMI deprecation rule for the schedule.
	DeprecateRule *DeprecateRule

	// The rule for enabling fast snapshot restore.
	FastRestoreRule *FastRestoreRule

	// The name of the schedule.
	Name *string

	// The retention rule.
	RetainRule *RetainRule

	// The rule for sharing snapshots with other Amazon Web Services accounts.
	ShareRules []ShareRule

	// The tags to apply to policy-created resources. These user-defined tags are in
	// addition to the Amazon Web Services-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
	// contains filtered or unexported fields
}

Specifies a backup schedule for a snapshot or AMI lifecycle policy.

type SettablePolicyStateValues

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

Enum values for SettablePolicyStateValues

func (SettablePolicyStateValues) Values

Values returns all known values for SettablePolicyStateValues. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ShareRule

type ShareRule struct {

	// The IDs of the Amazon Web Services accounts with which to share the snapshots.
	//
	// This member is required.
	TargetAccounts []string

	// The period after which snapshots that are shared with other Amazon Web Services
	// accounts are automatically unshared.
	UnshareInterval int32

	// The unit of time for the automatic unsharing interval.
	UnshareIntervalUnit RetentionIntervalUnitValues
	// contains filtered or unexported fields
}

Specifies a rule for sharing snapshots across Amazon Web Services accounts.

type Tag

type Tag struct {

	// The tag key.
	//
	// This member is required.
	Key *string

	// The tag value.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Specifies a tag for a resource.

Source Files

enums.go errors.go types.go

Version
v1.11.4
Published
Apr 25, 2022
Platform
js/wasm
Imports
4 packages
Last checked
2 weeks ago

Tools for package owners.