dlm

package
v1.55.5 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 10 Imported by: 49

Documentation

Overview

Package dlm provides the client and types for making API requests to Amazon Data Lifecycle Manager.

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create lifecycle policies, which are used to automate operations on the specified resources.

Amazon Data Lifecycle Manager supports Amazon EBS volumes and snapshots. For information about using Amazon Data Lifecycle Manager with Amazon EBS, see Amazon Data Lifecycle Manager (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-lifecycle.html) in the Amazon EC2 User Guide.

See https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12 for more information on this service.

See dlm package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/dlm/

Using the Client

To contact Amazon Data Lifecycle Manager with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Data Lifecycle Manager client DLM for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/dlm/#New

Index

Constants

View Source 
const (
	// DefaultPoliciesTypeValuesVolume is a DefaultPoliciesTypeValues enum value
	DefaultPoliciesTypeValuesVolume = "VOLUME"

	// DefaultPoliciesTypeValuesInstance is a DefaultPoliciesTypeValues enum value
	DefaultPoliciesTypeValuesInstance = "INSTANCE"

	// DefaultPoliciesTypeValuesAll is a DefaultPoliciesTypeValues enum value
	DefaultPoliciesTypeValuesAll = "ALL"
)
View Source 
const (
	// DefaultPolicyTypeValuesVolume is a DefaultPolicyTypeValues enum value
	DefaultPolicyTypeValuesVolume = "VOLUME"

	// DefaultPolicyTypeValuesInstance is a DefaultPolicyTypeValues enum value
	DefaultPolicyTypeValuesInstance = "INSTANCE"
)
View Source 
const (
	// GettablePolicyStateValuesEnabled is a GettablePolicyStateValues enum value
	GettablePolicyStateValuesEnabled = "ENABLED"

	// GettablePolicyStateValuesDisabled is a GettablePolicyStateValues enum value
	GettablePolicyStateValuesDisabled = "DISABLED"

	// GettablePolicyStateValuesError is a GettablePolicyStateValues enum value
	GettablePolicyStateValuesError = "ERROR"
)
View Source 
const (
	// LocationValuesCloud is a LocationValues enum value
	LocationValuesCloud = "CLOUD"

	// LocationValuesOutpostLocal is a LocationValues enum value
	LocationValuesOutpostLocal = "OUTPOST_LOCAL"
)
View Source 
const (
	// PolicyLanguageValuesSimplified is a PolicyLanguageValues enum value
	PolicyLanguageValuesSimplified = "SIMPLIFIED"

	// PolicyLanguageValuesStandard is a PolicyLanguageValues enum value
	PolicyLanguageValuesStandard = "STANDARD"
)
View Source 
const (
	// PolicyTypeValuesEbsSnapshotManagement is a PolicyTypeValues enum value
	PolicyTypeValuesEbsSnapshotManagement = "EBS_SNAPSHOT_MANAGEMENT"

	// PolicyTypeValuesImageManagement is a PolicyTypeValues enum value
	PolicyTypeValuesImageManagement = "IMAGE_MANAGEMENT"

	// PolicyTypeValuesEventBasedPolicy is a PolicyTypeValues enum value
	PolicyTypeValuesEventBasedPolicy = "EVENT_BASED_POLICY"
)
View Source 
const (
	// ResourceLocationValuesCloud is a ResourceLocationValues enum value
	ResourceLocationValuesCloud = "CLOUD"

	// ResourceLocationValuesOutpost is a ResourceLocationValues enum value
	ResourceLocationValuesOutpost = "OUTPOST"
)
View Source 
const (
	// ResourceTypeValuesVolume is a ResourceTypeValues enum value
	ResourceTypeValuesVolume = "VOLUME"

	// ResourceTypeValuesInstance is a ResourceTypeValues enum value
	ResourceTypeValuesInstance = "INSTANCE"
)
View Source 
const (
	// RetentionIntervalUnitValuesDays is a RetentionIntervalUnitValues enum value
	RetentionIntervalUnitValuesDays = "DAYS"

	// RetentionIntervalUnitValuesWeeks is a RetentionIntervalUnitValues enum value
	RetentionIntervalUnitValuesWeeks = "WEEKS"

	// RetentionIntervalUnitValuesMonths is a RetentionIntervalUnitValues enum value
	RetentionIntervalUnitValuesMonths = "MONTHS"

	// RetentionIntervalUnitValuesYears is a RetentionIntervalUnitValues enum value
	RetentionIntervalUnitValuesYears = "YEARS"
)
View Source 
const (
	// SettablePolicyStateValuesEnabled is a SettablePolicyStateValues enum value
	SettablePolicyStateValuesEnabled = "ENABLED"

	// SettablePolicyStateValuesDisabled is a SettablePolicyStateValues enum value
	SettablePolicyStateValuesDisabled = "DISABLED"
)
View Source 
const (
	// StageValuesPre is a StageValues enum value
	StageValuesPre = "PRE"

	// StageValuesPost is a StageValues enum value
	StageValuesPost = "POST"
)
View Source 
const (

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The service failed in an unexpected way.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// Bad request. The request is missing required parameters or has invalid parameters.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The request failed because a limit was exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A requested resource was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
const (
	ServiceName = "DLM" // Name of service.
	EndpointsID = "dlm" // ID to lookup a service endpoint with.
	ServiceID   = "DLM" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// EventSourceValuesManagedCwe is a EventSourceValues enum value
	EventSourceValuesManagedCwe = "MANAGED_CWE"
)
View Source 
const (
	// EventTypeValuesShareSnapshot is a EventTypeValues enum value
	EventTypeValuesShareSnapshot = "shareSnapshot"
)
View Source 
const (
	// ExecutionHandlerServiceValuesAwsSystemsManager is a ExecutionHandlerServiceValues enum value
	ExecutionHandlerServiceValuesAwsSystemsManager = "AWS_SYSTEMS_MANAGER"
)
View Source 
const (
	// IntervalUnitValuesHours is a IntervalUnitValues enum value
	IntervalUnitValuesHours = "HOURS"
)

Variables

This section is empty.

Functions

func DefaultPoliciesTypeValues_Values added in v1.47.13 

func DefaultPoliciesTypeValues_Values() []string

DefaultPoliciesTypeValues_Values returns all elements of the DefaultPoliciesTypeValues enum

func DefaultPolicyTypeValues_Values added in v1.47.13 

func DefaultPolicyTypeValues_Values() []string

DefaultPolicyTypeValues_Values returns all elements of the DefaultPolicyTypeValues enum

func EventSourceValues_Values added in v1.36.11 

func EventSourceValues_Values() []string

EventSourceValues_Values returns all elements of the EventSourceValues enum

func EventTypeValues_Values added in v1.36.11 

func EventTypeValues_Values() []string

EventTypeValues_Values returns all elements of the EventTypeValues enum

func ExecutionHandlerServiceValues_Values added in v1.47.5 

func ExecutionHandlerServiceValues_Values() []string

ExecutionHandlerServiceValues_Values returns all elements of the ExecutionHandlerServiceValues enum

func GettablePolicyStateValues_Values added in v1.34.3 

func GettablePolicyStateValues_Values() []string

GettablePolicyStateValues_Values returns all elements of the GettablePolicyStateValues enum

func IntervalUnitValues_Values added in v1.34.3 

func IntervalUnitValues_Values() []string

IntervalUnitValues_Values returns all elements of the IntervalUnitValues enum

func LocationValues_Values added in v1.37.4 

func LocationValues_Values() []string

LocationValues_Values returns all elements of the LocationValues enum

func PolicyLanguageValues_Values added in v1.47.13 

func PolicyLanguageValues_Values() []string

PolicyLanguageValues_Values returns all elements of the PolicyLanguageValues enum

func PolicyTypeValues_Values added in v1.34.3 

func PolicyTypeValues_Values() []string

PolicyTypeValues_Values returns all elements of the PolicyTypeValues enum

func ResourceLocationValues_Values added in v1.37.4 

func ResourceLocationValues_Values() []string

ResourceLocationValues_Values returns all elements of the ResourceLocationValues enum

func ResourceTypeValues_Values added in v1.34.3 

func ResourceTypeValues_Values() []string

ResourceTypeValues_Values returns all elements of the ResourceTypeValues enum

func RetentionIntervalUnitValues_Values added in v1.34.3 

func RetentionIntervalUnitValues_Values() []string

RetentionIntervalUnitValues_Values returns all elements of the RetentionIntervalUnitValues enum

func SettablePolicyStateValues_Values added in v1.34.3 

func SettablePolicyStateValues_Values() []string

SettablePolicyStateValues_Values returns all elements of the SettablePolicyStateValues enum

func StageValues_Values added in v1.47.5 

func StageValues_Values() []string

StageValues_Values returns all elements of the StageValues enum

Types

type Action added in v1.36.11 

type Action struct {

	// The rule for copying shared snapshots across Regions.
	//
	// CrossRegionCopy is a required field
	CrossRegionCopy []*CrossRegionCopyAction `type:"list" required:"true"`

	// A descriptive name for the action.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

[Event-based policies only] Specifies an action for an event-based policy.

func (Action) GoString added in v1.36.11 

func (s Action) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Action) SetCrossRegionCopy added in v1.36.11 

func (s *Action) SetCrossRegionCopy(v []*CrossRegionCopyAction) *Action

SetCrossRegionCopy sets the CrossRegionCopy field's value.

func (*Action) SetName added in v1.36.11 

func (s *Action) SetName(v string) *Action

SetName sets the Name field's value.

func (Action) String added in v1.36.11 

func (s Action) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Action) Validate added in v1.36.11 

func (s *Action) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ArchiveRetainRule added in v1.44.109 

type ArchiveRetainRule struct {

	// Information about retention period in the Amazon EBS Snapshots Archive. For
	// more information, see Archive Amazon EBS snapshots (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/snapshot-archive.html).
	//
	// RetentionArchiveTier is a required field
	RetentionArchiveTier *RetentionArchiveTier `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

[Custom snapshot policies only] Specifies information about the archive storage tier retention period.

func (ArchiveRetainRule) GoString added in v1.44.109 

func (s ArchiveRetainRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ArchiveRetainRule) SetRetentionArchiveTier added in v1.44.109 

func (s *ArchiveRetainRule) SetRetentionArchiveTier(v *RetentionArchiveTier) *ArchiveRetainRule

SetRetentionArchiveTier sets the RetentionArchiveTier field's value.

func (ArchiveRetainRule) String added in v1.44.109 

func (s ArchiveRetainRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ArchiveRetainRule) Validate added in v1.44.109 

func (s *ArchiveRetainRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ArchiveRule added in v1.44.109 

type ArchiveRule struct {

	// Information about the retention period for the snapshot archiving rule.
	//
	// RetainRule is a required field
	RetainRule *ArchiveRetainRule `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

[Custom snapshot policies only] Specifies a snapshot archiving rule for a schedule.

func (ArchiveRule) GoString added in v1.44.109 

func (s ArchiveRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ArchiveRule) SetRetainRule added in v1.44.109 

func (s *ArchiveRule) SetRetainRule(v *ArchiveRetainRule) *ArchiveRule

SetRetainRule sets the RetainRule field's value.

func (ArchiveRule) String added in v1.44.109 

func (s ArchiveRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ArchiveRule) Validate added in v1.44.109 

func (s *ArchiveRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLifecyclePolicyInput 

type CreateLifecyclePolicyInput struct {

	// [Default policies only] Indicates whether the policy should copy tags from
	// the source resource to the snapshot or AMI. If you do not specify a value,
	// the default is false.
	//
	// Default: false
	CopyTags *bool `type:"boolean"`

	// [Default policies only] Specifies how often the policy should run and create
	// snapshots or AMIs. The creation frequency can range from 1 to 7 days. If
	// you do not specify a value, the default is 1.
	//
	// Default: 1
	CreateInterval *int64 `min:"1" type:"integer"`

	// [Default policies only] Specifies destination Regions for snapshot or AMI
	// copies. You can specify up to 3 destination Regions. If you do not want to
	// create cross-Region copies, omit this parameter.
	CrossRegionCopyTargets []*CrossRegionCopyTarget `type:"list"`

	// [Default policies only] Specify the type of default policy to create.
	//
	//    * To create a default policy for EBS snapshots, that creates snapshots
	//    of all volumes in the Region that do not have recent backups, specify
	//    VOLUME.
	//
	//    * To create a default policy for EBS-backed AMIs, that creates EBS-backed
	//    AMIs from all instances in the Region that do not have recent backups,
	//    specify INSTANCE.
	DefaultPolicy *string `type:"string" enum:"DefaultPolicyTypeValues"`

	// A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are
	// supported.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// [Default policies only] Specifies exclusion parameters for volumes or instances
	// for which you do not want to create snapshots or AMIs. The policy will not
	// create snapshots or AMIs for target resources that match any of the specified
	// exclusion parameters.
	Exclusions *Exclusions `type:"structure"`

	// The Amazon Resource Name (ARN) of the IAM role used to run the operations
	// specified by the lifecycle policy.
	//
	// ExecutionRoleArn is a required field
	ExecutionRoleArn *string `type:"string" required:"true"`

	// [Default policies only] Defines the snapshot or AMI retention behavior for
	// the policy if the source volume or instance is deleted, or if the policy
	// enters the error, disabled, or deleted state.
	//
	// By default (ExtendDeletion=false):
	//
	//    * If a source resource is deleted, Amazon Data Lifecycle Manager will
	//    continue to delete previously created snapshots or AMIs, up to but not
	//    including the last one, based on the specified retention period. If you
	//    want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including
	//    the last one, specify true.
	//
	//    * If a policy enters the error, disabled, or deleted state, Amazon Data
	//    Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon
	//    Data Lifecycle Manager to continue deleting snapshots or AMIs, including
	//    the last one, if the policy enters one of these states, specify true.
	//
	// If you enable extended deletion (ExtendDeletion=true), you override both
	// default behaviors simultaneously.
	//
	// If you do not specify a value, the default is false.
	//
	// Default: false
	ExtendDeletion *bool `type:"boolean"`

	// The configuration details of the lifecycle policy.
	//
	// If you create a default policy, you can specify the request parameters either
	// in the request body, or in the PolicyDetails request structure, but not both.
	PolicyDetails *PolicyDetails `type:"structure"`

	// [Default policies only] Specifies how long the policy should retain snapshots
	// or AMIs before deleting them. The retention period can range from 2 to 14
	// days, but it must be greater than the creation frequency to ensure that the
	// policy retains at least 1 snapshot or AMI at any given time. If you do not
	// specify a value, the default is 7.
	//
	// Default: 7
	RetainInterval *int64 `min:"1" type:"integer"`

	// The activation state of the lifecycle policy after creation.
	//
	// State is a required field
	State *string `type:"string" required:"true" enum:"SettablePolicyStateValues"`

	// The tags to apply to the lifecycle policy during creation.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateLifecyclePolicyInput) GoString 

func (s CreateLifecyclePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLifecyclePolicyInput) SetCopyTags added in v1.47.13 

func (s *CreateLifecyclePolicyInput) SetCopyTags(v bool) *CreateLifecyclePolicyInput

SetCopyTags sets the CopyTags field's value.

func (*CreateLifecyclePolicyInput) SetCreateInterval added in v1.47.13 

func (s *CreateLifecyclePolicyInput) SetCreateInterval(v int64) *CreateLifecyclePolicyInput

SetCreateInterval sets the CreateInterval field's value.

func (*CreateLifecyclePolicyInput) SetCrossRegionCopyTargets added in v1.47.13 

func (s *CreateLifecyclePolicyInput) SetCrossRegionCopyTargets(v []*CrossRegionCopyTarget) *CreateLifecyclePolicyInput

SetCrossRegionCopyTargets sets the CrossRegionCopyTargets field's value.

func (*CreateLifecyclePolicyInput) SetDefaultPolicy added in v1.47.13 

func (s *CreateLifecyclePolicyInput) SetDefaultPolicy(v string) *CreateLifecyclePolicyInput

SetDefaultPolicy sets the DefaultPolicy field's value.

func (*CreateLifecyclePolicyInput) SetDescription 

func (s *CreateLifecyclePolicyInput) SetDescription(v string) *CreateLifecyclePolicyInput

SetDescription sets the Description field's value.

func (*CreateLifecyclePolicyInput) SetExclusions added in v1.47.13 

func (s *CreateLifecyclePolicyInput) SetExclusions(v *Exclusions) *CreateLifecyclePolicyInput

SetExclusions sets the Exclusions field's value.

func (*CreateLifecyclePolicyInput) SetExecutionRoleArn 

func (s *CreateLifecyclePolicyInput) SetExecutionRoleArn(v string) *CreateLifecyclePolicyInput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*CreateLifecyclePolicyInput) SetExtendDeletion added in v1.47.13 

func (s *CreateLifecyclePolicyInput) SetExtendDeletion(v bool) *CreateLifecyclePolicyInput

SetExtendDeletion sets the ExtendDeletion field's value.

func (*CreateLifecyclePolicyInput) SetPolicyDetails 

func (s *CreateLifecyclePolicyInput) SetPolicyDetails(v *PolicyDetails) *CreateLifecyclePolicyInput

SetPolicyDetails sets the PolicyDetails field's value.

func (*CreateLifecyclePolicyInput) SetRetainInterval added in v1.47.13 

func (s *CreateLifecyclePolicyInput) SetRetainInterval(v int64) *CreateLifecyclePolicyInput

SetRetainInterval sets the RetainInterval field's value.

func (*CreateLifecyclePolicyInput) SetState 

func (s *CreateLifecyclePolicyInput) SetState(v string) *CreateLifecyclePolicyInput

SetState sets the State field's value.

func (*CreateLifecyclePolicyInput) SetTags added in v1.25.34 

func (s *CreateLifecyclePolicyInput) SetTags(v map[string]*string) *CreateLifecyclePolicyInput

SetTags sets the Tags field's value.

func (CreateLifecyclePolicyInput) String 

func (s CreateLifecyclePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLifecyclePolicyInput) Validate 

func (s *CreateLifecyclePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLifecyclePolicyOutput 

type CreateLifecyclePolicyOutput struct {

	// The identifier of the lifecycle policy.
	PolicyId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateLifecyclePolicyOutput) GoString 

func (s CreateLifecyclePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLifecyclePolicyOutput) SetPolicyId 

func (s *CreateLifecyclePolicyOutput) SetPolicyId(v string) *CreateLifecyclePolicyOutput

SetPolicyId sets the PolicyId field's value.

func (CreateLifecyclePolicyOutput) String 

func (s CreateLifecyclePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"17" type:"string"`

	// The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8,
	// 12, and 24.
	Interval *int64 `min:"1" type:"integer"`

	// The interval unit.
	IntervalUnit *string `type:"string" enum:"IntervalUnitValues"`

	// [Custom snapshot policies only] 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 *string `type:"string" enum:"LocationValues"`

	// [Custom snapshot policies that target instances only] Specifies pre and/or
	// post scripts for a snapshot lifecycle policy that targets instances. This
	// is useful for creating application-consistent snapshots, or for performing
	// specific administrative tasks before or after Amazon Data Lifecycle Manager
	// initiates snapshot creation.
	//
	// For more information, see Automating application-consistent snapshots with
	// pre and post scripts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/automate-app-consistent-backups.html).
	Scripts []*Script `type:"list"`

	// 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 Data Lifecycle Manager selects a time
	// within the next 24 hours.
	Times []*string `type:"list"`
	// contains filtered or unexported fields
}

[Custom snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.

func (CreateRule) GoString 

func (s CreateRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRule) SetCronExpression added in v1.31.5 

func (s *CreateRule) SetCronExpression(v string) *CreateRule

SetCronExpression sets the CronExpression field's value.

func (*CreateRule) SetInterval 

func (s *CreateRule) SetInterval(v int64) *CreateRule

SetInterval sets the Interval field's value.

func (*CreateRule) SetIntervalUnit 

func (s *CreateRule) SetIntervalUnit(v string) *CreateRule

SetIntervalUnit sets the IntervalUnit field's value.

func (*CreateRule) SetLocation added in v1.37.4 

func (s *CreateRule) SetLocation(v string) *CreateRule

SetLocation sets the Location field's value.

func (*CreateRule) SetScripts added in v1.47.5 

func (s *CreateRule) SetScripts(v []*Script) *CreateRule

SetScripts sets the Scripts field's value.

func (*CreateRule) SetTimes 

func (s *CreateRule) SetTimes(v []*string) *CreateRule

SetTimes sets the Times field's value.

func (CreateRule) String 

func (s CreateRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRule) Validate 

func (s *CreateRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CrossRegionCopyAction added in v1.36.11 

type CrossRegionCopyAction struct {

	// The encryption settings for the copied snapshot.
	//
	// EncryptionConfiguration is a required field
	EncryptionConfiguration *EncryptionConfiguration `type:"structure" required:"true"`

	// Specifies a retention rule for cross-Region snapshot copies created by snapshot
	// or event-based policies, or cross-Region AMI copies created by AMI policies.
	// After the retention period expires, the cross-Region copy is deleted.
	RetainRule *CrossRegionCopyRetainRule `type:"structure"`

	// The target Region.
	//
	// Target is a required field
	Target *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

[Event-based policies only] Specifies a cross-Region copy action for event-based policies.

To specify a cross-Region copy rule for snapshot and AMI policies, use CrossRegionCopyRule (https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html).

func (CrossRegionCopyAction) GoString added in v1.36.11 

func (s CrossRegionCopyAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CrossRegionCopyAction) SetEncryptionConfiguration added in v1.36.11 

func (s *CrossRegionCopyAction) SetEncryptionConfiguration(v *EncryptionConfiguration) *CrossRegionCopyAction

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*CrossRegionCopyAction) SetRetainRule added in v1.36.11 

func (s *CrossRegionCopyAction) SetRetainRule(v *CrossRegionCopyRetainRule) *CrossRegionCopyAction

SetRetainRule sets the RetainRule field's value.

func (*CrossRegionCopyAction) SetTarget added in v1.36.11 

func (s *CrossRegionCopyAction) SetTarget(v string) *CrossRegionCopyAction

SetTarget sets the Target field's value.

func (CrossRegionCopyAction) String added in v1.36.11 

func (s CrossRegionCopyAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CrossRegionCopyAction) Validate added in v1.36.11 

func (s *CrossRegionCopyAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CrossRegionCopyDeprecateRule added in v1.40.28 

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 *int64 `min:"1" type:"integer"`

	// The unit of time in which to measure the Interval. For example, to deprecate
	// a cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS.
	IntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
	// contains filtered or unexported fields
}

[Custom AMI policies only] Specifies an AMI deprecation rule for cross-Region AMI copies created by an AMI policy.

func (CrossRegionCopyDeprecateRule) GoString added in v1.40.28 

func (s CrossRegionCopyDeprecateRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CrossRegionCopyDeprecateRule) SetInterval added in v1.40.28 

func (s *CrossRegionCopyDeprecateRule) SetInterval(v int64) *CrossRegionCopyDeprecateRule

SetInterval sets the Interval field's value.

func (*CrossRegionCopyDeprecateRule) SetIntervalUnit added in v1.40.28 

func (s *CrossRegionCopyDeprecateRule) SetIntervalUnit(v string) *CrossRegionCopyDeprecateRule

SetIntervalUnit sets the IntervalUnit field's value.

func (CrossRegionCopyDeprecateRule) String added in v1.40.28 

func (s CrossRegionCopyDeprecateRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CrossRegionCopyDeprecateRule) Validate added in v1.40.28 

func (s *CrossRegionCopyDeprecateRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CrossRegionCopyRetainRule added in v1.26.6 

type CrossRegionCopyRetainRule struct {

	// The amount of time to retain a cross-Region snapshot or AMI copy. The maximum
	// is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
	Interval *int64 `min:"1" type:"integer"`

	// The unit of time for time-based retention. For example, to retain a cross-Region
	// copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.
	IntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
	// contains filtered or unexported fields
}

Specifies a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.

func (CrossRegionCopyRetainRule) GoString added in v1.26.6 

func (s CrossRegionCopyRetainRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CrossRegionCopyRetainRule) SetInterval added in v1.26.6 

func (s *CrossRegionCopyRetainRule) SetInterval(v int64) *CrossRegionCopyRetainRule

SetInterval sets the Interval field's value.

func (*CrossRegionCopyRetainRule) SetIntervalUnit added in v1.26.6 

func (s *CrossRegionCopyRetainRule) SetIntervalUnit(v string) *CrossRegionCopyRetainRule

SetIntervalUnit sets the IntervalUnit field's value.

func (CrossRegionCopyRetainRule) String added in v1.26.6 

func (s CrossRegionCopyRetainRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CrossRegionCopyRetainRule) Validate added in v1.26.6 

func (s *CrossRegionCopyRetainRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CrossRegionCopyRule added in v1.26.6 

type CrossRegionCopyRule struct {

	// 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 `type:"string"`

	// Indicates whether to copy all user-defined tags from the source snapshot
	// or AMI to the cross-Region copy.
	CopyTags *bool `type:"boolean"`

	// [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI
	// copies created by the rule.
	DeprecateRule *CrossRegionCopyDeprecateRule `type:"structure"`

	// 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 is a required field
	Encrypted *bool `type:"boolean" required:"true"`

	// The retention rule that indicates how long the cross-Region snapshot or AMI
	// copies are to be retained in the destination Region.
	RetainRule *CrossRegionCopyRetainRule `type:"structure"`

	//
	// Use this parameter for snapshot policies only. For AMI policies, use TargetRegion
	// instead.
	//
	// [Custom snapshot policies only] The target Region or the Amazon Resource
	// Name (ARN) of the target Outpost for the snapshot copies.
	Target *string `type:"string"`

	//
	// Use this parameter for AMI policies only. For snapshot policies, use Target
	// instead. For snapshot policies created before the Target parameter was introduced,
	// this parameter indicates the target Region for snapshot copies.
	//
	// [Custom AMI policies only] The target Region or the Amazon Resource Name
	// (ARN) of the target Outpost for the snapshot copies.
	TargetRegion *string `type:"string"`
	// contains filtered or unexported fields
}

[Custom snapshot and AMI policies only] Specifies a cross-Region copy rule for a snapshot and AMI policies.

To specify a cross-Region copy action for event-based polices, use CrossRegionCopyAction (https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyAction.html).

func (CrossRegionCopyRule) GoString added in v1.26.6 

func (s CrossRegionCopyRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CrossRegionCopyRule) SetCmkArn added in v1.26.6 

func (s *CrossRegionCopyRule) SetCmkArn(v string) *CrossRegionCopyRule

SetCmkArn sets the CmkArn field's value.

func (*CrossRegionCopyRule) SetCopyTags added in v1.26.6 

func (s *CrossRegionCopyRule) SetCopyTags(v bool) *CrossRegionCopyRule

SetCopyTags sets the CopyTags field's value.

func (*CrossRegionCopyRule) SetDeprecateRule added in v1.40.28 

func (s *CrossRegionCopyRule) SetDeprecateRule(v *CrossRegionCopyDeprecateRule) *CrossRegionCopyRule

SetDeprecateRule sets the DeprecateRule field's value.

func (*CrossRegionCopyRule) SetEncrypted added in v1.26.6 

func (s *CrossRegionCopyRule) SetEncrypted(v bool) *CrossRegionCopyRule

SetEncrypted sets the Encrypted field's value.

func (*CrossRegionCopyRule) SetRetainRule added in v1.26.6 

func (s *CrossRegionCopyRule) SetRetainRule(v *CrossRegionCopyRetainRule) *CrossRegionCopyRule

SetRetainRule sets the RetainRule field's value.

func (*CrossRegionCopyRule) SetTarget added in v1.37.4 

func (s *CrossRegionCopyRule) SetTarget(v string) *CrossRegionCopyRule

SetTarget sets the Target field's value.

func (*CrossRegionCopyRule) SetTargetRegion added in v1.26.6 

func (s *CrossRegionCopyRule) SetTargetRegion(v string) *CrossRegionCopyRule

SetTargetRegion sets the TargetRegion field's value.

func (CrossRegionCopyRule) String added in v1.26.6 

func (s CrossRegionCopyRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CrossRegionCopyRule) Validate added in v1.26.6 

func (s *CrossRegionCopyRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CrossRegionCopyTarget added in v1.47.13 

type CrossRegionCopyTarget struct {

	// The target Region, for example us-east-1.
	TargetRegion *string `type:"string"`
	// contains filtered or unexported fields
}

[Default policies only] Specifies a destination Region for cross-Region copy actions.

func (CrossRegionCopyTarget) GoString added in v1.47.13 

func (s CrossRegionCopyTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CrossRegionCopyTarget) SetTargetRegion added in v1.47.13 

func (s *CrossRegionCopyTarget) SetTargetRegion(v string) *CrossRegionCopyTarget

SetTargetRegion sets the TargetRegion field's value.

func (CrossRegionCopyTarget) String added in v1.47.13 

func (s CrossRegionCopyTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DLM 

type DLM struct {
	*client.Client
}

DLM provides the API operation methods for making requests to Amazon Data Lifecycle Manager. See this package's package overview docs for details on the service.

DLM methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *DLM

New creates a new instance of the DLM client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a DLM client from just a session.
svc := dlm.New(mySession)

// Create a DLM client with additional configuration
svc := dlm.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*DLM) CreateLifecyclePolicy 

func (c *DLM) CreateLifecyclePolicy(input *CreateLifecyclePolicyInput) (*CreateLifecyclePolicyOutput, error)

CreateLifecyclePolicy API operation for Amazon Data Lifecycle Manager.

Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data Lifecycle Manager supports the following policy types:

  • Custom EBS snapshot policy

  • Custom EBS-backed AMI policy

  • Cross-account copy event policy

  • Default policy for EBS snapshots

  • Default policy for EBS-backed AMIs

For more information, see Default policies vs custom policies (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/policy-differences.html).

If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation CreateLifecyclePolicy for usage and error information.

Returned Error Types:

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

  • LimitExceededException The request failed because a limit was exceeded.

  • InternalServerException The service failed in an unexpected way.

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CreateLifecyclePolicy

func (*DLM) CreateLifecyclePolicyRequest 

func (c *DLM) CreateLifecyclePolicyRequest(input *CreateLifecyclePolicyInput) (req *request.Request, output *CreateLifecyclePolicyOutput)

CreateLifecyclePolicyRequest generates a "aws/request.Request" representing the client's request for the CreateLifecyclePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLifecyclePolicy for more information on using the CreateLifecyclePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateLifecyclePolicyRequest method.
req, resp := client.CreateLifecyclePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CreateLifecyclePolicy

func (*DLM) CreateLifecyclePolicyWithContext 

func (c *DLM) CreateLifecyclePolicyWithContext(ctx aws.Context, input *CreateLifecyclePolicyInput, opts ...request.Option) (*CreateLifecyclePolicyOutput, error)

CreateLifecyclePolicyWithContext is the same as CreateLifecyclePolicy with the addition of the ability to pass a context and additional request options.

See CreateLifecyclePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DLM) DeleteLifecyclePolicy 

func (c *DLM) DeleteLifecyclePolicy(input *DeleteLifecyclePolicyInput) (*DeleteLifecyclePolicyOutput, error)

DeleteLifecyclePolicy API operation for Amazon Data Lifecycle Manager.

Deletes the specified lifecycle policy and halts the automated operations that the policy specified.

For more information about deleting a policy, see Delete lifecycle policies (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/view-modify-delete.html#delete).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation DeleteLifecyclePolicy for usage and error information.

Returned Error Types:

  • ResourceNotFoundException A requested resource was not found.

  • InternalServerException The service failed in an unexpected way.

  • LimitExceededException The request failed because a limit was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/DeleteLifecyclePolicy

func (*DLM) DeleteLifecyclePolicyRequest 

func (c *DLM) DeleteLifecyclePolicyRequest(input *DeleteLifecyclePolicyInput) (req *request.Request, output *DeleteLifecyclePolicyOutput)

DeleteLifecyclePolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteLifecyclePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLifecyclePolicy for more information on using the DeleteLifecyclePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteLifecyclePolicyRequest method.
req, resp := client.DeleteLifecyclePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/DeleteLifecyclePolicy

func (*DLM) DeleteLifecyclePolicyWithContext 

func (c *DLM) DeleteLifecyclePolicyWithContext(ctx aws.Context, input *DeleteLifecyclePolicyInput, opts ...request.Option) (*DeleteLifecyclePolicyOutput, error)

DeleteLifecyclePolicyWithContext is the same as DeleteLifecyclePolicy with the addition of the ability to pass a context and additional request options.

See DeleteLifecyclePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DLM) GetLifecyclePolicies 

func (c *DLM) GetLifecyclePolicies(input *GetLifecyclePoliciesInput) (*GetLifecyclePoliciesOutput, error)

GetLifecyclePolicies API operation for Amazon Data Lifecycle Manager.

Gets summary information about all or the specified data lifecycle policies.

To get complete information about a policy, use GetLifecyclePolicy (https://docs.aws.amazon.com/dlm/latest/APIReference/API_GetLifecyclePolicy.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation GetLifecyclePolicies for usage and error information.

Returned Error Types:

  • ResourceNotFoundException A requested resource was not found.

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

  • InternalServerException The service failed in an unexpected way.

  • LimitExceededException The request failed because a limit was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/GetLifecyclePolicies

func (*DLM) GetLifecyclePoliciesRequest 

func (c *DLM) GetLifecyclePoliciesRequest(input *GetLifecyclePoliciesInput) (req *request.Request, output *GetLifecyclePoliciesOutput)

GetLifecyclePoliciesRequest generates a "aws/request.Request" representing the client's request for the GetLifecyclePolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLifecyclePolicies for more information on using the GetLifecyclePolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetLifecyclePoliciesRequest method.
req, resp := client.GetLifecyclePoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/GetLifecyclePolicies

func (*DLM) GetLifecyclePoliciesWithContext 

func (c *DLM) GetLifecyclePoliciesWithContext(ctx aws.Context, input *GetLifecyclePoliciesInput, opts ...request.Option) (*GetLifecyclePoliciesOutput, error)

GetLifecyclePoliciesWithContext is the same as GetLifecyclePolicies with the addition of the ability to pass a context and additional request options.

See GetLifecyclePolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DLM) GetLifecyclePolicy 

func (c *DLM) GetLifecyclePolicy(input *GetLifecyclePolicyInput) (*GetLifecyclePolicyOutput, error)

GetLifecyclePolicy API operation for Amazon Data Lifecycle Manager.

Gets detailed information about the specified lifecycle policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation GetLifecyclePolicy for usage and error information.

Returned Error Types:

  • ResourceNotFoundException A requested resource was not found.

  • InternalServerException The service failed in an unexpected way.

  • LimitExceededException The request failed because a limit was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/GetLifecyclePolicy

func (*DLM) GetLifecyclePolicyRequest 

func (c *DLM) GetLifecyclePolicyRequest(input *GetLifecyclePolicyInput) (req *request.Request, output *GetLifecyclePolicyOutput)

GetLifecyclePolicyRequest generates a "aws/request.Request" representing the client's request for the GetLifecyclePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLifecyclePolicy for more information on using the GetLifecyclePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetLifecyclePolicyRequest method.
req, resp := client.GetLifecyclePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/GetLifecyclePolicy

func (*DLM) GetLifecyclePolicyWithContext 

func (c *DLM) GetLifecyclePolicyWithContext(ctx aws.Context, input *GetLifecyclePolicyInput, opts ...request.Option) (*GetLifecyclePolicyOutput, error)

GetLifecyclePolicyWithContext is the same as GetLifecyclePolicy with the addition of the ability to pass a context and additional request options.

See GetLifecyclePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DLM) ListTagsForResource added in v1.25.34 

func (c *DLM) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Data Lifecycle Manager.

Lists the tags for the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InternalServerException The service failed in an unexpected way.

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

  • ResourceNotFoundException A requested resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/ListTagsForResource

func (*DLM) ListTagsForResourceRequest added in v1.25.34 

func (c *DLM) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/ListTagsForResource

func (*DLM) ListTagsForResourceWithContext added in v1.25.34 

func (c *DLM) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DLM) TagResource added in v1.25.34 

func (c *DLM) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Data Lifecycle Manager.

Adds the specified tags to the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation TagResource for usage and error information.

Returned Error Types:

  • InternalServerException The service failed in an unexpected way.

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

  • ResourceNotFoundException A requested resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/TagResource

func (*DLM) TagResourceRequest added in v1.25.34 

func (c *DLM) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/TagResource

func (*DLM) TagResourceWithContext added in v1.25.34 

func (c *DLM) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DLM) UntagResource added in v1.25.34 

func (c *DLM) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Data Lifecycle Manager.

Removes the specified tags from the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation UntagResource for usage and error information.

Returned Error Types:

  • InternalServerException The service failed in an unexpected way.

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

  • ResourceNotFoundException A requested resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/UntagResource

func (*DLM) UntagResourceRequest added in v1.25.34 

func (c *DLM) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/UntagResource

func (*DLM) UntagResourceWithContext added in v1.25.34 

func (c *DLM) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DLM) UpdateLifecyclePolicy 

func (c *DLM) UpdateLifecyclePolicy(input *UpdateLifecyclePolicyInput) (*UpdateLifecyclePolicyOutput, error)

UpdateLifecyclePolicy API operation for Amazon Data Lifecycle Manager.

Updates the specified lifecycle policy.

For more information about updating a policy, see Modify lifecycle policies (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/view-modify-delete.html#modify).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation UpdateLifecyclePolicy for usage and error information.

Returned Error Types:

  • ResourceNotFoundException A requested resource was not found.

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

  • InternalServerException The service failed in an unexpected way.

  • LimitExceededException The request failed because a limit was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/UpdateLifecyclePolicy

func (*DLM) UpdateLifecyclePolicyRequest 

func (c *DLM) UpdateLifecyclePolicyRequest(input *UpdateLifecyclePolicyInput) (req *request.Request, output *UpdateLifecyclePolicyOutput)

UpdateLifecyclePolicyRequest generates a "aws/request.Request" representing the client's request for the UpdateLifecyclePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateLifecyclePolicy for more information on using the UpdateLifecyclePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateLifecyclePolicyRequest method.
req, resp := client.UpdateLifecyclePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/UpdateLifecyclePolicy

func (*DLM) UpdateLifecyclePolicyWithContext 

func (c *DLM) UpdateLifecyclePolicyWithContext(ctx aws.Context, input *UpdateLifecyclePolicyInput, opts ...request.Option) (*UpdateLifecyclePolicyOutput, error)

UpdateLifecyclePolicyWithContext is the same as UpdateLifecyclePolicy with the addition of the ability to pass a context and additional request options.

See UpdateLifecyclePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type DeleteLifecyclePolicyInput 

type DeleteLifecyclePolicyInput struct {

	// The identifier of the lifecycle policy.
	//
	// PolicyId is a required field
	PolicyId *string `location:"uri" locationName:"policyId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLifecyclePolicyInput) GoString 

func (s DeleteLifecyclePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLifecyclePolicyInput) SetPolicyId 

func (s *DeleteLifecyclePolicyInput) SetPolicyId(v string) *DeleteLifecyclePolicyInput

SetPolicyId sets the PolicyId field's value.

func (DeleteLifecyclePolicyInput) String 

func (s DeleteLifecyclePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLifecyclePolicyInput) Validate 

func (s *DeleteLifecyclePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteLifecyclePolicyOutput 

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

func (DeleteLifecyclePolicyOutput) GoString 

func (s DeleteLifecyclePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLifecyclePolicyOutput) String 

func (s DeleteLifecyclePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeprecateRule added in v1.40.28 

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 *int64 `min:"1" type:"integer"`

	// 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 *int64 `min:"1" type:"integer"`

	// The unit of time in which to measure the Interval.
	IntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
	// contains filtered or unexported fields
}

[Custom AMI policies only] Specifies an AMI deprecation rule for AMIs created by an AMI lifecycle policy.

For age-based schedules, you must specify Interval and IntervalUnit. For count-based schedules, you must specify Count.

func (DeprecateRule) GoString added in v1.40.28 

func (s DeprecateRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeprecateRule) SetCount added in v1.40.28 

func (s *DeprecateRule) SetCount(v int64) *DeprecateRule

SetCount sets the Count field's value.

func (*DeprecateRule) SetInterval added in v1.40.28 

func (s *DeprecateRule) SetInterval(v int64) *DeprecateRule

SetInterval sets the Interval field's value.

func (*DeprecateRule) SetIntervalUnit added in v1.40.28 

func (s *DeprecateRule) SetIntervalUnit(v string) *DeprecateRule

SetIntervalUnit sets the IntervalUnit field's value.

func (DeprecateRule) String added in v1.40.28 

func (s DeprecateRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeprecateRule) Validate added in v1.40.28 

func (s *DeprecateRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EncryptionConfiguration added in v1.36.11 

type EncryptionConfiguration struct {

	// 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 `type:"string"`

	// 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.
	//
	// Encrypted is a required field
	Encrypted *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

[Event-based policies only] Specifies the encryption settings for cross-Region snapshot copies created by event-based policies.

func (EncryptionConfiguration) GoString added in v1.36.11 

func (s EncryptionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionConfiguration) SetCmkArn added in v1.36.11 

func (s *EncryptionConfiguration) SetCmkArn(v string) *EncryptionConfiguration

SetCmkArn sets the CmkArn field's value.

func (*EncryptionConfiguration) SetEncrypted added in v1.36.11 

func (s *EncryptionConfiguration) SetEncrypted(v bool) *EncryptionConfiguration

SetEncrypted sets the Encrypted field's value.

func (EncryptionConfiguration) String added in v1.36.11 

func (s EncryptionConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionConfiguration) Validate added in v1.36.11 

func (s *EncryptionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EventParameters added in v1.36.11 

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.
	//
	// DescriptionRegex is a required field
	DescriptionRegex *string `type:"string" required:"true"`

	// The type of event. Currently, only snapshot sharing events are supported.
	//
	// EventType is a required field
	EventType *string `type:"string" required:"true" enum:"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.
	//
	// SnapshotOwner is a required field
	SnapshotOwner []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

[Event-based policies only] Specifies an event that activates an event-based policy.

func (EventParameters) GoString added in v1.36.11 

func (s EventParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventParameters) SetDescriptionRegex added in v1.36.11 

func (s *EventParameters) SetDescriptionRegex(v string) *EventParameters

SetDescriptionRegex sets the DescriptionRegex field's value.

func (*EventParameters) SetEventType added in v1.36.11 

func (s *EventParameters) SetEventType(v string) *EventParameters

SetEventType sets the EventType field's value.

func (*EventParameters) SetSnapshotOwner added in v1.36.11 

func (s *EventParameters) SetSnapshotOwner(v []*string) *EventParameters

SetSnapshotOwner sets the SnapshotOwner field's value.

func (EventParameters) String added in v1.36.11 

func (s EventParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventParameters) Validate added in v1.36.11 

func (s *EventParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EventSource added in v1.36.11 

type EventSource struct {

	// Information about the event.
	Parameters *EventParameters `type:"structure"`

	// The source of the event. Currently only managed CloudWatch Events rules are
	// supported.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"EventSourceValues"`
	// contains filtered or unexported fields
}

[Event-based policies only] Specifies an event that activates an event-based policy.

func (EventSource) GoString added in v1.36.11 

func (s EventSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventSource) SetParameters added in v1.36.11 

func (s *EventSource) SetParameters(v *EventParameters) *EventSource

SetParameters sets the Parameters field's value.

func (*EventSource) SetType added in v1.36.11 

func (s *EventSource) SetType(v string) *EventSource

SetType sets the Type field's value.

func (EventSource) String added in v1.36.11 

func (s EventSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventSource) Validate added in v1.36.11 

func (s *EventSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Exclusions added in v1.47.13 

type Exclusions struct {

	// [Default policies for EBS snapshots only] Indicates whether to exclude volumes
	// that are attached to instances as the boot volume. If you exclude boot volumes,
	// only volumes attached as data (non-boot) volumes will be backed up by the
	// policy. To exclude boot volumes, specify true.
	ExcludeBootVolumes *bool `type:"boolean"`

	// [Default policies for EBS-backed AMIs only] Specifies whether to exclude
	// volumes that have specific tags.
	ExcludeTags []*Tag `type:"list"`

	// [Default policies for EBS snapshots only] Specifies the volume types to exclude.
	// Volumes of the specified types will not be targeted by the policy.
	ExcludeVolumeTypes []*string `type:"list"`
	// contains filtered or unexported fields
}

[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.

func (Exclusions) GoString added in v1.47.13 

func (s Exclusions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Exclusions) SetExcludeBootVolumes added in v1.47.13 

func (s *Exclusions) SetExcludeBootVolumes(v bool) *Exclusions

SetExcludeBootVolumes sets the ExcludeBootVolumes field's value.

func (*Exclusions) SetExcludeTags added in v1.47.13 

func (s *Exclusions) SetExcludeTags(v []*Tag) *Exclusions

SetExcludeTags sets the ExcludeTags field's value.

func (*Exclusions) SetExcludeVolumeTypes added in v1.47.13 

func (s *Exclusions) SetExcludeVolumeTypes(v []*string) *Exclusions

SetExcludeVolumeTypes sets the ExcludeVolumeTypes field's value.

func (Exclusions) String added in v1.47.13 

func (s Exclusions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Exclusions) Validate added in v1.47.13 

func (s *Exclusions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FastRestoreRule added in v1.25.39 

type FastRestoreRule struct {

	// The Availability Zones in which to enable fast snapshot restore.
	//
	// AvailabilityZones is a required field
	AvailabilityZones []*string `min:"1" type:"list" required:"true"`

	// The number of snapshots to be enabled with fast snapshot restore.
	Count *int64 `min:"1" type:"integer"`

	// 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 *int64 `min:"1" type:"integer"`

	// The unit of time for enabling fast snapshot restore.
	IntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
	// contains filtered or unexported fields
}

[Custom snapshot policies only] Specifies a rule for enabling fast snapshot restore for snapshots created by snapshot policies. You can enable fast snapshot restore based on either a count or a time interval.

func (FastRestoreRule) GoString added in v1.25.39 

func (s FastRestoreRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FastRestoreRule) SetAvailabilityZones added in v1.25.39 

func (s *FastRestoreRule) SetAvailabilityZones(v []*string) *FastRestoreRule

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*FastRestoreRule) SetCount added in v1.25.39 

func (s *FastRestoreRule) SetCount(v int64) *FastRestoreRule

SetCount sets the Count field's value.

func (*FastRestoreRule) SetInterval added in v1.25.42 

func (s *FastRestoreRule) SetInterval(v int64) *FastRestoreRule

SetInterval sets the Interval field's value.

func (*FastRestoreRule) SetIntervalUnit added in v1.25.42 

func (s *FastRestoreRule) SetIntervalUnit(v string) *FastRestoreRule

SetIntervalUnit sets the IntervalUnit field's value.

func (FastRestoreRule) String added in v1.25.39 

func (s FastRestoreRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FastRestoreRule) Validate added in v1.25.39 

func (s *FastRestoreRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLifecyclePoliciesInput 

type GetLifecyclePoliciesInput struct {

	// [Default policies only] Specifies the type of default policy to get. Specify
	// one of the following:
	//
	//    * VOLUME - To get only the default policy for EBS snapshots
	//
	//    * INSTANCE - To get only the default policy for EBS-backed AMIs
	//
	//    * ALL - To get all default policies
	DefaultPolicyType *string `location:"querystring" locationName:"defaultPolicyType" type:"string" enum:"DefaultPoliciesTypeValues"`

	// The identifiers of the data lifecycle policies.
	PolicyIds []*string `location:"querystring" locationName:"policyIds" type:"list"`

	// The resource type.
	ResourceTypes []*string `location:"querystring" locationName:"resourceTypes" min:"1" type:"list" enum:"ResourceTypeValues"`

	// The activation state.
	State *string `location:"querystring" locationName:"state" type:"string" enum:"GettablePolicyStateValues"`

	// The tags to add to objects created by the policy.
	//
	// Tags are strings in the format key=value.
	//
	// These user-defined tags are added in addition to the Amazon Web Services-added
	// lifecycle tags.
	TagsToAdd []*string `location:"querystring" locationName:"tagsToAdd" type:"list"`

	// The target tag for a policy.
	//
	// Tags are strings in the format key=value.
	TargetTags []*string `location:"querystring" locationName:"targetTags" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (GetLifecyclePoliciesInput) GoString 

func (s GetLifecyclePoliciesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLifecyclePoliciesInput) SetDefaultPolicyType added in v1.47.13 

func (s *GetLifecyclePoliciesInput) SetDefaultPolicyType(v string) *GetLifecyclePoliciesInput

SetDefaultPolicyType sets the DefaultPolicyType field's value.

func (*GetLifecyclePoliciesInput) SetPolicyIds 

func (s *GetLifecyclePoliciesInput) SetPolicyIds(v []*string) *GetLifecyclePoliciesInput

SetPolicyIds sets the PolicyIds field's value.

func (*GetLifecyclePoliciesInput) SetResourceTypes 

func (s *GetLifecyclePoliciesInput) SetResourceTypes(v []*string) *GetLifecyclePoliciesInput

SetResourceTypes sets the ResourceTypes field's value.

func (*GetLifecyclePoliciesInput) SetState 

func (s *GetLifecyclePoliciesInput) SetState(v string) *GetLifecyclePoliciesInput

SetState sets the State field's value.

func (*GetLifecyclePoliciesInput) SetTagsToAdd 

func (s *GetLifecyclePoliciesInput) SetTagsToAdd(v []*string) *GetLifecyclePoliciesInput

SetTagsToAdd sets the TagsToAdd field's value.

func (*GetLifecyclePoliciesInput) SetTargetTags 

func (s *GetLifecyclePoliciesInput) SetTargetTags(v []*string) *GetLifecyclePoliciesInput

SetTargetTags sets the TargetTags field's value.

func (GetLifecyclePoliciesInput) String 

func (s GetLifecyclePoliciesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLifecyclePoliciesInput) Validate 

func (s *GetLifecyclePoliciesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLifecyclePoliciesOutput 

type GetLifecyclePoliciesOutput struct {

	// Summary information about the lifecycle policies.
	Policies []*LifecyclePolicySummary `type:"list"`
	// contains filtered or unexported fields
}

func (GetLifecyclePoliciesOutput) GoString 

func (s GetLifecyclePoliciesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLifecyclePoliciesOutput) SetPolicies 

func (s *GetLifecyclePoliciesOutput) SetPolicies(v []*LifecyclePolicySummary) *GetLifecyclePoliciesOutput

SetPolicies sets the Policies field's value.

func (GetLifecyclePoliciesOutput) String 

func (s GetLifecyclePoliciesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLifecyclePolicyInput 

type GetLifecyclePolicyInput struct {

	// The identifier of the lifecycle policy.
	//
	// PolicyId is a required field
	PolicyId *string `location:"uri" locationName:"policyId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetLifecyclePolicyInput) GoString 

func (s GetLifecyclePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLifecyclePolicyInput) SetPolicyId 

func (s *GetLifecyclePolicyInput) SetPolicyId(v string) *GetLifecyclePolicyInput

SetPolicyId sets the PolicyId field's value.

func (GetLifecyclePolicyInput) String 

func (s GetLifecyclePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLifecyclePolicyInput) Validate 

func (s *GetLifecyclePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLifecyclePolicyOutput 

type GetLifecyclePolicyOutput struct {

	// Detailed information about the lifecycle policy.
	Policy *LifecyclePolicy `type:"structure"`
	// contains filtered or unexported fields
}

func (GetLifecyclePolicyOutput) GoString 

func (s GetLifecyclePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLifecyclePolicyOutput) SetPolicy 

func (s *GetLifecyclePolicyOutput) SetPolicy(v *LifecyclePolicy) *GetLifecyclePolicyOutput

SetPolicy sets the Policy field's value.

func (GetLifecyclePolicyOutput) String 

func (s GetLifecyclePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException added in v1.28.0 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The service failed in an unexpected way.

func (*InternalServerException) Code added in v1.28.0 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error added in v1.28.0 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString added in v1.28.0 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message added in v1.28.0 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr added in v1.28.0 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID added in v1.28.0 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode added in v1.28.0 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String added in v1.28.0 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException added in v1.28.0 

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	// The request included parameters that cannot be provided together.
	MutuallyExclusiveParameters []*string `type:"list"`

	// The request omitted one or more required parameters.
	RequiredParameters []*string `type:"list"`
	// contains filtered or unexported fields
}

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

func (*InvalidRequestException) Code added in v1.28.0 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0 

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message added in v1.28.0 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0 

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LifecyclePolicy 

type LifecyclePolicy struct {

	// The local date and time when the lifecycle policy was created.
	DateCreated *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The local date and time when the lifecycle policy was last modified.
	DateModified *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// [Default policies only] The type of default policy. Values include:
	//
	//    * VOLUME - Default policy for EBS snapshots
	//
	//    * INSTANCE - Default policy for EBS-backed AMIs
	DefaultPolicy *bool `type:"boolean"`

	// The description of the lifecycle policy.
	Description *string `type:"string"`

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

	// The Amazon Resource Name (ARN) of the policy.
	PolicyArn *string `type:"string"`

	// The configuration of the lifecycle policy
	PolicyDetails *PolicyDetails `type:"structure"`

	// The identifier of the lifecycle policy.
	PolicyId *string `type:"string"`

	// The activation state of the lifecycle policy.
	State *string `type:"string" enum:"GettablePolicyStateValues"`

	// The description of the status.
	StatusMessage *string `type:"string"`

	// The tags.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

[Custom policies only] Detailed information about a snapshot, AMI, or event-based lifecycle policy.

func (LifecyclePolicy) GoString 

func (s LifecyclePolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LifecyclePolicy) SetDateCreated 

func (s *LifecyclePolicy) SetDateCreated(v time.Time) *LifecyclePolicy

SetDateCreated sets the DateCreated field's value.

func (*LifecyclePolicy) SetDateModified 

func (s *LifecyclePolicy) SetDateModified(v time.Time) *LifecyclePolicy

SetDateModified sets the DateModified field's value.

func (*LifecyclePolicy) SetDefaultPolicy added in v1.47.13 

func (s *LifecyclePolicy) SetDefaultPolicy(v bool) *LifecyclePolicy

SetDefaultPolicy sets the DefaultPolicy field's value.

func (*LifecyclePolicy) SetDescription 

func (s *LifecyclePolicy) SetDescription(v string) *LifecyclePolicy

SetDescription sets the Description field's value.

func (*LifecyclePolicy) SetExecutionRoleArn 

func (s *LifecyclePolicy) SetExecutionRoleArn(v string) *LifecyclePolicy

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*LifecyclePolicy) SetPolicyArn added in v1.25.34 

func (s *LifecyclePolicy) SetPolicyArn(v string) *LifecyclePolicy

SetPolicyArn sets the PolicyArn field's value.

func (*LifecyclePolicy) SetPolicyDetails 

func (s *LifecyclePolicy) SetPolicyDetails(v *PolicyDetails) *LifecyclePolicy

SetPolicyDetails sets the PolicyDetails field's value.

func (*LifecyclePolicy) SetPolicyId 

func (s *LifecyclePolicy) SetPolicyId(v string) *LifecyclePolicy

SetPolicyId sets the PolicyId field's value.

func (*LifecyclePolicy) SetState 

func (s *LifecyclePolicy) SetState(v string) *LifecyclePolicy

SetState sets the State field's value.

func (*LifecyclePolicy) SetStatusMessage added in v1.25.34 

func (s *LifecyclePolicy) SetStatusMessage(v string) *LifecyclePolicy

SetStatusMessage sets the StatusMessage field's value.

func (*LifecyclePolicy) SetTags added in v1.25.34 

func (s *LifecyclePolicy) SetTags(v map[string]*string) *LifecyclePolicy

SetTags sets the Tags field's value.

func (LifecyclePolicy) String 

func (s LifecyclePolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LifecyclePolicySummary 

type LifecyclePolicySummary struct {

	// [Default policies only] The type of default policy. Values include:
	//
	//    * VOLUME - Default policy for EBS snapshots
	//
	//    * INSTANCE - Default policy for EBS-backed AMIs
	DefaultPolicy *bool `type:"boolean"`

	// The description of the lifecycle policy.
	Description *string `type:"string"`

	// The identifier of the lifecycle policy.
	PolicyId *string `type:"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. EVENT_BASED_POLICY indicates
	// that the policy automates cross-account snapshot copies for snapshots that
	// are shared with your account.
	PolicyType *string `type:"string" enum:"PolicyTypeValues"`

	// The activation state of the lifecycle policy.
	State *string `type:"string" enum:"GettablePolicyStateValues"`

	// The tags.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

Summary information about a lifecycle policy.

func (LifecyclePolicySummary) GoString 

func (s LifecyclePolicySummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LifecyclePolicySummary) SetDefaultPolicy added in v1.47.13 

func (s *LifecyclePolicySummary) SetDefaultPolicy(v bool) *LifecyclePolicySummary

SetDefaultPolicy sets the DefaultPolicy field's value.

func (*LifecyclePolicySummary) SetDescription 

func (s *LifecyclePolicySummary) SetDescription(v string) *LifecyclePolicySummary

SetDescription sets the Description field's value.

func (*LifecyclePolicySummary) SetPolicyId 

func (s *LifecyclePolicySummary) SetPolicyId(v string) *LifecyclePolicySummary

SetPolicyId sets the PolicyId field's value.

func (*LifecyclePolicySummary) SetPolicyType added in v1.35.23 

func (s *LifecyclePolicySummary) SetPolicyType(v string) *LifecyclePolicySummary

SetPolicyType sets the PolicyType field's value.

func (*LifecyclePolicySummary) SetState 

func (s *LifecyclePolicySummary) SetState(v string) *LifecyclePolicySummary

SetState sets the State field's value.

func (*LifecyclePolicySummary) SetTags added in v1.25.34 

func (s *LifecyclePolicySummary) SetTags(v map[string]*string) *LifecyclePolicySummary

SetTags sets the Tags field's value.

func (LifecyclePolicySummary) String 

func (s LifecyclePolicySummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	// Value is the type of resource for which a limit was exceeded.
	ResourceType *string `type:"string"`
	// contains filtered or unexported fields
}

The request failed because a limit was exceeded.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.25.34 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.25.34 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn added in v1.25.34 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.25.34 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.25.34 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.25.34 

type ListTagsForResourceOutput struct {

	// Information about the tags.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.25.34 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.25.34 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.25.34 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Parameters added in v1.19.40 

type Parameters struct {

	// [Custom snapshot policies that target instances only] Indicates whether to
	// exclude the root volume from multi-volume snapshot sets. The default is false.
	// If you specify true, then the root volumes attached to targeted instances
	// will be excluded from the multi-volume snapshot sets created by the policy.
	ExcludeBootVolume *bool `type:"boolean"`

	// [Custom snapshot policies that target instances only] The tags used to identify
	// data (non-root) volumes to exclude from multi-volume snapshot sets.
	//
	// If you create a snapshot lifecycle policy that targets instances and you
	// specify tags for this parameter, then data volumes with the specified tags
	// that are attached to targeted instances will be excluded from the multi-volume
	// snapshot sets created by the policy.
	ExcludeDataVolumeTags []*Tag `type:"list"`

	// [Custom AMI 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 `type:"boolean"`
	// contains filtered or unexported fields
}

[Custom snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies. The set of valid parameters depends on the combination of policy type and target resource type.

If you choose to exclude boot volumes and you specify tags that consequently exclude all of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create any snapshots for the affected instance, and it will emit a SnapshotsCreateFailed Amazon CloudWatch metric. For more information, see Monitor your policies using Amazon CloudWatch (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitor-dlm-cw-metrics.html).

func (Parameters) GoString added in v1.19.40 

func (s Parameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Parameters) SetExcludeBootVolume added in v1.19.40 

func (s *Parameters) SetExcludeBootVolume(v bool) *Parameters

SetExcludeBootVolume sets the ExcludeBootVolume field's value.

func (*Parameters) SetExcludeDataVolumeTags added in v1.44.73 

func (s *Parameters) SetExcludeDataVolumeTags(v []*Tag) *Parameters

SetExcludeDataVolumeTags sets the ExcludeDataVolumeTags field's value.

func (*Parameters) SetNoReboot added in v1.35.23 

func (s *Parameters) SetNoReboot(v bool) *Parameters

SetNoReboot sets the NoReboot field's value.

func (Parameters) String added in v1.19.40 

func (s Parameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Parameters) Validate added in v1.44.73 

func (s *Parameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PolicyDetails 

type PolicyDetails struct {

	// [Event-based policies only] The actions to be performed when the event-based
	// policy is activated. You can specify only one action per policy.
	Actions []*Action `min:"1" type:"list"`

	// [Default policies only] Indicates whether the policy should copy tags from
	// the source resource to the snapshot or AMI. If you do not specify a value,
	// the default is false.
	//
	// Default: false
	CopyTags *bool `type:"boolean"`

	// [Default policies only] Specifies how often the policy should run and create
	// snapshots or AMIs. The creation frequency can range from 1 to 7 days. If
	// you do not specify a value, the default is 1.
	//
	// Default: 1
	CreateInterval *int64 `min:"1" type:"integer"`

	// [Default policies only] Specifies destination Regions for snapshot or AMI
	// copies. You can specify up to 3 destination Regions. If you do not want to
	// create cross-Region copies, omit this parameter.
	CrossRegionCopyTargets []*CrossRegionCopyTarget `type:"list"`

	// [Event-based policies only] The event that activates the event-based policy.
	EventSource *EventSource `type:"structure"`

	// [Default policies only] Specifies exclusion parameters for volumes or instances
	// for which you do not want to create snapshots or AMIs. The policy will not
	// create snapshots or AMIs for target resources that match any of the specified
	// exclusion parameters.
	Exclusions *Exclusions `type:"structure"`

	// [Default policies only] Defines the snapshot or AMI retention behavior for
	// the policy if the source volume or instance is deleted, or if the policy
	// enters the error, disabled, or deleted state.
	//
	// By default (ExtendDeletion=false):
	//
	//    * If a source resource is deleted, Amazon Data Lifecycle Manager will
	//    continue to delete previously created snapshots or AMIs, up to but not
	//    including the last one, based on the specified retention period. If you
	//    want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including
	//    the last one, specify true.
	//
	//    * If a policy enters the error, disabled, or deleted state, Amazon Data
	//    Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon
	//    Data Lifecycle Manager to continue deleting snapshots or AMIs, including
	//    the last one, if the policy enters one of these states, specify true.
	//
	// If you enable extended deletion (ExtendDeletion=true), you override both
	// default behaviors simultaneously.
	//
	// If you do not specify a value, the default is false.
	//
	// Default: false
	ExtendDeletion *bool `type:"boolean"`

	// [Custom snapshot and AMI policies only] A set of optional parameters for
	// snapshot and AMI lifecycle policies.
	//
	// If you are modifying a policy that was created or previously modified using
	// the Amazon Data Lifecycle Manager console, then you must include this parameter
	// and specify either the default values or the new values that you require.
	// You can't omit this parameter or set its values to null.
	Parameters *Parameters `type:"structure"`

	// The type of policy to create. Specify one of the following:
	//
	//    * SIMPLIFIED To create a default policy.
	//
	//    * STANDARD To create a custom policy.
	PolicyLanguage *string `type:"string" enum:"PolicyLanguageValues"`

	// [Custom policies only] 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 *string `type:"string" enum:"PolicyTypeValues"`

	// [Custom snapshot and AMI policies only] 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 []*string `min:"1" type:"list" enum:"ResourceLocationValues"`

	// [Default policies only] Specify the type of default policy to create.
	//
	//    * To create a default policy for EBS snapshots, that creates snapshots
	//    of all volumes in the Region that do not have recent backups, specify
	//    VOLUME.
	//
	//    * To create a default policy for EBS-backed AMIs, that creates EBS-backed
	//    AMIs from all instances in the Region that do not have recent backups,
	//    specify INSTANCE.
	ResourceType *string `type:"string" enum:"ResourceTypeValues"`

	// [Custom snapshot policies only] 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.
	ResourceTypes []*string `min:"1" type:"list" enum:"ResourceTypeValues"`

	// [Default policies only] Specifies how long the policy should retain snapshots
	// or AMIs before deleting them. The retention period can range from 2 to 14
	// days, but it must be greater than the creation frequency to ensure that the
	// policy retains at least 1 snapshot or AMI at any given time. If you do not
	// specify a value, the default is 7.
	//
	// Default: 7
	RetainInterval *int64 `min:"1" type:"integer"`

	// [Custom snapshot and AMI policies only] 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.
	Schedules []*Schedule `min:"1" type:"list"`

	// [Custom snapshot and AMI policies only] The single tag that identifies targeted
	// resources for this policy.
	TargetTags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Specifies the configuration of a lifecycle policy.

func (PolicyDetails) GoString 

func (s PolicyDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PolicyDetails) SetActions added in v1.36.11 

func (s *PolicyDetails) SetActions(v []*Action) *PolicyDetails

SetActions sets the Actions field's value.

func (*PolicyDetails) SetCopyTags added in v1.47.13 

func (s *PolicyDetails) SetCopyTags(v bool) *PolicyDetails

SetCopyTags sets the CopyTags field's value.

func (*PolicyDetails) SetCreateInterval added in v1.47.13 

func (s *PolicyDetails) SetCreateInterval(v int64) *PolicyDetails

SetCreateInterval sets the CreateInterval field's value.

func (*PolicyDetails) SetCrossRegionCopyTargets added in v1.47.13 

func (s *PolicyDetails) SetCrossRegionCopyTargets(v []*CrossRegionCopyTarget) *PolicyDetails

SetCrossRegionCopyTargets sets the CrossRegionCopyTargets field's value.

func (*PolicyDetails) SetEventSource added in v1.36.11 

func (s *PolicyDetails) SetEventSource(v *EventSource) *PolicyDetails

SetEventSource sets the EventSource field's value.

func (*PolicyDetails) SetExclusions added in v1.47.13 

func (s *PolicyDetails) SetExclusions(v *Exclusions) *PolicyDetails

SetExclusions sets the Exclusions field's value.

func (*PolicyDetails) SetExtendDeletion added in v1.47.13 

func (s *PolicyDetails) SetExtendDeletion(v bool) *PolicyDetails

SetExtendDeletion sets the ExtendDeletion field's value.

func (*PolicyDetails) SetParameters added in v1.19.40 

func (s *PolicyDetails) SetParameters(v *Parameters) *PolicyDetails

SetParameters sets the Parameters field's value.

func (*PolicyDetails) SetPolicyLanguage added in v1.47.13 

func (s *PolicyDetails) SetPolicyLanguage(v string) *PolicyDetails

SetPolicyLanguage sets the PolicyLanguage field's value.

func (*PolicyDetails) SetPolicyType added in v1.19.40 

func (s *PolicyDetails) SetPolicyType(v string) *PolicyDetails

SetPolicyType sets the PolicyType field's value.

func (*PolicyDetails) SetResourceLocations added in v1.37.4 

func (s *PolicyDetails) SetResourceLocations(v []*string) *PolicyDetails

SetResourceLocations sets the ResourceLocations field's value.

func (*PolicyDetails) SetResourceType added in v1.47.13 

func (s *PolicyDetails) SetResourceType(v string) *PolicyDetails

SetResourceType sets the ResourceType field's value.

func (*PolicyDetails) SetResourceTypes 

func (s *PolicyDetails) SetResourceTypes(v []*string) *PolicyDetails

SetResourceTypes sets the ResourceTypes field's value.

func (*PolicyDetails) SetRetainInterval added in v1.47.13 

func (s *PolicyDetails) SetRetainInterval(v int64) *PolicyDetails

SetRetainInterval sets the RetainInterval field's value.

func (*PolicyDetails) SetSchedules 

func (s *PolicyDetails) SetSchedules(v []*Schedule) *PolicyDetails

SetSchedules sets the Schedules field's value.

func (*PolicyDetails) SetTargetTags 

func (s *PolicyDetails) SetTargetTags(v []*Tag) *PolicyDetails

SetTargetTags sets the TargetTags field's value.

func (PolicyDetails) String 

func (s PolicyDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PolicyDetails) Validate 

func (s *PolicyDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	// Value is a list of resource IDs that were not found.
	ResourceIds []*string `type:"list"`

	// Value is the type of resource that was not found.
	ResourceType *string `type:"string"`
	// contains filtered or unexported fields
}

A requested resource was not found.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetainRule 

type RetainRule struct {

	// The number of snapshots to retain for each volume, up to a maximum of 1000.
	// For example if you want to retain a maximum of three snapshots, specify 3.
	// When the fourth snapshot is created, the oldest retained snapshot is deleted,
	// or it is moved to the archive tier if you have specified an ArchiveRule (https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html).
	Count *int64 `type:"integer"`

	// 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 *int64 `type:"integer"`

	// The unit of time for time-based retention. For example, to retain snapshots
	// for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot
	// has been retained for 3 months, it is deleted, or it is moved to the archive
	// tier if you have specified an ArchiveRule (https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html).
	IntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
	// contains filtered or unexported fields
}

[Custom snapshot and AMI policies only] Specifies a retention rule for snapshots created by snapshot policies, or for AMIs created by AMI policies.

For snapshot policies that have an ArchiveRule (https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html), this retention rule applies to standard tier retention. When the retention threshold is met, snapshots are moved from the standard to the archive tier.

For snapshot policies that do not have an ArchiveRule, snapshots are permanently deleted when this retention threshold is met.

You can retain snapshots based on either a count or a time interval.

func (RetainRule) GoString 

func (s RetainRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetainRule) SetCount 

func (s *RetainRule) SetCount(v int64) *RetainRule

SetCount sets the Count field's value.

func (*RetainRule) SetInterval added in v1.25.42 

func (s *RetainRule) SetInterval(v int64) *RetainRule

SetInterval sets the Interval field's value.

func (*RetainRule) SetIntervalUnit added in v1.25.42 

func (s *RetainRule) SetIntervalUnit(v string) *RetainRule

SetIntervalUnit sets the IntervalUnit field's value.

func (RetainRule) String 

func (s RetainRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetentionArchiveTier added in v1.44.109 

type RetentionArchiveTier struct {

	// The maximum number of snapshots to retain in the archive storage tier for
	// each volume. The count must ensure that each snapshot remains in the archive
	// tier for at least 90 days. For example, if the schedule creates snapshots
	// every 30 days, you must specify a count of 3 or more to ensure that each
	// snapshot is archived for at least 90 days.
	Count *int64 `min:"1" type:"integer"`

	// Specifies the period of time to retain snapshots in the archive tier. After
	// this period expires, the snapshot is permanently deleted.
	Interval *int64 `min:"1" type:"integer"`

	// The unit of time in which to measure the Interval. For example, to retain
	// a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
	IntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
	// contains filtered or unexported fields
}

[Custom snapshot policies only] Describes the retention rule for archived snapshots. Once the archive retention threshold is met, the snapshots are permanently deleted from the archive tier.

The archive retention rule must retain snapshots in the archive tier for a minimum of 90 days.

For count-based schedules, you must specify Count. For age-based schedules, you must specify Interval and IntervalUnit.

For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive).

func (RetentionArchiveTier) GoString added in v1.44.109 

func (s RetentionArchiveTier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetentionArchiveTier) SetCount added in v1.44.109 

func (s *RetentionArchiveTier) SetCount(v int64) *RetentionArchiveTier

SetCount sets the Count field's value.

func (*RetentionArchiveTier) SetInterval added in v1.44.109 

func (s *RetentionArchiveTier) SetInterval(v int64) *RetentionArchiveTier

SetInterval sets the Interval field's value.

func (*RetentionArchiveTier) SetIntervalUnit added in v1.44.109 

func (s *RetentionArchiveTier) SetIntervalUnit(v string) *RetentionArchiveTier

SetIntervalUnit sets the IntervalUnit field's value.

func (RetentionArchiveTier) String added in v1.44.109 

func (s RetentionArchiveTier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetentionArchiveTier) Validate added in v1.44.109 

func (s *RetentionArchiveTier) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Schedule 

type Schedule struct {

	// [Custom snapshot policies that target volumes only] The snapshot archiving
	// rule for the schedule. When you specify an archiving rule, snapshots are
	// automatically moved from the standard tier to the archive tier once the schedule's
	// retention threshold is met. Snapshots are then retained in the archive tier
	// for the archive retention period that you specify.
	//
	// For more information about using snapshot archiving, see Considerations for
	// snapshot lifecycle policies (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive).
	ArchiveRule *ArchiveRule `type:"structure"`

	// Copy all user-defined tags on a source volume to snapshots of the volume
	// created by this policy.
	CopyTags *bool `type:"boolean"`

	// The creation rule.
	CreateRule *CreateRule `type:"structure"`

	// Specifies a rule for copying snapshots or AMIs across regions.
	//
	// You can't specify cross-Region copy rules for policies that create snapshots
	// on an Outpost. If the policy creates snapshots in a Region, then snapshots
	// can be copied to up to three Regions or Outposts.
	CrossRegionCopyRules []*CrossRegionCopyRule `type:"list"`

	// [Custom AMI policies only] The AMI deprecation rule for the schedule.
	DeprecateRule *DeprecateRule `type:"structure"`

	// [Custom snapshot policies only] The rule for enabling fast snapshot restore.
	FastRestoreRule *FastRestoreRule `type:"structure"`

	// The name of the schedule.
	Name *string `type:"string"`

	// The retention rule for snapshots or AMIs created by the policy.
	RetainRule *RetainRule `type:"structure"`

	// [Custom snapshot policies only] The rule for sharing snapshots with other
	// Amazon Web Services accounts.
	ShareRules []*ShareRule `type:"list"`

	// 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 `type:"list"`

	// [AMI policies and snapshot policies that target instances only] 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 `type:"list"`
	// contains filtered or unexported fields
}

[Custom snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.

func (Schedule) GoString 

func (s Schedule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Schedule) SetArchiveRule added in v1.44.109 

func (s *Schedule) SetArchiveRule(v *ArchiveRule) *Schedule

SetArchiveRule sets the ArchiveRule field's value.

func (*Schedule) SetCopyTags added in v1.15.72 

func (s *Schedule) SetCopyTags(v bool) *Schedule

SetCopyTags sets the CopyTags field's value.

func (*Schedule) SetCreateRule 

func (s *Schedule) SetCreateRule(v *CreateRule) *Schedule

SetCreateRule sets the CreateRule field's value.

func (*Schedule) SetCrossRegionCopyRules added in v1.26.6 

func (s *Schedule) SetCrossRegionCopyRules(v []*CrossRegionCopyRule) *Schedule

SetCrossRegionCopyRules sets the CrossRegionCopyRules field's value.

func (*Schedule) SetDeprecateRule added in v1.40.28 

func (s *Schedule) SetDeprecateRule(v *DeprecateRule) *Schedule

SetDeprecateRule sets the DeprecateRule field's value.

func (*Schedule) SetFastRestoreRule added in v1.25.39 

func (s *Schedule) SetFastRestoreRule(v *FastRestoreRule) *Schedule

SetFastRestoreRule sets the FastRestoreRule field's value.

func (*Schedule) SetName 

func (s *Schedule) SetName(v string) *Schedule

SetName sets the Name field's value.

func (*Schedule) SetRetainRule 

func (s *Schedule) SetRetainRule(v *RetainRule) *Schedule

SetRetainRule sets the RetainRule field's value.

func (*Schedule) SetShareRules added in v1.36.11 

func (s *Schedule) SetShareRules(v []*ShareRule) *Schedule

SetShareRules sets the ShareRules field's value.

func (*Schedule) SetTagsToAdd 

func (s *Schedule) SetTagsToAdd(v []*Tag) *Schedule

SetTagsToAdd sets the TagsToAdd field's value.

func (*Schedule) SetVariableTags added in v1.19.40 

func (s *Schedule) SetVariableTags(v []*Tag) *Schedule

SetVariableTags sets the VariableTags field's value.

func (Schedule) String 

func (s Schedule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Schedule) Validate 

func (s *Schedule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Script added in v1.47.5 

type Script struct {

	// Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent
	// snapshots if the pre script fails.
	//
	//    * To default to crash consistent snapshot if the pre script fails, specify
	//    true.
	//
	//    * To skip the instance for snapshot creation if the pre script fails,
	//    specify false.
	//
	// This parameter is supported only if you run a pre script. If you run a post
	// script only, omit this parameter.
	//
	// Default: true
	ExecuteOperationOnScriptFailure *bool `type:"boolean"`

	// The SSM document that includes the pre and/or post scripts to run.
	//
	//    * If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case,
	//    Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot
	//    SSM document.
	//
	//    * If you are automating application-consistent snapshots for SAP HANA
	//    workloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA.
	//
	//    * If you are using a custom SSM document that you own, specify either
	//    the name or ARN of the SSM document. If you are using a custom SSM document
	//    that is shared with you, specify the ARN of the SSM document.
	//
	// ExecutionHandler is a required field
	ExecutionHandler *string `type:"string" required:"true"`

	// Indicates the service used to execute the pre and/or post scripts.
	//
	//    * If you are using custom SSM documents or automating application-consistent
	//    snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER.
	//
	//    * If you are automating VSS Backups, omit this parameter.
	//
	// Default: AWS_SYSTEMS_MANAGER
	ExecutionHandlerService *string `type:"string" enum:"ExecutionHandlerServiceValues"`

	// Specifies a timeout period, in seconds, after which Amazon Data Lifecycle
	// Manager fails the script run attempt if it has not completed. If a script
	// does not complete within its timeout period, Amazon Data Lifecycle Manager
	// fails the attempt. The timeout period applies to the pre and post scripts
	// individually.
	//
	// If you are automating VSS Backups, omit this parameter.
	//
	// Default: 10
	ExecutionTimeout *int64 `min:"10" type:"integer"`

	// Specifies the number of times Amazon Data Lifecycle Manager should retry
	// scripts that fail.
	//
	//    * If the pre script fails, Amazon Data Lifecycle Manager retries the entire
	//    snapshot creation process, including running the pre and post scripts.
	//
	//    * If the post script fails, Amazon Data Lifecycle Manager retries the
	//    post script only; in this case, the pre script will have completed and
	//    the snapshot might have been created.
	//
	// If you do not want Amazon Data Lifecycle Manager to retry failed scripts,
	// specify 0.
	//
	// Default: 0
	MaximumRetryCount *int64 `type:"integer"`

	// Indicate which scripts Amazon Data Lifecycle Manager should run on target
	// instances. Pre scripts run before Amazon Data Lifecycle Manager initiates
	// snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates
	// snapshot creation.
	//
	//    * To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle
	//    Manager calls the SSM document with the pre-script parameter before initiating
	//    snapshot creation.
	//
	//    * To run a post script only, specify POST. In this case, Amazon Data Lifecycle
	//    Manager calls the SSM document with the post-script parameter after initiating
	//    snapshot creation.
	//
	//    * To run both pre and post scripts, specify both PRE and POST. In this
	//    case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script
	//    parameter before initiating snapshot creation, and then it calls the SSM
	//    document again with the post-script parameter after initiating snapshot
	//    creation.
	//
	// If you are automating VSS Backups, omit this parameter.
	//
	// Default: PRE and POST
	Stages []*string `min:"1" type:"list" enum:"StageValues"`
	// contains filtered or unexported fields
}

[Custom snapshot policies that target instances only] Information about pre and/or post scripts for a snapshot lifecycle policy that targets instances. For more information, see Automating application-consistent snapshots with pre and post scripts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/automate-app-consistent-backups.html).

func (Script) GoString added in v1.47.5 

func (s Script) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Script) SetExecuteOperationOnScriptFailure added in v1.47.5 

func (s *Script) SetExecuteOperationOnScriptFailure(v bool) *Script

SetExecuteOperationOnScriptFailure sets the ExecuteOperationOnScriptFailure field's value.

func (*Script) SetExecutionHandler added in v1.47.5 

func (s *Script) SetExecutionHandler(v string) *Script

SetExecutionHandler sets the ExecutionHandler field's value.

func (*Script) SetExecutionHandlerService added in v1.47.5 

func (s *Script) SetExecutionHandlerService(v string) *Script

SetExecutionHandlerService sets the ExecutionHandlerService field's value.

func (*Script) SetExecutionTimeout added in v1.47.5 

func (s *Script) SetExecutionTimeout(v int64) *Script

SetExecutionTimeout sets the ExecutionTimeout field's value.

func (*Script) SetMaximumRetryCount added in v1.47.5 

func (s *Script) SetMaximumRetryCount(v int64) *Script

SetMaximumRetryCount sets the MaximumRetryCount field's value.

func (*Script) SetStages added in v1.47.5 

func (s *Script) SetStages(v []*string) *Script

SetStages sets the Stages field's value.

func (Script) String added in v1.47.5 

func (s Script) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Script) Validate added in v1.47.5 

func (s *Script) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ShareRule added in v1.36.11 

type ShareRule struct {

	// The IDs of the Amazon Web Services accounts with which to share the snapshots.
	//
	// TargetAccounts is a required field
	TargetAccounts []*string `min:"1" type:"list" required:"true"`

	// The period after which snapshots that are shared with other Amazon Web Services
	// accounts are automatically unshared.
	UnshareInterval *int64 `min:"1" type:"integer"`

	// The unit of time for the automatic unsharing interval.
	UnshareIntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
	// contains filtered or unexported fields
}

[Custom snapshot policies only] Specifies a rule for sharing snapshots across Amazon Web Services accounts.

func (ShareRule) GoString added in v1.36.11 

func (s ShareRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ShareRule) SetTargetAccounts added in v1.36.11 

func (s *ShareRule) SetTargetAccounts(v []*string) *ShareRule

SetTargetAccounts sets the TargetAccounts field's value.

func (*ShareRule) SetUnshareInterval added in v1.36.11 

func (s *ShareRule) SetUnshareInterval(v int64) *ShareRule

SetUnshareInterval sets the UnshareInterval field's value.

func (*ShareRule) SetUnshareIntervalUnit added in v1.36.11 

func (s *ShareRule) SetUnshareIntervalUnit(v string) *ShareRule

SetUnshareIntervalUnit sets the UnshareIntervalUnit field's value.

func (ShareRule) String added in v1.36.11 

func (s ShareRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ShareRule) Validate added in v1.36.11 

func (s *ShareRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Tag 

type Tag struct {

	// The tag key.
	//
	// Key is a required field
	Key *string `type:"string" required:"true"`

	// The tag value.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies a tag for a resource.

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.25.34 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// One or more tags.
	//
	// Tags is a required field
	Tags map[string]*string `min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.25.34 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.25.34 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.25.34 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.25.34 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.25.34 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.25.34 

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

func (TagResourceOutput) GoString added in v1.25.34 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.25.34 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.25.34 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The tag keys.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.25.34 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.25.34 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.25.34 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.25.34 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.25.34 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.25.34 

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

func (UntagResourceOutput) GoString added in v1.25.34 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.25.34 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateLifecyclePolicyInput 

type UpdateLifecyclePolicyInput struct {

	// [Default policies only] Indicates whether the policy should copy tags from
	// the source resource to the snapshot or AMI.
	CopyTags *bool `type:"boolean"`

	// [Default policies only] Specifies how often the policy should run and create
	// snapshots or AMIs. The creation frequency can range from 1 to 7 days.
	CreateInterval *int64 `min:"1" type:"integer"`

	// [Default policies only] Specifies destination Regions for snapshot or AMI
	// copies. You can specify up to 3 destination Regions. If you do not want to
	// create cross-Region copies, omit this parameter.
	CrossRegionCopyTargets []*CrossRegionCopyTarget `type:"list"`

	// A description of the lifecycle policy.
	Description *string `type:"string"`

	// [Default policies only] Specifies exclusion parameters for volumes or instances
	// for which you do not want to create snapshots or AMIs. The policy will not
	// create snapshots or AMIs for target resources that match any of the specified
	// exclusion parameters.
	Exclusions *Exclusions `type:"structure"`

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

	// [Default policies only] Defines the snapshot or AMI retention behavior for
	// the policy if the source volume or instance is deleted, or if the policy
	// enters the error, disabled, or deleted state.
	//
	// By default (ExtendDeletion=false):
	//
	//    * If a source resource is deleted, Amazon Data Lifecycle Manager will
	//    continue to delete previously created snapshots or AMIs, up to but not
	//    including the last one, based on the specified retention period. If you
	//    want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including
	//    the last one, specify true.
	//
	//    * If a policy enters the error, disabled, or deleted state, Amazon Data
	//    Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon
	//    Data Lifecycle Manager to continue deleting snapshots or AMIs, including
	//    the last one, if the policy enters one of these states, specify true.
	//
	// If you enable extended deletion (ExtendDeletion=true), you override both
	// default behaviors simultaneously.
	//
	// Default: false
	ExtendDeletion *bool `type:"boolean"`

	// The configuration of the lifecycle policy. You cannot update the policy type
	// or the resource type.
	PolicyDetails *PolicyDetails `type:"structure"`

	// The identifier of the lifecycle policy.
	//
	// PolicyId is a required field
	PolicyId *string `location:"uri" locationName:"policyId" type:"string" required:"true"`

	// [Default policies only] Specifies how long the policy should retain snapshots
	// or AMIs before deleting them. The retention period can range from 2 to 14
	// days, but it must be greater than the creation frequency to ensure that the
	// policy retains at least 1 snapshot or AMI at any given time.
	RetainInterval *int64 `min:"1" type:"integer"`

	// The desired activation state of the lifecycle policy after creation.
	State *string `type:"string" enum:"SettablePolicyStateValues"`
	// contains filtered or unexported fields
}

func (UpdateLifecyclePolicyInput) GoString 

func (s UpdateLifecyclePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLifecyclePolicyInput) SetCopyTags added in v1.47.13 

func (s *UpdateLifecyclePolicyInput) SetCopyTags(v bool) *UpdateLifecyclePolicyInput

SetCopyTags sets the CopyTags field's value.

func (*UpdateLifecyclePolicyInput) SetCreateInterval added in v1.47.13 

func (s *UpdateLifecyclePolicyInput) SetCreateInterval(v int64) *UpdateLifecyclePolicyInput

SetCreateInterval sets the CreateInterval field's value.

func (*UpdateLifecyclePolicyInput) SetCrossRegionCopyTargets added in v1.47.13 

func (s *UpdateLifecyclePolicyInput) SetCrossRegionCopyTargets(v []*CrossRegionCopyTarget) *UpdateLifecyclePolicyInput

SetCrossRegionCopyTargets sets the CrossRegionCopyTargets field's value.

func (*UpdateLifecyclePolicyInput) SetDescription 

func (s *UpdateLifecyclePolicyInput) SetDescription(v string) *UpdateLifecyclePolicyInput

SetDescription sets the Description field's value.

func (*UpdateLifecyclePolicyInput) SetExclusions added in v1.47.13 

func (s *UpdateLifecyclePolicyInput) SetExclusions(v *Exclusions) *UpdateLifecyclePolicyInput

SetExclusions sets the Exclusions field's value.

func (*UpdateLifecyclePolicyInput) SetExecutionRoleArn 

func (s *UpdateLifecyclePolicyInput) SetExecutionRoleArn(v string) *UpdateLifecyclePolicyInput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*UpdateLifecyclePolicyInput) SetExtendDeletion added in v1.47.13 

func (s *UpdateLifecyclePolicyInput) SetExtendDeletion(v bool) *UpdateLifecyclePolicyInput

SetExtendDeletion sets the ExtendDeletion field's value.

func (*UpdateLifecyclePolicyInput) SetPolicyDetails 

func (s *UpdateLifecyclePolicyInput) SetPolicyDetails(v *PolicyDetails) *UpdateLifecyclePolicyInput

SetPolicyDetails sets the PolicyDetails field's value.

func (*UpdateLifecyclePolicyInput) SetPolicyId 

func (s *UpdateLifecyclePolicyInput) SetPolicyId(v string) *UpdateLifecyclePolicyInput

SetPolicyId sets the PolicyId field's value.

func (*UpdateLifecyclePolicyInput) SetRetainInterval added in v1.47.13 

func (s *UpdateLifecyclePolicyInput) SetRetainInterval(v int64) *UpdateLifecyclePolicyInput

SetRetainInterval sets the RetainInterval field's value.

func (*UpdateLifecyclePolicyInput) SetState 

func (s *UpdateLifecyclePolicyInput) SetState(v string) *UpdateLifecyclePolicyInput

SetState sets the State field's value.

func (UpdateLifecyclePolicyInput) String 

func (s UpdateLifecyclePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLifecyclePolicyInput) Validate 

func (s *UpdateLifecyclePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateLifecyclePolicyOutput 

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

func (UpdateLifecyclePolicyOutput) GoString 

func (s UpdateLifecyclePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateLifecyclePolicyOutput) String 

func (s UpdateLifecyclePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package dlmiface provides an interface to enable mocking the Amazon Data Lifecycle Manager service client for testing your code.
 Package dlmiface provides an interface to enable mocking the Amazon Data Lifecycle Manager service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.