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 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package rds
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
presignedurlcust "github.com/aws/aws-sdk-go-v2/service/internal/presigned-url"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Copies the specified DB snapshot. The source DB snapshot must be in the
// available state.
//
// You can copy a snapshot from one Amazon Web Services Region to another. In that
// case, the Amazon Web Services Region where you call the CopyDBSnapshot
// operation is the destination Amazon Web Services Region for the DB snapshot
// copy.
//
// This command doesn't apply to RDS Custom.
//
// For more information about copying snapshots, see [Copying a DB Snapshot] in the Amazon RDS User Guide.
//
// [Copying a DB Snapshot]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBSnapshot
func (c *Client) CopyDBSnapshot(ctx context.Context, params *CopyDBSnapshotInput, optFns ...func(*Options)) (*CopyDBSnapshotOutput, error) {
if params == nil {
params = &CopyDBSnapshotInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CopyDBSnapshot", params, optFns, c.addOperationCopyDBSnapshotMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CopyDBSnapshotOutput)
out.ResultMetadata = metadata
return out, nil
}
type CopyDBSnapshotInput struct {
// The identifier for the source DB snapshot.
//
// If the source snapshot is in the same Amazon Web Services Region as the copy,
// specify a valid DB snapshot identifier. For example, you might specify
// rds:mysql-instance1-snapshot-20130805 .
//
// If the source snapshot is in a different Amazon Web Services Region than the
// copy, specify a valid DB snapshot ARN. For example, you might specify
// arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805 .
//
// If you are copying from a shared manual DB snapshot, this parameter must be the
// Amazon Resource Name (ARN) of the shared DB snapshot.
//
// If you are copying an encrypted snapshot this parameter must be in the ARN
// format for the source Amazon Web Services Region.
//
// Constraints:
//
// - Must specify a valid system snapshot in the "available" state.
//
// Example: rds:mydb-2012-04-02-00-01
//
// Example:
// arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
//
// This member is required.
SourceDBSnapshotIdentifier *string
// The identifier for the copy of the snapshot.
//
// Constraints:
//
// - Can't be null, empty, or blank
//
// - Must contain from 1 to 255 letters, numbers, or hyphens
//
// - First character must be a letter
//
// - Can't end with a hyphen or contain two consecutive hyphens
//
// Example: my-db-snapshot
//
// This member is required.
TargetDBSnapshotIdentifier *string
// Specifies whether to copy the DB option group associated with the source DB
// snapshot to the target Amazon Web Services account and associate with the target
// DB snapshot. The associated option group can be copied only with cross-account
// snapshot copy calls.
CopyOptionGroup *bool
// Specifies whether to copy all tags from the source DB snapshot to the target DB
// snapshot. By default, tags aren't copied.
CopyTags *bool
// The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The
// Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or
// alias name for the KMS key.
//
// If you copy an encrypted DB snapshot from your Amazon Web Services account, you
// can specify a value for this parameter to encrypt the copy with a new KMS key.
// If you don't specify a value for this parameter, then the copy of the DB
// snapshot is encrypted with the same Amazon Web Services KMS key as the source DB
// snapshot.
//
// If you copy an encrypted DB snapshot that is shared from another Amazon Web
// Services account, then you must specify a value for this parameter.
//
// If you specify this parameter when you copy an unencrypted snapshot, the copy
// is encrypted.
//
// If you copy an encrypted snapshot to a different Amazon Web Services Region,
// then you must specify an Amazon Web Services KMS key identifier for the
// destination Amazon Web Services Region. KMS keys are specific to the Amazon Web
// Services Region that they are created in, and you can't use KMS keys from one
// Amazon Web Services Region in another Amazon Web Services Region.
KmsKeyId *string
// The name of an option group to associate with the copy of the snapshot.
//
// Specify this option if you are copying a snapshot from one Amazon Web Services
// Region to another, and your DB instance uses a nondefault option group. If your
// source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL
// Server, you must specify this option when copying across Amazon Web Services
// Regions. For more information, see [Option group considerations]in the Amazon RDS User Guide.
//
// [Option group considerations]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options
OptionGroupName *string
// When you are copying a snapshot from one Amazon Web Services GovCloud (US)
// Region to another, the URL that contains a Signature Version 4 signed request
// for the CopyDBSnapshot API operation in the source Amazon Web Services Region
// that contains the source DB snapshot to copy.
//
// This setting applies only to Amazon Web Services GovCloud (US) Regions. It's
// ignored in other Amazon Web Services Regions.
//
// You must specify this parameter when you copy an encrypted DB snapshot from
// another Amazon Web Services Region by using the Amazon RDS API. Don't specify
// PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon
// Web Services Region.
//
// The presigned URL must be a valid request for the CopyDBClusterSnapshot API
// operation that can run in the source Amazon Web Services Region that contains
// the encrypted DB cluster snapshot to copy. The presigned URL request must
// contain the following parameter values:
//
// - DestinationRegion - The Amazon Web Services Region that the encrypted DB
// snapshot is copied to. This Amazon Web Services Region is the same one where the
// CopyDBSnapshot operation is called that contains this presigned URL.
//
// For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web
// Services Region to the us-east-1 Amazon Web Services Region, then you call the
// CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and
// provide a presigned URL that contains a call to the CopyDBSnapshot operation
// in the us-west-2 Amazon Web Services Region. For this example, the
// DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web
// Services Region.
//
// - KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy
// of the DB snapshot in the destination Amazon Web Services Region. This is the
// same identifier for both the CopyDBSnapshot operation that is called in the
// destination Amazon Web Services Region, and the operation contained in the
// presigned URL.
//
// - SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted
// snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN)
// format for the source Amazon Web Services Region. For example, if you are
// copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region,
// then your SourceDBSnapshotIdentifier looks like the following example:
// arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115 .
//
// To learn how to generate a Signature Version 4 signed request, see [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)] and [Signature Version 4 Signing Process].
//
// If you are using an Amazon Web Services SDK tool or the CLI, you can specify
// SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl
// manually. Specifying SourceRegion autogenerates a presigned URL that is a valid
// request for the operation that can run in the source Amazon Web Services Region.
//
// [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
// [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
PreSignedUrl *string
// The AWS region the resource is in. The presigned URL will be created with this
// region, if the PresignURL member is empty set.
SourceRegion *string
// A list of tags. For more information, see [Tagging Amazon RDS Resources] in the Amazon RDS User Guide.
//
// [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
Tags []types.Tag
// The external custom Availability Zone (CAZ) identifier for the target CAZ.
//
// Example: rds-caz-aiqhTgQv .
TargetCustomAvailabilityZone *string
// Used by the SDK's PresignURL autofill customization to specify the region the
// of the client's request.
destinationRegion *string
noSmithyDocumentSerde
}
type CopyDBSnapshotOutput struct {
// Contains the details of an Amazon RDS DB snapshot.
//
// This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshot *types.DBSnapshot
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCopyDBSnapshotMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsquery_serializeOpCopyDBSnapshot{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpCopyDBSnapshot{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CopyDBSnapshot"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addCopyDBSnapshotPresignURLMiddleware(stack, options); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpCopyDBSnapshotValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCopyDBSnapshot(options.Region), middleware.Before); err != nil {
return err
}
if err = 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 copyCopyDBSnapshotInputForPresign(params interface{}) (interface{}, error) {
input, ok := params.(*CopyDBSnapshotInput)
if !ok {
return nil, fmt.Errorf("expect *CopyDBSnapshotInput type, got %T", params)
}
cpy := *input
return &cpy, nil
}
func getCopyDBSnapshotPreSignedUrl(params interface{}) (string, bool, error) {
input, ok := params.(*CopyDBSnapshotInput)
if !ok {
return ``, false, fmt.Errorf("expect *CopyDBSnapshotInput type, got %T", params)
}
if input.PreSignedUrl == nil || len(*input.PreSignedUrl) == 0 {
return ``, false, nil
}
return *input.PreSignedUrl, true, nil
}
func getCopyDBSnapshotSourceRegion(params interface{}) (string, bool, error) {
input, ok := params.(*CopyDBSnapshotInput)
if !ok {
return ``, false, fmt.Errorf("expect *CopyDBSnapshotInput type, got %T", params)
}
if input.SourceRegion == nil || len(*input.SourceRegion) == 0 {
return ``, false, nil
}
return *input.SourceRegion, true, nil
}
func setCopyDBSnapshotPreSignedUrl(params interface{}, value string) error {
input, ok := params.(*CopyDBSnapshotInput)
if !ok {
return fmt.Errorf("expect *CopyDBSnapshotInput type, got %T", params)
}
input.PreSignedUrl = &value
return nil
}
func setCopyDBSnapshotdestinationRegion(params interface{}, value string) error {
input, ok := params.(*CopyDBSnapshotInput)
if !ok {
return fmt.Errorf("expect *CopyDBSnapshotInput type, got %T", params)
}
input.destinationRegion = &value
return nil
}
func addCopyDBSnapshotPresignURLMiddleware(stack *middleware.Stack, options Options) error {
return presignedurlcust.AddMiddleware(stack, presignedurlcust.Options{
Accessor: presignedurlcust.ParameterAccessor{
GetPresignedURL: getCopyDBSnapshotPreSignedUrl,
GetSourceRegion: getCopyDBSnapshotSourceRegion,
CopyInput: copyCopyDBSnapshotInputForPresign,
SetDestinationRegion: setCopyDBSnapshotdestinationRegion,
SetPresignedURL: setCopyDBSnapshotPreSignedUrl,
},
Presigner: &presignAutoFillCopyDBSnapshotClient{client: NewPresignClient(New(options))},
})
}
type presignAutoFillCopyDBSnapshotClient struct {
client *PresignClient
}
// PresignURL is a middleware accessor that satisfies URLPresigner interface.
func (c *presignAutoFillCopyDBSnapshotClient) PresignURL(ctx context.Context, srcRegion string, params interface{}) (*v4.PresignedHTTPRequest, error) {
input, ok := params.(*CopyDBSnapshotInput)
if !ok {
return nil, fmt.Errorf("expect *CopyDBSnapshotInput type, got %T", params)
}
optFn := func(o *Options) {
o.Region = srcRegion
o.APIOptions = append(o.APIOptions, presignedurlcust.RemoveMiddleware)
}
presignOptFn := WithPresignClientFromClientOptions(optFn)
return c.client.PresignCopyDBSnapshot(ctx, input, presignOptFn)
}
func newServiceMetadataMiddleware_opCopyDBSnapshot(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CopyDBSnapshot",
}
}
// PresignCopyDBSnapshot is used to generate a presigned HTTP Request which
// contains presigned URL, signed headers and HTTP method used.
func (c *PresignClient) PresignCopyDBSnapshot(ctx context.Context, params *CopyDBSnapshotInput, optFns ...func(*PresignOptions)) (*v4.PresignedHTTPRequest, error) {
if params == nil {
params = &CopyDBSnapshotInput{}
}
options := c.options.copy()
for _, fn := range optFns {
fn(&options)
}
clientOptFns := append(options.ClientOptions, withNopHTTPClientAPIOption)
result, _, err := c.client.invokeOperation(ctx, "CopyDBSnapshot", params, clientOptFns,
c.client.addOperationCopyDBSnapshotMiddlewares,
presignConverter(options).convertToPresignMiddleware,
)
if err != nil {
return nil, err
}
out := result.(*v4.PresignedHTTPRequest)
return out, nil
}
|