func EventSourceValues_Values() []string
EventSourceValues_Values returns all elements of the EventSourceValues enum
func EventTypeValues_Values() []string
EventTypeValues_Values returns all elements of the EventTypeValues enum
func GettablePolicyStateValues_Values() []string
GettablePolicyStateValues_Values returns all elements of the GettablePolicyStateValues enum
func IntervalUnitValues_Values() []string
IntervalUnitValues_Values returns all elements of the IntervalUnitValues enum
func LocationValues_Values() []string
LocationValues_Values returns all elements of the LocationValues enum
func PolicyTypeValues_Values() []string
PolicyTypeValues_Values returns all elements of the PolicyTypeValues enum
func ResourceLocationValues_Values() []string
ResourceLocationValues_Values returns all elements of the ResourceLocationValues enum
func ResourceTypeValues_Values() []string
ResourceTypeValues_Values returns all elements of the ResourceTypeValues enum
func RetentionIntervalUnitValues_Values() []string
RetentionIntervalUnitValues_Values returns all elements of the RetentionIntervalUnitValues enum
func SettablePolicyStateValues_Values() []string
SettablePolicyStateValues_Values returns all elements of the SettablePolicyStateValues enum
type Action struct {
// The rule for copying shared snapshots across Regions.
//
// CrossRegionCopy is a required field
CrossRegionCopy []*CrossRegionCopyAction `type:"list" required:"true"`
// A descriptive name for the action.
//
// Name is a required field
Name *string `type:"string" required:"true"`
// contains filtered or unexported fields
}
Specifies an action for an event-based policy.
func (s Action) GoString() string
GoString returns the string representation
func (s *Action) SetCrossRegionCopy(v []*CrossRegionCopyAction) *Action
SetCrossRegionCopy sets the CrossRegionCopy field's value.
func (s *Action) SetName(v string) *Action
SetName sets the Name field's value.
func (s Action) String() string
String returns the string representation
func (s *Action) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateLifecyclePolicyInput struct {
// A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are
// supported.
//
// Description is a required field
Description *string `type:"string" required:"true"`
// The Amazon Resource Name (ARN) of the IAM role used to run the operations
// specified by the lifecycle policy.
//
// ExecutionRoleArn is a required field
ExecutionRoleArn *string `type:"string" required:"true"`
// The configuration details of the lifecycle policy.
//
// PolicyDetails is a required field
PolicyDetails *PolicyDetails `type:"structure" required:"true"`
// The desired activation state of the lifecycle policy after creation.
//
// State is a required field
State *string `type:"string" required:"true" enum:"SettablePolicyStateValues"`
// The tags to apply to the lifecycle policy during creation.
Tags map[string]*string `min:"1" type:"map"`
// contains filtered or unexported fields
}
func (s CreateLifecyclePolicyInput) GoString() string
GoString returns the string representation
func (s *CreateLifecyclePolicyInput) SetDescription(v string) *CreateLifecyclePolicyInput
SetDescription sets the Description field's value.
func (s *CreateLifecyclePolicyInput) SetExecutionRoleArn(v string) *CreateLifecyclePolicyInput
SetExecutionRoleArn sets the ExecutionRoleArn field's value.
func (s *CreateLifecyclePolicyInput) SetPolicyDetails(v *PolicyDetails) *CreateLifecyclePolicyInput
SetPolicyDetails sets the PolicyDetails field's value.
func (s *CreateLifecyclePolicyInput) SetState(v string) *CreateLifecyclePolicyInput
SetState sets the State field's value.
func (s *CreateLifecyclePolicyInput) SetTags(v map[string]*string) *CreateLifecyclePolicyInput
SetTags sets the Tags field's value.
func (s CreateLifecyclePolicyInput) String() string
String returns the string representation
func (s *CreateLifecyclePolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateLifecyclePolicyOutput struct {
// The identifier of the lifecycle policy.
PolicyId *string `type:"string"`
// contains filtered or unexported fields
}
func (s CreateLifecyclePolicyOutput) GoString() string
GoString returns the string representation
func (s *CreateLifecyclePolicyOutput) SetPolicyId(v string) *CreateLifecyclePolicyOutput
SetPolicyId sets the PolicyId field's value.
func (s CreateLifecyclePolicyOutput) String() string
String returns the string representation
type CreateRule struct {
// The schedule, as a Cron expression. The schedule interval must be between
// 1 hour and 1 year. For more information, see Cron expressions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions)
// in the Amazon CloudWatch User Guide.
CronExpression *string `min:"17" type:"string"`
// The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8,
// 12, and 24.
Interval *int64 `min:"1" type:"integer"`
// The interval unit.
IntervalUnit *string `type:"string" enum:"IntervalUnitValues"`
// Specifies the destination for snapshots created by the policy. To create
// snapshots in the same Region as the source resource, specify CLOUD. To create
// snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL.
// If you omit this parameter, CLOUD is used by default.
//
// If the policy targets resources in an AWS Region, then you must create snapshots
// in the same Region as the source resource.
//
// If the policy targets resources on an Outpost, then you can create snapshots
// on the same Outpost as the source resource, or in the Region of that Outpost.
Location *string `type:"string" enum:"LocationValues"`
// 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 (s CreateRule) GoString() string
GoString returns the string representation
func (s *CreateRule) SetCronExpression(v string) *CreateRule
SetCronExpression sets the CronExpression field's value.
func (s *CreateRule) SetInterval(v int64) *CreateRule
SetInterval sets the Interval field's value.
func (s *CreateRule) SetIntervalUnit(v string) *CreateRule
SetIntervalUnit sets the IntervalUnit field's value.
func (s *CreateRule) SetLocation(v string) *CreateRule
SetLocation sets the Location field's value.
func (s *CreateRule) SetTimes(v []*string) *CreateRule
SetTimes sets the Times field's value.
func (s CreateRule) String() string
String returns the string representation
func (s *CreateRule) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CrossRegionCopyAction struct {
// The encryption settings for the copied snapshot.
//
// EncryptionConfiguration is a required field
EncryptionConfiguration *EncryptionConfiguration `type:"structure" required:"true"`
// Specifies the retention rule for cross-Region snapshot copies.
RetainRule *CrossRegionCopyRetainRule `type:"structure"`
// The target Region.
//
// Target is a required field
Target *string `type:"string" required:"true"`
// contains filtered or unexported fields
}
Specifies a rule for copying shared snapshots across Regions.
func (s CrossRegionCopyAction) GoString() string
GoString returns the string representation
func (s *CrossRegionCopyAction) SetEncryptionConfiguration(v *EncryptionConfiguration) *CrossRegionCopyAction
SetEncryptionConfiguration sets the EncryptionConfiguration field's value.
func (s *CrossRegionCopyAction) SetRetainRule(v *CrossRegionCopyRetainRule) *CrossRegionCopyAction
SetRetainRule sets the RetainRule field's value.
func (s *CrossRegionCopyAction) SetTarget(v string) *CrossRegionCopyAction
SetTarget sets the Target field's value.
func (s CrossRegionCopyAction) String() string
String returns the string representation
func (s *CrossRegionCopyAction) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CrossRegionCopyRetainRule struct {
// The amount of time to retain each snapshot. The maximum is 100 years. This
// is equivalent to 1200 months, 5200 weeks, or 36500 days.
Interval *int64 `min:"1" type:"integer"`
// The unit of time for time-based retention.
IntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
// contains filtered or unexported fields
}
Specifies the retention rule for cross-Region snapshot copies.
func (s CrossRegionCopyRetainRule) GoString() string
GoString returns the string representation
func (s *CrossRegionCopyRetainRule) SetInterval(v int64) *CrossRegionCopyRetainRule
SetInterval sets the Interval field's value.
func (s *CrossRegionCopyRetainRule) SetIntervalUnit(v string) *CrossRegionCopyRetainRule
SetIntervalUnit sets the IntervalUnit field's value.
func (s CrossRegionCopyRetainRule) String() string
String returns the string representation
func (s *CrossRegionCopyRetainRule) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot
// copies.
//
// If you specify an ARN, you must omit TargetRegion. You cannot specify a target
// Region and a target Outpost in the same rule.
Target *string `type:"string"`
// The target Region for the snapshot copies.
//
// If you specify a target Region, you must omit Target. You cannot specify
// a target Region and a target Outpost in the same rule.
TargetRegion *string `type:"string"`
// contains filtered or unexported fields
}
Specifies a rule for cross-Region snapshot copies.
func (s CrossRegionCopyRule) GoString() string
GoString returns the string representation
func (s *CrossRegionCopyRule) SetCmkArn(v string) *CrossRegionCopyRule
SetCmkArn sets the CmkArn field's value.
func (s *CrossRegionCopyRule) SetCopyTags(v bool) *CrossRegionCopyRule
SetCopyTags sets the CopyTags field's value.
func (s *CrossRegionCopyRule) SetEncrypted(v bool) *CrossRegionCopyRule
SetEncrypted sets the Encrypted field's value.
func (s *CrossRegionCopyRule) SetRetainRule(v *CrossRegionCopyRetainRule) *CrossRegionCopyRule
SetRetainRule sets the RetainRule field's value.
func (s *CrossRegionCopyRule) SetTarget(v string) *CrossRegionCopyRule
SetTarget sets the Target field's value.
func (s *CrossRegionCopyRule) SetTargetRegion(v string) *CrossRegionCopyRule
SetTargetRegion sets the TargetRegion field's value.
func (s CrossRegionCopyRule) String() string
String returns the string representation
func (s *CrossRegionCopyRule) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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(p client.ConfigProvider, cfgs ...*aws.Config) *DLM
New creates a new instance of the DLM client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession())
// Create a DLM client from just a session.
svc := dlm.New(mySession)
// Create a DLM client with additional configuration
svc := dlm.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *DLM) CreateLifecyclePolicy(input *CreateLifecyclePolicyInput) (*CreateLifecyclePolicyOutput, error)
CreateLifecyclePolicy API operation for Amazon Data Lifecycle Manager.
Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation CreateLifecyclePolicy for usage and error information.
Returned Error Types:
* InvalidRequestException Bad request. The request is missing required parameters or has invalid parameters. * LimitExceededException The request failed because a limit was exceeded. * InternalServerException The service failed in an unexpected way.
See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CreateLifecyclePolicy
func (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 (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 (c *DLM) DeleteLifecyclePolicy(input *DeleteLifecyclePolicyInput) (*DeleteLifecyclePolicyOutput, error)
DeleteLifecyclePolicy API operation for Amazon Data Lifecycle Manager.
Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation DeleteLifecyclePolicy for usage and error information.
Returned Error Types:
* ResourceNotFoundException A requested resource was not found. * InternalServerException The service failed in an unexpected way. * LimitExceededException The request failed because a limit was exceeded.
See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/DeleteLifecyclePolicy
func (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 (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 (c *DLM) GetLifecyclePolicies(input *GetLifecyclePoliciesInput) (*GetLifecyclePoliciesOutput, error)
GetLifecyclePolicies API operation for Amazon Data Lifecycle Manager.
Gets summary information about all or the specified data lifecycle policies.
To get complete information about a policy, use GetLifecyclePolicy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation GetLifecyclePolicies for usage and error information.
Returned Error Types:
* ResourceNotFoundException A requested resource was not found. * InvalidRequestException Bad request. The request is missing required parameters or has invalid parameters. * InternalServerException The service failed in an unexpected way. * LimitExceededException The request failed because a limit was exceeded.
See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/GetLifecyclePolicies
func (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 (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 (c *DLM) GetLifecyclePolicy(input *GetLifecyclePolicyInput) (*GetLifecyclePolicyOutput, error)
GetLifecyclePolicy API operation for Amazon Data Lifecycle Manager.
Gets detailed information about the specified lifecycle policy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation GetLifecyclePolicy for usage and error information.
Returned Error Types:
* ResourceNotFoundException A requested resource was not found. * InternalServerException The service failed in an unexpected way. * LimitExceededException The request failed because a limit was exceeded.
See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/GetLifecyclePolicy
func (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 (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 (c *DLM) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for Amazon Data Lifecycle Manager.
Lists the tags for the specified resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation ListTagsForResource for usage and error information.
Returned Error Types:
* InternalServerException The service failed in an unexpected way. * InvalidRequestException Bad request. The request is missing required parameters or has invalid parameters. * ResourceNotFoundException A requested resource was not found.
See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/ListTagsForResource
func (c *DLM) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/ListTagsForResource
func (c *DLM) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.
See ListTagsForResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *DLM) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for Amazon Data Lifecycle Manager.
Adds the specified tags to the specified resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation TagResource for usage and error information.
Returned Error Types:
* InternalServerException The service failed in an unexpected way. * InvalidRequestException Bad request. The request is missing required parameters or has invalid parameters. * ResourceNotFoundException A requested resource was not found.
See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/TagResource
func (c *DLM) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TagResource for more information on using the TagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/TagResource
func (c *DLM) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.
See TagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *DLM) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
UntagResource API operation for Amazon Data Lifecycle Manager.
Removes the specified tags from the specified resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation UntagResource for usage and error information.
Returned Error Types:
* InternalServerException The service failed in an unexpected way. * InvalidRequestException Bad request. The request is missing required parameters or has invalid parameters. * ResourceNotFoundException A requested resource was not found.
See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/UntagResource
func (c *DLM) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UntagResource for more information on using the UntagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/UntagResource
func (c *DLM) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.
See UntagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *DLM) UpdateLifecyclePolicy(input *UpdateLifecyclePolicyInput) (*UpdateLifecyclePolicyOutput, error)
UpdateLifecyclePolicy API operation for Amazon Data Lifecycle Manager.
Updates the specified lifecycle policy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Data Lifecycle Manager's API operation UpdateLifecyclePolicy for usage and error information.
Returned Error Types:
* ResourceNotFoundException A requested resource was not found. * InvalidRequestException Bad request. The request is missing required parameters or has invalid parameters. * InternalServerException The service failed in an unexpected way. * LimitExceededException The request failed because a limit was exceeded.
See also, https://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/UpdateLifecyclePolicy
func (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 (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 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 (s DeleteLifecyclePolicyInput) GoString() string
GoString returns the string representation
func (s *DeleteLifecyclePolicyInput) SetPolicyId(v string) *DeleteLifecyclePolicyInput
SetPolicyId sets the PolicyId field's value.
func (s DeleteLifecyclePolicyInput) String() string
String returns the string representation
func (s *DeleteLifecyclePolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteLifecyclePolicyOutput struct {
// contains filtered or unexported fields
}
func (s DeleteLifecyclePolicyOutput) GoString() string
GoString returns the string representation
func (s DeleteLifecyclePolicyOutput) String() string
String returns the string representation
type EncryptionConfiguration 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"`
// To encrypt a copy of an unencrypted snapshot when encryption by default is
// not enabled, enable encryption using this parameter. Copies of encrypted
// snapshots are encrypted, even if this parameter is false or when encryption
// by default is not enabled.
//
// Encrypted is a required field
Encrypted *bool `type:"boolean" required:"true"`
// contains filtered or unexported fields
}
Specifies the encryption settings for shared snapshots that are copied across Regions.
func (s EncryptionConfiguration) GoString() string
GoString returns the string representation
func (s *EncryptionConfiguration) SetCmkArn(v string) *EncryptionConfiguration
SetCmkArn sets the CmkArn field's value.
func (s *EncryptionConfiguration) SetEncrypted(v bool) *EncryptionConfiguration
SetEncrypted sets the Encrypted field's value.
func (s EncryptionConfiguration) String() string
String returns the string representation
func (s *EncryptionConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EventParameters struct {
// The snapshot description that can trigger the policy. The description pattern
// is specified using a regular expression. The policy runs only if a snapshot
// with a description that matches the specified pattern is shared with your
// account.
//
// For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$
// configures the policy to run only if snapshots created by policy policy-1234567890abcdef0
// are shared with your account.
//
// DescriptionRegex is a required field
DescriptionRegex *string `type:"string" required:"true"`
// The type of event. Currently, only snapshot sharing events are supported.
//
// EventType is a required field
EventType *string `type:"string" required:"true" enum:"EventTypeValues"`
// The IDs of the AWS accounts that can trigger policy by sharing snapshots
// with your account. The policy only runs if one of the specified AWS accounts
// shares a snapshot with your account.
//
// SnapshotOwner is a required field
SnapshotOwner []*string `type:"list" required:"true"`
// contains filtered or unexported fields
}
Specifies an event that triggers an event-based policy.
func (s EventParameters) GoString() string
GoString returns the string representation
func (s *EventParameters) SetDescriptionRegex(v string) *EventParameters
SetDescriptionRegex sets the DescriptionRegex field's value.
func (s *EventParameters) SetEventType(v string) *EventParameters
SetEventType sets the EventType field's value.
func (s *EventParameters) SetSnapshotOwner(v []*string) *EventParameters
SetSnapshotOwner sets the SnapshotOwner field's value.
func (s EventParameters) String() string
String returns the string representation
func (s *EventParameters) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EventSource struct {
// Information about the event.
Parameters *EventParameters `type:"structure"`
// The source of the event. Currently only managed AWS CloudWatch Events rules
// are supported.
//
// Type is a required field
Type *string `type:"string" required:"true" enum:"EventSourceValues"`
// contains filtered or unexported fields
}
Specifies an event that triggers an event-based policy.
func (s EventSource) GoString() string
GoString returns the string representation
func (s *EventSource) SetParameters(v *EventParameters) *EventSource
SetParameters sets the Parameters field's value.
func (s *EventSource) SetType(v string) *EventSource
SetType sets the Type field's value.
func (s EventSource) String() string
String returns the string representation
func (s *EventSource) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type FastRestoreRule struct {
// The Availability Zones in which to enable fast snapshot restore.
//
// AvailabilityZones is a required field
AvailabilityZones []*string `min:"1" type:"list" required:"true"`
// The number of snapshots to be enabled with fast snapshot restore.
Count *int64 `min:"1" type:"integer"`
// The amount of time to enable fast snapshot restore. The maximum is 100 years.
// This is equivalent to 1200 months, 5200 weeks, or 36500 days.
Interval *int64 `min:"1" type:"integer"`
// The unit of time for enabling fast snapshot restore.
IntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
// contains filtered or unexported fields
}
Specifies a rule for enabling fast snapshot restore. You can enable fast snapshot restore based on either a count or a time interval.
func (s FastRestoreRule) GoString() string
GoString returns the string representation
func (s *FastRestoreRule) SetAvailabilityZones(v []*string) *FastRestoreRule
SetAvailabilityZones sets the AvailabilityZones field's value.
func (s *FastRestoreRule) SetCount(v int64) *FastRestoreRule
SetCount sets the Count field's value.
func (s *FastRestoreRule) SetInterval(v int64) *FastRestoreRule
SetInterval sets the Interval field's value.
func (s *FastRestoreRule) SetIntervalUnit(v string) *FastRestoreRule
SetIntervalUnit sets the IntervalUnit field's value.
func (s FastRestoreRule) String() string
String returns the string representation
func (s *FastRestoreRule) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s GetLifecyclePoliciesInput) GoString() string
GoString returns the string representation
func (s *GetLifecyclePoliciesInput) SetPolicyIds(v []*string) *GetLifecyclePoliciesInput
SetPolicyIds sets the PolicyIds field's value.
func (s *GetLifecyclePoliciesInput) SetResourceTypes(v []*string) *GetLifecyclePoliciesInput
SetResourceTypes sets the ResourceTypes field's value.
func (s *GetLifecyclePoliciesInput) SetState(v string) *GetLifecyclePoliciesInput
SetState sets the State field's value.
func (s *GetLifecyclePoliciesInput) SetTagsToAdd(v []*string) *GetLifecyclePoliciesInput
SetTagsToAdd sets the TagsToAdd field's value.
func (s *GetLifecyclePoliciesInput) SetTargetTags(v []*string) *GetLifecyclePoliciesInput
SetTargetTags sets the TargetTags field's value.
func (s GetLifecyclePoliciesInput) String() string
String returns the string representation
func (s *GetLifecyclePoliciesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetLifecyclePoliciesOutput struct {
// Summary information about the lifecycle policies.
Policies []*LifecyclePolicySummary `type:"list"`
// contains filtered or unexported fields
}
func (s GetLifecyclePoliciesOutput) GoString() string
GoString returns the string representation
func (s *GetLifecyclePoliciesOutput) SetPolicies(v []*LifecyclePolicySummary) *GetLifecyclePoliciesOutput
SetPolicies sets the Policies field's value.
func (s GetLifecyclePoliciesOutput) String() string
String returns the string representation
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 (s GetLifecyclePolicyInput) GoString() string
GoString returns the string representation
func (s *GetLifecyclePolicyInput) SetPolicyId(v string) *GetLifecyclePolicyInput
SetPolicyId sets the PolicyId field's value.
func (s GetLifecyclePolicyInput) String() string
String returns the string representation
func (s *GetLifecyclePolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetLifecyclePolicyOutput struct {
// Detailed information about the lifecycle policy.
Policy *LifecyclePolicy `type:"structure"`
// contains filtered or unexported fields
}
func (s GetLifecyclePolicyOutput) GoString() string
GoString returns the string representation
func (s *GetLifecyclePolicyOutput) SetPolicy(v *LifecyclePolicy) *GetLifecyclePolicyOutput
SetPolicy sets the Policy field's value.
func (s GetLifecyclePolicyOutput) String() string
String returns the string representation
type InternalServerException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Code_ *string `locationName:"Code" type:"string"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
The service failed in an unexpected way.
func (s *InternalServerException) Code() string
Code returns the exception type name.
func (s *InternalServerException) Error() string
func (s InternalServerException) GoString() string
GoString returns the string representation
func (s *InternalServerException) Message() string
Message returns the exception's message.
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InternalServerException) String() string
String returns the string representation
type InvalidRequestException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Code_ *string `locationName:"Code" type:"string"`
Message_ *string `locationName:"Message" type:"string"`
// The request included parameters that cannot be provided together.
MutuallyExclusiveParameters []*string `type:"list"`
// The request omitted one or more required parameters.
RequiredParameters []*string `type:"list"`
// contains filtered or unexported fields
}
Bad request. The request is missing required parameters or has invalid parameters.
func (s *InvalidRequestException) Code() string
Code returns the exception type name.
func (s *InvalidRequestException) Error() string
func (s InvalidRequestException) GoString() string
GoString returns the string representation
func (s *InvalidRequestException) Message() string
Message returns the exception's message.
func (s *InvalidRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidRequestException) String() string
String returns the string representation
type LifecyclePolicy struct {
// The local date and time when the lifecycle policy was created.
DateCreated *time.Time `type:"timestamp" timestampFormat:"iso8601"`
// The local date and time when the lifecycle policy was last modified.
DateModified *time.Time `type:"timestamp" timestampFormat:"iso8601"`
// The description of the lifecycle policy.
Description *string `type:"string"`
// The Amazon Resource Name (ARN) of the IAM role used to run the operations
// specified by the lifecycle policy.
ExecutionRoleArn *string `type:"string"`
// The Amazon Resource Name (ARN) of the policy.
PolicyArn *string `type:"string"`
// The configuration of the lifecycle policy
PolicyDetails *PolicyDetails `type:"structure"`
// The identifier of the lifecycle policy.
PolicyId *string `type:"string"`
// The activation state of the lifecycle policy.
State *string `type:"string" enum:"GettablePolicyStateValues"`
// The description of the status.
StatusMessage *string `type:"string"`
// The tags.
Tags map[string]*string `min:"1" type:"map"`
// contains filtered or unexported fields
}
Detailed information about a lifecycle policy.
func (s LifecyclePolicy) GoString() string
GoString returns the string representation
func (s *LifecyclePolicy) SetDateCreated(v time.Time) *LifecyclePolicy
SetDateCreated sets the DateCreated field's value.
func (s *LifecyclePolicy) SetDateModified(v time.Time) *LifecyclePolicy
SetDateModified sets the DateModified field's value.
func (s *LifecyclePolicy) SetDescription(v string) *LifecyclePolicy
SetDescription sets the Description field's value.
func (s *LifecyclePolicy) SetExecutionRoleArn(v string) *LifecyclePolicy
SetExecutionRoleArn sets the ExecutionRoleArn field's value.
func (s *LifecyclePolicy) SetPolicyArn(v string) *LifecyclePolicy
SetPolicyArn sets the PolicyArn field's value.
func (s *LifecyclePolicy) SetPolicyDetails(v *PolicyDetails) *LifecyclePolicy
SetPolicyDetails sets the PolicyDetails field's value.
func (s *LifecyclePolicy) SetPolicyId(v string) *LifecyclePolicy
SetPolicyId sets the PolicyId field's value.
func (s *LifecyclePolicy) SetState(v string) *LifecyclePolicy
SetState sets the State field's value.
func (s *LifecyclePolicy) SetStatusMessage(v string) *LifecyclePolicy
SetStatusMessage sets the StatusMessage field's value.
func (s *LifecyclePolicy) SetTags(v map[string]*string) *LifecyclePolicy
SetTags sets the Tags field's value.
func (s LifecyclePolicy) String() string
String returns the string representation
type LifecyclePolicySummary struct {
// The description of the lifecycle policy.
Description *string `type:"string"`
// The identifier of the lifecycle policy.
PolicyId *string `type:"string"`
// The type of policy. EBS_SNAPSHOT_MANAGEMENT indicates that the policy manages
// the lifecycle of Amazon EBS snapshots. IMAGE_MANAGEMENT indicates that the
// policy manages the lifecycle of EBS-backed AMIs.
PolicyType *string `type:"string" enum:"PolicyTypeValues"`
// The activation state of the lifecycle policy.
State *string `type:"string" enum:"GettablePolicyStateValues"`
// The tags.
Tags map[string]*string `min:"1" type:"map"`
// contains filtered or unexported fields
}
Summary information about a lifecycle policy.
func (s LifecyclePolicySummary) GoString() string
GoString returns the string representation
func (s *LifecyclePolicySummary) SetDescription(v string) *LifecyclePolicySummary
SetDescription sets the Description field's value.
func (s *LifecyclePolicySummary) SetPolicyId(v string) *LifecyclePolicySummary
SetPolicyId sets the PolicyId field's value.
func (s *LifecyclePolicySummary) SetPolicyType(v string) *LifecyclePolicySummary
SetPolicyType sets the PolicyType field's value.
func (s *LifecyclePolicySummary) SetState(v string) *LifecyclePolicySummary
SetState sets the State field's value.
func (s *LifecyclePolicySummary) SetTags(v map[string]*string) *LifecyclePolicySummary
SetTags sets the Tags field's value.
func (s LifecyclePolicySummary) String() string
String returns the string representation
type LimitExceededException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Code_ *string `locationName:"Code" type:"string"`
Message_ *string `locationName:"Message" type:"string"`
// Value is the type of resource for which a limit was exceeded.
ResourceType *string `type:"string"`
// contains filtered or unexported fields
}
The request failed because a limit was exceeded.
func (s *LimitExceededException) Code() string
Code returns the exception type name.
func (s *LimitExceededException) Error() string
func (s LimitExceededException) GoString() string
GoString returns the string representation
func (s *LimitExceededException) Message() string
Message returns the exception's message.
func (s *LimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *LimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *LimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s LimitExceededException) String() string
String returns the string representation
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 (s ListTagsForResourceInput) GoString() string
GoString returns the string representation
func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput struct {
// Information about the tags.
Tags map[string]*string `min:"1" type:"map"`
// contains filtered or unexported fields
}
func (s ListTagsForResourceOutput) GoString() string
GoString returns the string representation
func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
func (s ListTagsForResourceOutput) String() string
String returns the string representation
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"`
// Applies to AMI lifecycle policies only. Indicates whether targeted instances
// are rebooted when the lifecycle policy runs. true indicates that targeted
// instances are not rebooted when the policy runs. false indicates that target
// instances are rebooted when the policy runs. The default is true (instances
// are not rebooted).
NoReboot *bool `type:"boolean"`
// contains filtered or unexported fields
}
Specifies optional parameters to add to a policy. The set of valid parameters depends on the combination of policy type and resource type.
func (s Parameters) GoString() string
GoString returns the string representation
func (s *Parameters) SetExcludeBootVolume(v bool) *Parameters
SetExcludeBootVolume sets the ExcludeBootVolume field's value.
func (s *Parameters) SetNoReboot(v bool) *Parameters
SetNoReboot sets the NoReboot field's value.
func (s Parameters) String() string
String returns the string representation
type PolicyDetails struct {
// The actions to be performed when the event-based policy is triggered. You
// can specify only one action per policy.
//
// This parameter is required for event-based policies only. If you are creating
// a snapshot or AMI policy, omit this parameter.
Actions []*Action `min:"1" type:"list"`
// The event that triggers the event-based policy.
//
// This parameter is required for event-based policies only. If you are creating
// a snapshot or AMI policy, omit this parameter.
EventSource *EventSource `type:"structure"`
// A set of optional parameters for snapshot and AMI lifecycle policies.
//
// This parameter is required for snapshot and AMI policies only. If you are
// creating an event-based policy, omit this parameter.
Parameters *Parameters `type:"structure"`
// The valid target resource types and actions a policy can manage. Specify
// EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle
// of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy
// that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY
// to create an event-based policy that performs specific actions when a defined
// event occurs in your AWS account.
//
// The default is EBS_SNAPSHOT_MANAGEMENT.
PolicyType *string `type:"string" enum:"PolicyTypeValues"`
// The location of the resources to backup. If the source resources are located
// in an AWS Region, specify CLOUD. If the source resources are located on an
// AWS Outpost in your account, specify OUTPOST.
//
// If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources
// of the specified type with matching target tags across all of the Outposts
// in your account.
ResourceLocations []*string `min:"1" type:"list"`
// The target resource type for snapshot and AMI lifecycle policies. Use VOLUME
// to create snapshots of individual volumes or use INSTANCE to create multi-volume
// snapshots from the volumes for an instance.
//
// This parameter is required for snapshot and AMI policies only. If you are
// creating an event-based policy, omit this parameter.
ResourceTypes []*string `min:"1" type:"list"`
// The schedules of policy-defined actions for snapshot and AMI lifecycle policies.
// A policy can have up to four schedules—one mandatory schedule and up to
// three optional schedules.
//
// This parameter is required for snapshot and AMI policies only. If you are
// creating an event-based policy, omit this parameter.
Schedules []*Schedule `min:"1" type:"list"`
// The single tag that identifies targeted resources for this policy.
//
// This parameter is required for snapshot and AMI policies only. If you are
// creating an event-based policy, omit this parameter.
TargetTags []*Tag `min:"1" type:"list"`
// contains filtered or unexported fields
}
Specifies the configuration of a lifecycle policy.
func (s PolicyDetails) GoString() string
GoString returns the string representation
func (s *PolicyDetails) SetActions(v []*Action) *PolicyDetails
SetActions sets the Actions field's value.
func (s *PolicyDetails) SetEventSource(v *EventSource) *PolicyDetails
SetEventSource sets the EventSource field's value.
func (s *PolicyDetails) SetParameters(v *Parameters) *PolicyDetails
SetParameters sets the Parameters field's value.
func (s *PolicyDetails) SetPolicyType(v string) *PolicyDetails
SetPolicyType sets the PolicyType field's value.
func (s *PolicyDetails) SetResourceLocations(v []*string) *PolicyDetails
SetResourceLocations sets the ResourceLocations field's value.
func (s *PolicyDetails) SetResourceTypes(v []*string) *PolicyDetails
SetResourceTypes sets the ResourceTypes field's value.
func (s *PolicyDetails) SetSchedules(v []*Schedule) *PolicyDetails
SetSchedules sets the Schedules field's value.
func (s *PolicyDetails) SetTargetTags(v []*Tag) *PolicyDetails
SetTargetTags sets the TargetTags field's value.
func (s PolicyDetails) String() string
String returns the string representation
func (s *PolicyDetails) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ResourceNotFoundException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Code_ *string `locationName:"Code" type:"string"`
Message_ *string `locationName:"Message" type:"string"`
// Value is a list of resource IDs that were not found.
ResourceIds []*string `type:"list"`
// Value is the type of resource that was not found.
ResourceType *string `type:"string"`
// contains filtered or unexported fields
}
A requested resource was not found.
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceNotFoundException) String() string
String returns the string representation
type RetainRule struct {
// The number of snapshots to retain for each volume, up to a maximum of 1000.
Count *int64 `min:"1" type:"integer"`
// The amount of time to retain each snapshot. The maximum is 100 years. This
// is equivalent to 1200 months, 5200 weeks, or 36500 days.
Interval *int64 `min:"1" type:"integer"`
// The unit of time for time-based retention.
IntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
// contains filtered or unexported fields
}
Specifies the retention rule for a lifecycle policy. You can retain snapshots based on either a count or a time interval.
func (s RetainRule) GoString() string
GoString returns the string representation
func (s *RetainRule) SetCount(v int64) *RetainRule
SetCount sets the Count field's value.
func (s *RetainRule) SetInterval(v int64) *RetainRule
SetInterval sets the Interval field's value.
func (s *RetainRule) SetIntervalUnit(v string) *RetainRule
SetIntervalUnit sets the IntervalUnit field's value.
func (s RetainRule) String() string
String returns the string representation
func (s *RetainRule) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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.
//
// You can only specify cross-Region copy rules for policies that create snapshots
// in a Region. If the policy creates snapshots on an Outpost, then you cannot
// copy the snapshots to a Region or to an Outpost. If the policy creates snapshots
// in a Region, then snapshots can be copied to up to three Regions or Outposts.
CrossRegionCopyRules []*CrossRegionCopyRule `type:"list"`
// 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 rule for sharing snapshots with other AWS accounts.
ShareRules []*ShareRule `type:"list"`
// 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 for a snapshot or AMI lifecycle policy.
func (s Schedule) GoString() string
GoString returns the string representation
func (s *Schedule) SetCopyTags(v bool) *Schedule
SetCopyTags sets the CopyTags field's value.
func (s *Schedule) SetCreateRule(v *CreateRule) *Schedule
SetCreateRule sets the CreateRule field's value.
func (s *Schedule) SetCrossRegionCopyRules(v []*CrossRegionCopyRule) *Schedule
SetCrossRegionCopyRules sets the CrossRegionCopyRules field's value.
func (s *Schedule) SetFastRestoreRule(v *FastRestoreRule) *Schedule
SetFastRestoreRule sets the FastRestoreRule field's value.
func (s *Schedule) SetName(v string) *Schedule
SetName sets the Name field's value.
func (s *Schedule) SetRetainRule(v *RetainRule) *Schedule
SetRetainRule sets the RetainRule field's value.
func (s *Schedule) SetShareRules(v []*ShareRule) *Schedule
SetShareRules sets the ShareRules field's value.
func (s *Schedule) SetTagsToAdd(v []*Tag) *Schedule
SetTagsToAdd sets the TagsToAdd field's value.
func (s *Schedule) SetVariableTags(v []*Tag) *Schedule
SetVariableTags sets the VariableTags field's value.
func (s Schedule) String() string
String returns the string representation
func (s *Schedule) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ShareRule struct {
// The IDs of the AWS accounts with which to share the snapshots.
//
// TargetAccounts is a required field
TargetAccounts []*string `min:"1" type:"list" required:"true"`
// The period after which snapshots that are shared with other AWS accounts
// are automatically unshared.
UnshareInterval *int64 `min:"1" type:"integer"`
// The unit of time for the automatic unsharing interval.
UnshareIntervalUnit *string `type:"string" enum:"RetentionIntervalUnitValues"`
// contains filtered or unexported fields
}
Specifies a rule for sharing snapshots across AWS accounts.
func (s ShareRule) GoString() string
GoString returns the string representation
func (s *ShareRule) SetTargetAccounts(v []*string) *ShareRule
SetTargetAccounts sets the TargetAccounts field's value.
func (s *ShareRule) SetUnshareInterval(v int64) *ShareRule
SetUnshareInterval sets the UnshareInterval field's value.
func (s *ShareRule) SetUnshareIntervalUnit(v string) *ShareRule
SetUnshareIntervalUnit sets the UnshareIntervalUnit field's value.
func (s ShareRule) String() string
String returns the string representation
func (s *ShareRule) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s Tag) GoString() string
GoString returns the string representation
func (s *Tag) SetKey(v string) *Tag
SetKey sets the Key field's value.
func (s *Tag) SetValue(v string) *Tag
SetValue sets the Value field's value.
func (s Tag) String() string
String returns the string representation
func (s *Tag) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s TagResourceInput) GoString() string
GoString returns the string representation
func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput
SetTags sets the Tags field's value.
func (s TagResourceInput) String() string
String returns the string representation
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (s TagResourceOutput) GoString() string
GoString returns the string representation
func (s TagResourceOutput) String() string
String returns the string representation
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 (s UntagResourceInput) GoString() string
GoString returns the string representation
func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput
SetTagKeys sets the TagKeys field's value.
func (s UntagResourceInput) String() string
String returns the string representation
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (s UntagResourceOutput) GoString() string
GoString returns the string representation
func (s UntagResourceOutput) String() string
String returns the string representation
type UpdateLifecyclePolicyInput struct {
// A description of the lifecycle policy.
Description *string `type:"string"`
// The Amazon Resource Name (ARN) of the IAM role used to run the operations
// specified by the lifecycle policy.
ExecutionRoleArn *string `type:"string"`
// The configuration of the lifecycle policy. You cannot update the policy type
// or the resource type.
PolicyDetails *PolicyDetails `type:"structure"`
// The identifier of the lifecycle policy.
//
// PolicyId is a required field
PolicyId *string `location:"uri" locationName:"policyId" type:"string" required:"true"`
// The desired activation state of the lifecycle policy after creation.
State *string `type:"string" enum:"SettablePolicyStateValues"`
// contains filtered or unexported fields
}
func (s UpdateLifecyclePolicyInput) GoString() string
GoString returns the string representation
func (s *UpdateLifecyclePolicyInput) SetDescription(v string) *UpdateLifecyclePolicyInput
SetDescription sets the Description field's value.
func (s *UpdateLifecyclePolicyInput) SetExecutionRoleArn(v string) *UpdateLifecyclePolicyInput
SetExecutionRoleArn sets the ExecutionRoleArn field's value.
func (s *UpdateLifecyclePolicyInput) SetPolicyDetails(v *PolicyDetails) *UpdateLifecyclePolicyInput
SetPolicyDetails sets the PolicyDetails field's value.
func (s *UpdateLifecyclePolicyInput) SetPolicyId(v string) *UpdateLifecyclePolicyInput
SetPolicyId sets the PolicyId field's value.
func (s *UpdateLifecyclePolicyInput) SetState(v string) *UpdateLifecyclePolicyInput
SetState sets the State field's value.
func (s UpdateLifecyclePolicyInput) String() string
String returns the string representation
func (s *UpdateLifecyclePolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateLifecyclePolicyOutput struct {
// contains filtered or unexported fields
}
func (s UpdateLifecyclePolicyOutput) GoString() string
GoString returns the string representation
func (s UpdateLifecyclePolicyOutput) String() string
String returns the string representation