1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package dlm
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/dlm/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data
// Lifecycle Manager supports the following policy types:
// - Custom EBS snapshot policy
// - Custom EBS-backed AMI policy
// - Cross-account copy event policy
// - Default policy for EBS snapshots
// - Default policy for EBS-backed AMIs
//
// For more information, see Default policies vs custom policies (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/policy-differences.html)
// . If you create a default policy, you can specify the request parameters either
// in the request body, or in the PolicyDetails request structure, but not both.
func (c *Client) CreateLifecyclePolicy(ctx context.Context, params *CreateLifecyclePolicyInput, optFns ...func(*Options)) (*CreateLifecyclePolicyOutput, error) {
if params == nil {
params = &CreateLifecyclePolicyInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateLifecyclePolicy", params, optFns, c.addOperationCreateLifecyclePolicyMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateLifecyclePolicyOutput)
out.ResultMetadata = metadata
return out, nil
}
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 activation state of the lifecycle policy after creation.
//
// This member is required.
State types.SettablePolicyStateValues
// [Default policies only] Indicates whether the policy should copy tags from the
// source resource to the snapshot or AMI. If you do not specify a value, the
// default is false . Default: false
CopyTags *bool
// [Default policies only] Specifies how often the policy should run and create
// snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do
// not specify a value, the default is 1. Default: 1
CreateInterval *int32
// [Default policies only] Specifies destination Regions for snapshot or AMI
// copies. You can specify up to 3 destination Regions. If you do not want to
// create cross-Region copies, omit this parameter.
CrossRegionCopyTargets []types.CrossRegionCopyTarget
// [Default policies only] Specify the type of default policy to create.
// - To create a default policy for EBS snapshots, that creates snapshots of all
// volumes in the Region that do not have recent backups, specify VOLUME .
// - To create a default policy for EBS-backed AMIs, that creates EBS-backed
// AMIs from all instances in the Region that do not have recent backups, specify
// INSTANCE .
DefaultPolicy types.DefaultPolicyTypeValues
// [Default policies only] Specifies exclusion parameters for volumes or instances
// for which you do not want to create snapshots or AMIs. The policy will not
// create snapshots or AMIs for target resources that match any of the specified
// exclusion parameters.
Exclusions *types.Exclusions
// [Default policies only] Defines the snapshot or AMI retention behavior for the
// policy if the source volume or instance is deleted, or if the policy enters the
// error, disabled, or deleted state. By default (ExtendDeletion=false):
// - If a source resource is deleted, Amazon Data Lifecycle Manager will
// continue to delete previously created snapshots or AMIs, up to but not including
// the last one, based on the specified retention period. If you want Amazon Data
// Lifecycle Manager to delete all snapshots or AMIs, including the last one,
// specify true .
// - If a policy enters the error, disabled, or deleted state, Amazon Data
// Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data
// Lifecycle Manager to continue deleting snapshots or AMIs, including the last
// one, if the policy enters one of these states, specify true .
// If you enable extended deletion (ExtendDeletion=true), you override both
// default behaviors simultaneously. If you do not specify a value, the default is
// false . Default: false
ExtendDeletion *bool
// The configuration details of the lifecycle policy. If you create a default
// policy, you can specify the request parameters either in the request body, or in
// the PolicyDetails request structure, but not both.
PolicyDetails *types.PolicyDetails
// [Default policies only] Specifies how long the policy should retain snapshots
// or AMIs before deleting them. The retention period can range from 2 to 14 days,
// but it must be greater than the creation frequency to ensure that the policy
// retains at least 1 snapshot or AMI at any given time. If you do not specify a
// value, the default is 7. Default: 7
RetainInterval *int32
// The tags to apply to the lifecycle policy during creation.
Tags map[string]string
noSmithyDocumentSerde
}
type CreateLifecyclePolicyOutput struct {
// The identifier of the lifecycle policy.
PolicyId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateLifecyclePolicyMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateLifecyclePolicy{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateLifecyclePolicy{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateLifecyclePolicy"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpCreateLifecyclePolicyValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateLifecyclePolicy(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateLifecyclePolicy(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateLifecyclePolicy",
}
}
|