aws-sdk-go: github.com/aws/aws-sdk-go/service/dlm Index | Files | Directories

package dlm

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

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

Package Files

api.go doc.go errors.go service.go

Constants

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"
)
const (
    // ResourceTypeValuesVolume is a ResourceTypeValues enum value
    ResourceTypeValuesVolume = "VOLUME"

    // ResourceTypeValuesInstance is a ResourceTypeValues enum value
    ResourceTypeValuesInstance = "INSTANCE"
)
const (
    // SettablePolicyStateValuesEnabled is a SettablePolicyStateValues enum value
    SettablePolicyStateValuesEnabled = "ENABLED"

    // SettablePolicyStateValuesDisabled is a SettablePolicyStateValues enum value
    SettablePolicyStateValuesDisabled = "DISABLED"
)
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"
)
const (
    ServiceName = "DLM" // Name of service.
    EndpointsID = "dlm" // ID to lookup a service endpoint with.
    ServiceID   = "DLM" // ServiceID is a unique identifer of a specific service.
)

Service information constants

const (
    // IntervalUnitValuesHours is a IntervalUnitValues enum value
    IntervalUnitValuesHours = "HOURS"
)
const (
    // PolicyTypeValuesEbsSnapshotManagement is a PolicyTypeValues enum value
    PolicyTypeValuesEbsSnapshotManagement = "EBS_SNAPSHOT_MANAGEMENT"
)

type CreateLifecyclePolicyInput Uses

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.
    //
    // Target tags cannot be re-used across lifecycle policies.
    //
    // 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"`
    // contains filtered or unexported fields
}

func (CreateLifecyclePolicyInput) GoString Uses

func (s CreateLifecyclePolicyInput) GoString() string

GoString returns the string representation

func (*CreateLifecyclePolicyInput) SetDescription Uses

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

SetDescription sets the Description field's value.

func (*CreateLifecyclePolicyInput) SetExecutionRoleArn Uses

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

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*CreateLifecyclePolicyInput) SetPolicyDetails Uses

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

SetPolicyDetails sets the PolicyDetails field's value.

func (*CreateLifecyclePolicyInput) SetState Uses

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

SetState sets the State field's value.

func (CreateLifecyclePolicyInput) String Uses

func (s CreateLifecyclePolicyInput) String() string

String returns the string representation

func (*CreateLifecyclePolicyInput) Validate Uses

func (s *CreateLifecyclePolicyInput) Validate() error

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

type CreateLifecyclePolicyOutput Uses

type CreateLifecyclePolicyOutput struct {

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

func (CreateLifecyclePolicyOutput) GoString Uses

func (s CreateLifecyclePolicyOutput) GoString() string

GoString returns the string representation

func (*CreateLifecyclePolicyOutput) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (CreateLifecyclePolicyOutput) String Uses

func (s CreateLifecyclePolicyOutput) String() string

String returns the string representation

type CreateRule Uses

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 Uses

func (s CreateRule) GoString() string

GoString returns the string representation

func (*CreateRule) SetInterval Uses

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

SetInterval sets the Interval field's value.

func (*CreateRule) SetIntervalUnit Uses

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

SetIntervalUnit sets the IntervalUnit field's value.

func (*CreateRule) SetTimes Uses

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

SetTimes sets the Times field's value.

func (CreateRule) String Uses

func (s CreateRule) String() string

String returns the string representation

func (*CreateRule) Validate Uses

func (s *CreateRule) Validate() error

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

type DLM Uses

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 Uses

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:

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

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
Bad request. The request is missing required parameters or has invalid parameters.

* ErrCodeLimitExceededException "LimitExceededException"
The request failed because a limit was exceeded.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
A requested resource was not found.

* ErrCodeInternalServerException "InternalServerException"
The service failed in an unexpected way.

* ErrCodeLimitExceededException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
A requested resource was not found.

* ErrCodeInvalidRequestException "InvalidRequestException"
Bad request. The request is missing required parameters or has invalid parameters.

* ErrCodeInternalServerException "InternalServerException"
The service failed in an unexpected way.

* ErrCodeLimitExceededException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
A requested resource was not found.

* ErrCodeInternalServerException "InternalServerException"
The service failed in an unexpected way.

* ErrCodeLimitExceededException "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 Uses

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 Uses

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

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
A requested resource was not found.

* ErrCodeInvalidRequestException "InvalidRequestException"
Bad request. The request is missing required parameters or has invalid parameters.

* ErrCodeInternalServerException "InternalServerException"
The service failed in an unexpected way.

* ErrCodeLimitExceededException "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 Uses

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 Uses

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 Uses

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 Uses

func (s DeleteLifecyclePolicyInput) GoString() string

GoString returns the string representation

func (*DeleteLifecyclePolicyInput) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (DeleteLifecyclePolicyInput) String Uses

func (s DeleteLifecyclePolicyInput) String() string

String returns the string representation

func (*DeleteLifecyclePolicyInput) Validate Uses

func (s *DeleteLifecyclePolicyInput) Validate() error

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

type DeleteLifecyclePolicyOutput Uses

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

func (DeleteLifecyclePolicyOutput) GoString Uses

func (s DeleteLifecyclePolicyOutput) GoString() string

GoString returns the string representation

func (DeleteLifecyclePolicyOutput) String Uses

func (s DeleteLifecyclePolicyOutput) String() string

String returns the string representation

type GetLifecyclePoliciesInput Uses

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 Uses

func (s GetLifecyclePoliciesInput) GoString() string

GoString returns the string representation

func (*GetLifecyclePoliciesInput) SetPolicyIds Uses

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

SetPolicyIds sets the PolicyIds field's value.

func (*GetLifecyclePoliciesInput) SetResourceTypes Uses

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

SetResourceTypes sets the ResourceTypes field's value.

func (*GetLifecyclePoliciesInput) SetState Uses

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

SetState sets the State field's value.

func (*GetLifecyclePoliciesInput) SetTagsToAdd Uses

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

SetTagsToAdd sets the TagsToAdd field's value.

func (*GetLifecyclePoliciesInput) SetTargetTags Uses

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

SetTargetTags sets the TargetTags field's value.

func (GetLifecyclePoliciesInput) String Uses

func (s GetLifecyclePoliciesInput) String() string

String returns the string representation

func (*GetLifecyclePoliciesInput) Validate Uses

func (s *GetLifecyclePoliciesInput) Validate() error

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

type GetLifecyclePoliciesOutput Uses

type GetLifecyclePoliciesOutput struct {

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

func (GetLifecyclePoliciesOutput) GoString Uses

func (s GetLifecyclePoliciesOutput) GoString() string

GoString returns the string representation

func (*GetLifecyclePoliciesOutput) SetPolicies Uses

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

SetPolicies sets the Policies field's value.

func (GetLifecyclePoliciesOutput) String Uses

func (s GetLifecyclePoliciesOutput) String() string

String returns the string representation

type GetLifecyclePolicyInput Uses

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 Uses

func (s GetLifecyclePolicyInput) GoString() string

GoString returns the string representation

func (*GetLifecyclePolicyInput) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (GetLifecyclePolicyInput) String Uses

func (s GetLifecyclePolicyInput) String() string

String returns the string representation

func (*GetLifecyclePolicyInput) Validate Uses

func (s *GetLifecyclePolicyInput) Validate() error

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

type GetLifecyclePolicyOutput Uses

type GetLifecyclePolicyOutput struct {

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

func (GetLifecyclePolicyOutput) GoString Uses

func (s GetLifecyclePolicyOutput) GoString() string

GoString returns the string representation

func (*GetLifecyclePolicyOutput) SetPolicy Uses

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

SetPolicy sets the Policy field's value.

func (GetLifecyclePolicyOutput) String Uses

func (s GetLifecyclePolicyOutput) String() string

String returns the string representation

type LifecyclePolicy Uses

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

Detailed information about a lifecycle policy.

func (LifecyclePolicy) GoString Uses

func (s LifecyclePolicy) GoString() string

GoString returns the string representation

func (*LifecyclePolicy) SetDateCreated Uses

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

SetDateCreated sets the DateCreated field's value.

func (*LifecyclePolicy) SetDateModified Uses

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

SetDateModified sets the DateModified field's value.

func (*LifecyclePolicy) SetDescription Uses

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

SetDescription sets the Description field's value.

func (*LifecyclePolicy) SetExecutionRoleArn Uses

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

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*LifecyclePolicy) SetPolicyDetails Uses

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

SetPolicyDetails sets the PolicyDetails field's value.

func (*LifecyclePolicy) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (*LifecyclePolicy) SetState Uses

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

SetState sets the State field's value.

func (LifecyclePolicy) String Uses

func (s LifecyclePolicy) String() string

String returns the string representation

type LifecyclePolicySummary Uses

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

Summary information about a lifecycle policy.

func (LifecyclePolicySummary) GoString Uses

func (s LifecyclePolicySummary) GoString() string

GoString returns the string representation

func (*LifecyclePolicySummary) SetDescription Uses

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

SetDescription sets the Description field's value.

func (*LifecyclePolicySummary) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (*LifecyclePolicySummary) SetState Uses

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

SetState sets the State field's value.

func (LifecyclePolicySummary) String Uses

func (s LifecyclePolicySummary) String() string

String returns the string representation

type Parameters Uses

type Parameters struct {

    // When executing an EBS Snapshot Management – Instance policy, execute all
    // CreateSnapshots calls with the excludeBootVolume set to the supplied field.
    // Defaults to false. Only valid for EBS Snapshot Management – Instance policies.
    ExcludeBootVolume *bool `type:"boolean"`
    // contains filtered or unexported fields
}

Optional parameters that can be added to the policy. The set of valid parameters depends on the combination of policyType and resourceType values.

func (Parameters) GoString Uses

func (s Parameters) GoString() string

GoString returns the string representation

func (*Parameters) SetExcludeBootVolume Uses

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

SetExcludeBootVolume sets the ExcludeBootVolume field's value.

func (Parameters) String Uses

func (s Parameters) String() string

String returns the string representation

type PolicyDetails Uses

type PolicyDetails struct {

    // A set of optional parameters that can be provided by the policy.
    Parameters *Parameters `type:"structure"`

    // This field determines the valid target resource types and actions a policy
    // can manage. This field defaults to EBS_SNAPSHOT_MANAGEMENT if not present.
    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 Uses

func (s PolicyDetails) GoString() string

GoString returns the string representation

func (*PolicyDetails) SetParameters Uses

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

SetParameters sets the Parameters field's value.

func (*PolicyDetails) SetPolicyType Uses

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

SetPolicyType sets the PolicyType field's value.

func (*PolicyDetails) SetResourceTypes Uses

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

SetResourceTypes sets the ResourceTypes field's value.

func (*PolicyDetails) SetSchedules Uses

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

SetSchedules sets the Schedules field's value.

func (*PolicyDetails) SetTargetTags Uses

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

SetTargetTags sets the TargetTags field's value.

func (PolicyDetails) String Uses

func (s PolicyDetails) String() string

String returns the string representation

func (*PolicyDetails) Validate Uses

func (s *PolicyDetails) Validate() error

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

type RetainRule Uses

type RetainRule struct {

    // The number of snapshots to keep for each volume, up to a maximum of 1000.
    //
    // Count is a required field
    Count *int64 `min:"1" type:"integer" required:"true"`
    // contains filtered or unexported fields
}

Specifies the number of snapshots to keep for each EBS volume.

func (RetainRule) GoString Uses

func (s RetainRule) GoString() string

GoString returns the string representation

func (*RetainRule) SetCount Uses

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

SetCount sets the Count field's value.

func (RetainRule) String Uses

func (s RetainRule) String() string

String returns the string representation

func (*RetainRule) Validate Uses

func (s *RetainRule) Validate() error

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

type Schedule Uses

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 create rule.
    CreateRule *CreateRule `type:"structure"`

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

    // The retain 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 schedule.

func (Schedule) GoString Uses

func (s Schedule) GoString() string

GoString returns the string representation

func (*Schedule) SetCopyTags Uses

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

SetCopyTags sets the CopyTags field's value.

func (*Schedule) SetCreateRule Uses

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

SetCreateRule sets the CreateRule field's value.

func (*Schedule) SetName Uses

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

SetName sets the Name field's value.

func (*Schedule) SetRetainRule Uses

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

SetRetainRule sets the RetainRule field's value.

func (*Schedule) SetTagsToAdd Uses

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

SetTagsToAdd sets the TagsToAdd field's value.

func (*Schedule) SetVariableTags Uses

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

SetVariableTags sets the VariableTags field's value.

func (Schedule) String Uses

func (s Schedule) String() string

String returns the string representation

func (*Schedule) Validate Uses

func (s *Schedule) Validate() error

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

type Tag Uses

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 Uses

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey Uses

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

SetKey sets the Key field's value.

func (*Tag) SetValue Uses

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

SetValue sets the Value field's value.

func (Tag) String Uses

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate Uses

func (s *Tag) Validate() error

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

type UpdateLifecyclePolicyInput Uses

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.
    //
    // Target tags cannot be re-used across policies.
    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 Uses

func (s UpdateLifecyclePolicyInput) GoString() string

GoString returns the string representation

func (*UpdateLifecyclePolicyInput) SetDescription Uses

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

SetDescription sets the Description field's value.

func (*UpdateLifecyclePolicyInput) SetExecutionRoleArn Uses

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

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*UpdateLifecyclePolicyInput) SetPolicyDetails Uses

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

SetPolicyDetails sets the PolicyDetails field's value.

func (*UpdateLifecyclePolicyInput) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (*UpdateLifecyclePolicyInput) SetState Uses

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

SetState sets the State field's value.

func (UpdateLifecyclePolicyInput) String Uses

func (s UpdateLifecyclePolicyInput) String() string

String returns the string representation

func (*UpdateLifecyclePolicyInput) Validate Uses

func (s *UpdateLifecyclePolicyInput) Validate() error

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

type UpdateLifecyclePolicyOutput Uses

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

func (UpdateLifecyclePolicyOutput) GoString Uses

func (s UpdateLifecyclePolicyOutput) GoString() string

GoString returns the string representation

func (UpdateLifecyclePolicyOutput) String Uses

func (s UpdateLifecyclePolicyOutput) String() string

String returns the string representation

Directories

PathSynopsis
dlmifacePackage dlmiface provides an interface to enable mocking the Amazon Data Lifecycle Manager service client for testing your code.

Package dlm imports 10 packages (graph) and is imported by 13 packages. Updated 2019-06-07. Refresh now. Tools for package owners.