dlm

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 7

Documentation

Overview

Package dlm provides the client and types for making API requests to Amazon DLM.

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 use Amazon DLM 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 DLM client 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 (
	ServiceName = "Amazon DLM" // Service's name
	ServiceID   = "DLM"        // Service's identifier
	EndpointsID = "dlm"        // Service's Endpoint identifier
)
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"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := dlm.New(myConfig)

func (*Client) CreateLifecyclePolicyRequest added in v0.9.0 

func (c *Client) CreateLifecyclePolicyRequest(input *CreateLifecyclePolicyInput) CreateLifecyclePolicyRequest

CreateLifecyclePolicyRequest returns a request value for making 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. 

// Example sending a request using CreateLifecyclePolicyRequest.
req := client.CreateLifecyclePolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteLifecyclePolicyRequest added in v0.9.0 

func (c *Client) DeleteLifecyclePolicyRequest(input *DeleteLifecyclePolicyInput) DeleteLifecyclePolicyRequest

DeleteLifecyclePolicyRequest returns a request value for making API operation for Amazon Data Lifecycle Manager.

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

// Example sending a request using DeleteLifecyclePolicyRequest.
req := client.DeleteLifecyclePolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetLifecyclePoliciesRequest added in v0.9.0 

func (c *Client) GetLifecyclePoliciesRequest(input *GetLifecyclePoliciesInput) GetLifecyclePoliciesRequest

GetLifecyclePoliciesRequest returns a request value for making 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. 

// Example sending a request using GetLifecyclePoliciesRequest.
req := client.GetLifecyclePoliciesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetLifecyclePolicyRequest added in v0.9.0 

func (c *Client) GetLifecyclePolicyRequest(input *GetLifecyclePolicyInput) GetLifecyclePolicyRequest

GetLifecyclePolicyRequest returns a request value for making API operation for Amazon Data Lifecycle Manager.

Gets detailed information about the specified lifecycle policy. 

// Example sending a request using GetLifecyclePolicyRequest.
req := client.GetLifecyclePolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListTagsForResourceRequest added in v0.17.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon Data Lifecycle Manager.

Lists the tags for the specified resource. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) TagResourceRequest added in v0.17.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon Data Lifecycle Manager.

Adds the specified tags to the specified resource. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UntagResourceRequest added in v0.17.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon Data Lifecycle Manager.

Removes the specified tags from the specified resource. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateLifecyclePolicyRequest added in v0.9.0 

func (c *Client) UpdateLifecyclePolicyRequest(input *UpdateLifecyclePolicyInput) UpdateLifecyclePolicyRequest

UpdateLifecyclePolicyRequest returns a request value for making API operation for Amazon Data Lifecycle Manager.

Updates the specified lifecycle policy. 

// Example sending a request using UpdateLifecyclePolicyRequest.
req := client.UpdateLifecyclePolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

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 SettablePolicyStateValues `type:"string" required:"true" enum:"true"`

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

func (s CreateLifecyclePolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s CreateLifecyclePolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateLifecyclePolicyOutput) String 

func (s CreateLifecyclePolicyOutput) String() string

String returns the string representation

type CreateLifecyclePolicyRequest 

type CreateLifecyclePolicyRequest struct {
	*aws.Request
	Input *CreateLifecyclePolicyInput
	Copy  func(*CreateLifecyclePolicyInput) CreateLifecyclePolicyRequest
}

CreateLifecyclePolicyRequest is the request type for the CreateLifecyclePolicy API operation.

func (CreateLifecyclePolicyRequest) Send 

func (r CreateLifecyclePolicyRequest) Send(ctx context.Context) (*CreateLifecyclePolicyResponse, error)

Send marshals and sends the CreateLifecyclePolicy API request.

type CreateLifecyclePolicyResponse added in v0.9.0 

type CreateLifecyclePolicyResponse struct {
	*CreateLifecyclePolicyOutput
	// contains filtered or unexported fields
}

CreateLifecyclePolicyResponse is the response type for the CreateLifecyclePolicy API operation.

func (*CreateLifecyclePolicyResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateLifecyclePolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateLifecyclePolicy request.

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 IntervalUnitValues `type:"string" enum:"true"`

	// The time, in UTC, to start the operation. The supported format is hh:mm.
	//
	// The operation occurs within a one-hour window following the specified time.
	// If you do not specify a time, Amazon DLM selects a time within the next 24
	// hours.
	Times []string `type:"list"`
	// contains filtered or unexported fields
}

Specifies when to create snapshots of EBS volumes.

You must specify either a Cron expression or an interval, interval unit, and start time. You cannot specify both.

func (CreateRule) MarshalFields 

func (s CreateRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 v0.19.0 

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 RetentionIntervalUnitValues `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Specifies the retention rule for cross-Region snapshot copies.

func (CrossRegionCopyRetainRule) MarshalFields added in v0.19.0 

func (s CrossRegionCopyRetainRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CrossRegionCopyRetainRule) String added in v0.19.0 

func (s CrossRegionCopyRetainRule) String() string

String returns the string representation

func (*CrossRegionCopyRetainRule) Validate added in v0.19.0 

func (s *CrossRegionCopyRetainRule) Validate() error

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

type CrossRegionCopyRule added in v0.19.0 

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) MarshalFields added in v0.19.0 

func (s CrossRegionCopyRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CrossRegionCopyRule) String added in v0.19.0 

func (s CrossRegionCopyRule) String() string

String returns the string representation

func (*CrossRegionCopyRule) Validate added in v0.19.0 

func (s *CrossRegionCopyRule) Validate() error

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

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

func (s DeleteLifecyclePolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s DeleteLifecyclePolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteLifecyclePolicyOutput) String 

func (s DeleteLifecyclePolicyOutput) String() string

String returns the string representation

type DeleteLifecyclePolicyRequest 

type DeleteLifecyclePolicyRequest struct {
	*aws.Request
	Input *DeleteLifecyclePolicyInput
	Copy  func(*DeleteLifecyclePolicyInput) DeleteLifecyclePolicyRequest
}

DeleteLifecyclePolicyRequest is the request type for the DeleteLifecyclePolicy API operation.

func (DeleteLifecyclePolicyRequest) Send 

func (r DeleteLifecyclePolicyRequest) Send(ctx context.Context) (*DeleteLifecyclePolicyResponse, error)

Send marshals and sends the DeleteLifecyclePolicy API request.

type DeleteLifecyclePolicyResponse added in v0.9.0 

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

DeleteLifecyclePolicyResponse is the response type for the DeleteLifecyclePolicy API operation.

func (*DeleteLifecyclePolicyResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteLifecyclePolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteLifecyclePolicy request.

type FastRestoreRule added in v0.17.0 

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 RetentionIntervalUnitValues `type:"string" enum:"true"`
	// 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) MarshalFields added in v0.17.0 

func (s FastRestoreRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FastRestoreRule) String added in v0.17.0 

func (s FastRestoreRule) String() string

String returns the string representation

func (*FastRestoreRule) Validate added in v0.17.0 

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 []ResourceTypeValues `location:"querystring" locationName:"resourceTypes" min:"1" type:"list"`

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

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

func (s GetLifecyclePoliciesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s GetLifecyclePoliciesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetLifecyclePoliciesOutput) String 

func (s GetLifecyclePoliciesOutput) String() string

String returns the string representation

type GetLifecyclePoliciesRequest 

type GetLifecyclePoliciesRequest struct {
	*aws.Request
	Input *GetLifecyclePoliciesInput
	Copy  func(*GetLifecyclePoliciesInput) GetLifecyclePoliciesRequest
}

GetLifecyclePoliciesRequest is the request type for the GetLifecyclePolicies API operation.

func (GetLifecyclePoliciesRequest) Send 

func (r GetLifecyclePoliciesRequest) Send(ctx context.Context) (*GetLifecyclePoliciesResponse, error)

Send marshals and sends the GetLifecyclePolicies API request.

type GetLifecyclePoliciesResponse added in v0.9.0 

type GetLifecyclePoliciesResponse struct {
	*GetLifecyclePoliciesOutput
	// contains filtered or unexported fields
}

GetLifecyclePoliciesResponse is the response type for the GetLifecyclePolicies API operation.

func (*GetLifecyclePoliciesResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetLifecyclePoliciesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetLifecyclePolicies request.

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

func (s GetLifecyclePolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s GetLifecyclePolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetLifecyclePolicyOutput) String 

func (s GetLifecyclePolicyOutput) String() string

String returns the string representation

type GetLifecyclePolicyRequest 

type GetLifecyclePolicyRequest struct {
	*aws.Request
	Input *GetLifecyclePolicyInput
	Copy  func(*GetLifecyclePolicyInput) GetLifecyclePolicyRequest
}

GetLifecyclePolicyRequest is the request type for the GetLifecyclePolicy API operation.

func (GetLifecyclePolicyRequest) Send 

func (r GetLifecyclePolicyRequest) Send(ctx context.Context) (*GetLifecyclePolicyResponse, error)

Send marshals and sends the GetLifecyclePolicy API request.

type GetLifecyclePolicyResponse added in v0.9.0 

type GetLifecyclePolicyResponse struct {
	*GetLifecyclePolicyOutput
	// contains filtered or unexported fields
}

GetLifecyclePolicyResponse is the response type for the GetLifecyclePolicy API operation.

func (*GetLifecyclePolicyResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetLifecyclePolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetLifecyclePolicy request.

type GettablePolicyStateValues 

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

Enum values for GettablePolicyStateValues

func (GettablePolicyStateValues) MarshalValue 

func (enum GettablePolicyStateValues) MarshalValue() (string, error)

func (GettablePolicyStateValues) MarshalValueBuf 

func (enum GettablePolicyStateValues) MarshalValueBuf(b []byte) ([]byte, error)

type IntervalUnitValues 

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

Enum values for IntervalUnitValues

func (IntervalUnitValues) MarshalValue 

func (enum IntervalUnitValues) MarshalValue() (string, error)

func (IntervalUnitValues) MarshalValueBuf 

func (enum IntervalUnitValues) MarshalValueBuf(b []byte) ([]byte, error)

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 GettablePolicyStateValues `type:"string" enum:"true"`

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

func (s LifecyclePolicy) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 GettablePolicyStateValues `type:"string" enum:"true"`

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

Summary information about a lifecycle policy.

func (LifecyclePolicySummary) MarshalFields 

func (s LifecyclePolicySummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LifecyclePolicySummary) String 

func (s LifecyclePolicySummary) String() string

String returns the string representation

type ListTagsForResourceInput added in v0.17.0 

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) MarshalFields added in v0.17.0 

func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceInput) String added in v0.17.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.17.0 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v0.17.0 

type ListTagsForResourceOutput struct {

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

func (ListTagsForResourceOutput) MarshalFields added in v0.17.0 

func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String added in v0.17.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.17.0 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.17.0 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.17.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.17.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type Parameters added in v0.10.0 

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) MarshalFields added in v0.10.0 

func (s Parameters) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Parameters) String added in v0.10.0 

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 PolicyTypeValues `type:"string" enum:"true"`

	// The resource type. Use VOLUME to create snapshots of individual volumes or
	// use INSTANCE to create multi-volume snapshots from the volumes for an instance.
	ResourceTypes []ResourceTypeValues `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) MarshalFields 

func (s PolicyDetails) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 PolicyTypeValues added in v0.10.0 

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

Enum values for PolicyTypeValues

func (PolicyTypeValues) MarshalValue added in v0.10.0 

func (enum PolicyTypeValues) MarshalValue() (string, error)

func (PolicyTypeValues) MarshalValueBuf added in v0.10.0 

func (enum PolicyTypeValues) MarshalValueBuf(b []byte) ([]byte, error)

type ResourceTypeValues 

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

Enum values for ResourceTypeValues

func (ResourceTypeValues) MarshalValue 

func (enum ResourceTypeValues) MarshalValue() (string, error)

func (ResourceTypeValues) MarshalValueBuf 

func (enum ResourceTypeValues) MarshalValueBuf(b []byte) ([]byte, error)

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 RetentionIntervalUnitValues `type:"string" enum:"true"`
	// 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) MarshalFields 

func (s RetainRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 RetentionIntervalUnitValues added in v0.18.0 

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

Enum values for RetentionIntervalUnitValues

func (RetentionIntervalUnitValues) MarshalValue added in v0.18.0 

func (enum RetentionIntervalUnitValues) MarshalValue() (string, error)

func (RetentionIntervalUnitValues) MarshalValueBuf added in v0.18.0 

func (enum RetentionIntervalUnitValues) MarshalValueBuf(b []byte) ([]byte, error)

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

func (s Schedule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 SettablePolicyStateValues 

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

Enum values for SettablePolicyStateValues

func (SettablePolicyStateValues) MarshalValue 

func (enum SettablePolicyStateValues) MarshalValue() (string, error)

func (SettablePolicyStateValues) MarshalValueBuf 

func (enum SettablePolicyStateValues) MarshalValueBuf(b []byte) ([]byte, error)

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

func (s Tag) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 v0.17.0 

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) MarshalFields added in v0.17.0 

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String added in v0.17.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.17.0 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v0.17.0 

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

func (TagResourceOutput) MarshalFields added in v0.17.0 

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String added in v0.17.0 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.17.0 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.17.0 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.17.0 

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

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.17.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type UntagResourceInput added in v0.17.0 

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) MarshalFields added in v0.17.0 

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String added in v0.17.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.17.0 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v0.17.0 

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

func (UntagResourceOutput) MarshalFields added in v0.17.0 

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String added in v0.17.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.17.0 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.17.0 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.17.0 

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

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.17.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

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 SettablePolicyStateValues `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateLifecyclePolicyInput) MarshalFields 

func (s UpdateLifecyclePolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

func (s UpdateLifecyclePolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateLifecyclePolicyOutput) String 

func (s UpdateLifecyclePolicyOutput) String() string

String returns the string representation

type UpdateLifecyclePolicyRequest 

type UpdateLifecyclePolicyRequest struct {
	*aws.Request
	Input *UpdateLifecyclePolicyInput
	Copy  func(*UpdateLifecyclePolicyInput) UpdateLifecyclePolicyRequest
}

UpdateLifecyclePolicyRequest is the request type for the UpdateLifecyclePolicy API operation.

func (UpdateLifecyclePolicyRequest) Send 

func (r UpdateLifecyclePolicyRequest) Send(ctx context.Context) (*UpdateLifecyclePolicyResponse, error)

Send marshals and sends the UpdateLifecyclePolicy API request.

type UpdateLifecyclePolicyResponse added in v0.9.0 

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

UpdateLifecyclePolicyResponse is the response type for the UpdateLifecyclePolicy API operation.

func (*UpdateLifecyclePolicyResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateLifecyclePolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateLifecyclePolicy request.

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.