dlm

package
v1.29.9 Latest Latest
Warning

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

 Go to latest Published: Feb 24, 2020 License: Apache-2.0 Imports: 10 Imported by: 41

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 AWS resources. You create lifecycle policies, which are used to automate operations on the specified resources.

Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see Automating the Amazon EBS Snapshot Lifecycle (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 (
	// 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 (
	// 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 (

	// 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 (
	// IntervalUnitValuesHours is a IntervalUnitValues enum value
	IntervalUnitValuesHours = "HOURS"
)
View Source 
const (
	// PolicyTypeValuesEbsSnapshotManagement is a PolicyTypeValues enum value
	PolicyTypeValuesEbsSnapshotManagement = "EBS_SNAPSHOT_MANAGEMENT"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateLifecyclePolicyInput 

type CreateLifecyclePolicyInput struct {

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

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

	// The configuration details of the lifecycle policy.
	//
	// PolicyDetails is a required field
	PolicyDetails *PolicyDetails `type:"structure" required:"true"`

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

func (*CreateLifecyclePolicyInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateLifecyclePolicyInput) SetExecutionRoleArn 

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

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*CreateLifecyclePolicyInput) SetPolicyDetails 

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

SetPolicyDetails sets the PolicyDetails 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

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

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

type CreateRule 

type CreateRule struct {

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

	// The interval unit.
	//
	// IntervalUnit is a required field
	IntervalUnit *string `type:"string" required:"true" enum:"IntervalUnitValues"`

	// 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.
	Times []*string `type:"list"`
	// contains filtered or unexported fields
}

Specifies when to create snapshots of EBS volumes.

func (CreateRule) GoString 

func (s CreateRule) GoString() string

GoString returns the string representation

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

func (*CreateRule) Validate 

func (s *CreateRule) 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 each snapshot. 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.
	IntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
	// contains filtered or unexported fields
}

Specifies the retention rule for cross-Region snapshot copies.

func (CrossRegionCopyRetainRule) GoString added in v1.26.6 

func (s CrossRegionCopyRetainRule) GoString() string

GoString returns the string representation

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

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 AWS KMS customer master key (CMK) to
	// use for EBS encryption. If this parameter is not specified, your AWS managed
	// CMK for EBS is used.
	CmkArn *string `type:"string"`

	// Copy all user-defined tags from the source snapshot to the copied snapshot.
	CopyTags *bool `type:"boolean"`

	// 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.
	RetainRule *CrossRegionCopyRetainRule `type:"structure"`

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

Specifies a rule for cross-Region snapshot copies.

func (CrossRegionCopyRule) GoString added in v1.26.6 

func (s CrossRegionCopyRule) GoString() string

GoString returns the string representation

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

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 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 a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.

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.

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.

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.

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

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

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

func (DeleteLifecyclePolicyOutput) String 

func (s DeleteLifecyclePolicyOutput) String() string

String returns the string representation

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
}

Specifies a rule for enabling fast snapshot restore. 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

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

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 {

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

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

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

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

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

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

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

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

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

type InternalServerException added in v1.28.0 

type InternalServerException struct {
	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

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

type InvalidRequestException added in v1.28.0 

type InvalidRequestException struct {
	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

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

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"`

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

Detailed information about a lifecycle policy.

func (LifecyclePolicy) GoString 

func (s LifecyclePolicy) GoString() string

GoString returns the string representation

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

type LifecyclePolicySummary 

type LifecyclePolicySummary struct {

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

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

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

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

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	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

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

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

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

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

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

type Parameters added in v1.19.40 

type Parameters struct {

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

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

func (Parameters) GoString added in v1.19.40 

func (s Parameters) GoString() string

GoString returns the string representation

func (*Parameters) SetExcludeBootVolume added in v1.19.40 

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

SetExcludeBootVolume sets the ExcludeBootVolume field's value.

func (Parameters) String added in v1.19.40 

func (s Parameters) String() string

String returns the string representation

type PolicyDetails 

type PolicyDetails struct {

	// A set of optional parameters for the policy.
	Parameters *Parameters `type:"structure"`

	// The valid target resource types and actions a policy can manage. The default
	// is EBS_SNAPSHOT_MANAGEMENT.
	PolicyType *string `type:"string" enum:"PolicyTypeValues"`

	// The resource type.
	ResourceTypes []*string `min:"1" type:"list"`

	// The schedule of policy-defined actions.
	Schedules []*Schedule `min:"1" type:"list"`

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

func (*PolicyDetails) SetParameters added in v1.19.40 

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

SetParameters sets the Parameters 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) SetResourceTypes 

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

SetResourceTypes sets the ResourceTypes 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

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

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

type RetainRule 

type RetainRule struct {

	// The number of snapshots to retain for each volume, up to a maximum of 1000.
	Count *int64 `min:"1" 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 `min:"1" type:"integer"`

	// The unit of time for time-based retention.
	IntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
	// contains filtered or unexported fields
}

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

func (RetainRule) GoString 

func (s RetainRule) GoString() string

GoString returns the string representation

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

func (*RetainRule) Validate 

func (s *RetainRule) Validate() error

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

type Schedule 

type Schedule struct {

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

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

	// The rule for cross-Region snapshot copies.
	CrossRegionCopyRules []*CrossRegionCopyRule `type:"list"`

	// The rule for enabling fast snapshot restore.
	FastRestoreRule *FastRestoreRule `type:"structure"`

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

	// The retention rule.
	RetainRule *RetainRule `type:"structure"`

	// The tags to apply to policy-created resources. These user-defined tags are
	// in addition to the AWS-added lifecycle tags.
	TagsToAdd []*Tag `type:"list"`

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

Specifies a backup schedule.

func (Schedule) GoString 

func (s Schedule) GoString() string

GoString returns the string representation

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

func (*Schedule) Validate 

func (s *Schedule) 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

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

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

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

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

func (TagResourceOutput) String added in v1.25.34 

func (s TagResourceOutput) String() string

String returns the string representation

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

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

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

func (UntagResourceOutput) String added in v1.25.34 

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateLifecyclePolicyInput 

type UpdateLifecyclePolicyInput struct {

	// A 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 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"`

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

func (*UpdateLifecyclePolicyInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateLifecyclePolicyInput) SetExecutionRoleArn 

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

SetExecutionRoleArn sets the ExecutionRoleArn 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) 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

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

func (UpdateLifecyclePolicyOutput) String 

func (s UpdateLifecyclePolicyOutput) String() string

String returns the string representation

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.