Documentation ¶
Overview ¶
Package dlm provides the API client, operations, and parameter types for Amazon Data Lifecycle Manager.
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.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- func (c *Client) CreateLifecyclePolicy(ctx context.Context, params *CreateLifecyclePolicyInput, ...) (*CreateLifecyclePolicyOutput, error)
- func (c *Client) DeleteLifecyclePolicy(ctx context.Context, params *DeleteLifecyclePolicyInput, ...) (*DeleteLifecyclePolicyOutput, error)
- func (c *Client) GetLifecyclePolicies(ctx context.Context, params *GetLifecyclePoliciesInput, ...) (*GetLifecyclePoliciesOutput, error)
- func (c *Client) GetLifecyclePolicy(ctx context.Context, params *GetLifecyclePolicyInput, optFns ...func(*Options)) (*GetLifecyclePolicyOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateLifecyclePolicy(ctx context.Context, params *UpdateLifecyclePolicyInput, ...) (*UpdateLifecyclePolicyOutput, error)
- type CreateLifecyclePolicyInput
- type CreateLifecyclePolicyOutput
- type DeleteLifecyclePolicyInput
- type DeleteLifecyclePolicyOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetLifecyclePoliciesInput
- type GetLifecyclePoliciesOutput
- type GetLifecyclePolicyInput
- type GetLifecyclePolicyOutput
- type HTTPClient
- type HTTPSignerV4
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateLifecyclePolicyInput
- type UpdateLifecyclePolicyOutput
Constants ¶
const ServiceAPIVersion = "2018-01-12"
const ServiceID = "DLM"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon Data Lifecycle Manager.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CreateLifecyclePolicy ¶
func (c *Client) CreateLifecyclePolicy(ctx context.Context, params *CreateLifecyclePolicyInput, optFns ...func(*Options)) (*CreateLifecyclePolicyOutput, error)
Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.
func (*Client) DeleteLifecyclePolicy ¶
func (c *Client) DeleteLifecyclePolicy(ctx context.Context, params *DeleteLifecyclePolicyInput, optFns ...func(*Options)) (*DeleteLifecyclePolicyOutput, error)
Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
func (*Client) GetLifecyclePolicies ¶
func (c *Client) GetLifecyclePolicies(ctx context.Context, params *GetLifecyclePoliciesInput, optFns ...func(*Options)) (*GetLifecyclePoliciesOutput, error)
Gets summary information about all or the specified data lifecycle policies. To get complete information about a policy, use GetLifecyclePolicy.
func (*Client) GetLifecyclePolicy ¶
func (c *Client) GetLifecyclePolicy(ctx context.Context, params *GetLifecyclePolicyInput, optFns ...func(*Options)) (*GetLifecyclePolicyOutput, error)
Gets detailed information about the specified lifecycle policy.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags for the specified resource.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds the specified tags to the specified resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes the specified tags from the specified resource.
func (*Client) UpdateLifecyclePolicy ¶
func (c *Client) UpdateLifecyclePolicy(ctx context.Context, params *UpdateLifecyclePolicyInput, optFns ...func(*Options)) (*UpdateLifecyclePolicyOutput, error)
Updates the specified lifecycle policy.
type CreateLifecyclePolicyInput ¶
type CreateLifecyclePolicyInput struct { // A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are // supported. // // This member is required. Description *string // The Amazon Resource Name (ARN) of the IAM role used to run the operations // specified by the lifecycle policy. // // This member is required. ExecutionRoleArn *string // The configuration details of the lifecycle policy. // // This member is required. PolicyDetails *types.PolicyDetails // The desired activation state of the lifecycle policy after creation. // // This member is required. State types.SettablePolicyStateValues // The tags to apply to the lifecycle policy during creation. Tags map[string]string }
type CreateLifecyclePolicyOutput ¶
type CreateLifecyclePolicyOutput struct { // The identifier of the lifecycle policy. PolicyId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteLifecyclePolicyInput ¶
type DeleteLifecyclePolicyInput struct { // The identifier of the lifecycle policy. // // This member is required. PolicyId *string }
type DeleteLifecyclePolicyOutput ¶
type DeleteLifecyclePolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetLifecyclePoliciesInput ¶
type GetLifecyclePoliciesInput struct { // The identifiers of the data lifecycle policies. PolicyIds []string // The resource type. ResourceTypes []types.ResourceTypeValues // The activation state. State types.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 // The target tag for a policy. Tags are strings in the format key=value. TargetTags []string }
type GetLifecyclePoliciesOutput ¶
type GetLifecyclePoliciesOutput struct { // Summary information about the lifecycle policies. Policies []types.LifecyclePolicySummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetLifecyclePolicyInput ¶
type GetLifecyclePolicyInput struct { // The identifier of the lifecycle policy. // // This member is required. PolicyId *string }
type GetLifecyclePolicyOutput ¶
type GetLifecyclePolicyOutput struct { // Detailed information about the lifecycle policy. Policy *types.LifecyclePolicy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPSignerV4 ¶
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // Information about the tags. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type TagResourceInput ¶
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateLifecyclePolicyInput ¶
type UpdateLifecyclePolicyInput struct { // The identifier of the lifecycle policy. // // This member is required. PolicyId *string // A description of the lifecycle policy. Description *string // The Amazon Resource Name (ARN) of the IAM role used to run the operations // specified by the lifecycle policy. ExecutionRoleArn *string // The configuration of the lifecycle policy. You cannot update the policy type or // the resource type. PolicyDetails *types.PolicyDetails // The desired activation state of the lifecycle policy after creation. State types.SettablePolicyStateValues }
type UpdateLifecyclePolicyOutput ¶
type UpdateLifecyclePolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
- api_client.go
- api_op_CreateLifecyclePolicy.go
- api_op_DeleteLifecyclePolicy.go
- api_op_GetLifecyclePolicies.go
- api_op_GetLifecyclePolicy.go
- api_op_ListTagsForResource.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateLifecyclePolicy.go
- deserializers.go
- doc.go
- endpoints.go
- serializers.go
- validators.go