/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.RDS;
using Amazon.RDS.Model;
namespace Amazon.PowerShell.Cmdlets.RDS
{
///
/// 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.
///
///
[Cmdlet("Copy", "RDSDBSnapshot", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.RDS.Model.DBSnapshot")]
[AWSCmdlet("Calls the Amazon Relational Database Service CopyDBSnapshot API operation.", Operation = new[] {"CopyDBSnapshot"}, SelectReturnType = typeof(Amazon.RDS.Model.CopyDBSnapshotResponse))]
[AWSCmdletOutput("Amazon.RDS.Model.DBSnapshot or Amazon.RDS.Model.CopyDBSnapshotResponse",
"This cmdlet returns an Amazon.RDS.Model.DBSnapshot object.",
"The service call response (type Amazon.RDS.Model.CopyDBSnapshotResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class CopyRDSDBSnapshotCmdlet : AmazonRDSClientCmdlet, IExecutor
{
#region Parameter CopyOptionGroup
///
///
/// A value that indicates 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? CopyOptionGroup { get; set; }
#endregion
#region Parameter CopyTag
///
///
/// A value that indicates whether to copy all tags from the source DB snapshot to the
/// target DB snapshot. By default, tags aren't copied.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("CopyTags")]
public System.Boolean? CopyTag { get; set; }
#endregion
#region Parameter KmsKeyId
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String KmsKeyId { get; set; }
#endregion
#region Parameter OptionGroupName
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String OptionGroupName { get; set; }
#endregion
#region Parameter PreSignedUrl
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PreSignedUrl { get; set; }
#endregion
#region Parameter SourceDBSnapshotIdentifier
///
///
/// 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
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String SourceDBSnapshotIdentifier { get; set; }
#endregion
#region Parameter SourceRegion
///
///
/// The SourceRegion for generating the PreSignedUrl property.
///
/// If SourceRegion is set and the PreSignedUrl property is not,
/// then PreSignedUrl will be automatically generated by the client.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SourceRegion { get; set; }
#endregion
#region Parameter Tag
///
///
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.RDS.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter TargetCustomAvailabilityZone
///
///
/// The external custom Availability Zone (CAZ) identifier for the target CAZ.Example: rds-caz-aiqhTgQv
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TargetCustomAvailabilityZone { get; set; }
#endregion
#region Parameter TargetDBSnapshotIdentifier
///
///
/// 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
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String TargetDBSnapshotIdentifier { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'DBSnapshot'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.CopyDBSnapshotResponse).
/// Specifying the name of a property of type Amazon.RDS.Model.CopyDBSnapshotResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "DBSnapshot";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the SourceDBSnapshotIdentifier parameter.
/// The -PassThru parameter is deprecated, use -Select '^SourceDBSnapshotIdentifier' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SourceDBSnapshotIdentifier' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.SourceDBSnapshotIdentifier), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Copy-RDSDBSnapshot (CopyDBSnapshot)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.SourceDBSnapshotIdentifier;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.SourceRegion = this.SourceRegion;
context.CopyOptionGroup = this.CopyOptionGroup;
context.CopyTag = this.CopyTag;
context.KmsKeyId = this.KmsKeyId;
context.OptionGroupName = this.OptionGroupName;
context.PreSignedUrl = this.PreSignedUrl;
context.SourceDBSnapshotIdentifier = this.SourceDBSnapshotIdentifier;
#if MODULAR
if (this.SourceDBSnapshotIdentifier == null && ParameterWasBound(nameof(this.SourceDBSnapshotIdentifier)))
{
WriteWarning("You are passing $null as a value for parameter SourceDBSnapshotIdentifier which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
context.TargetCustomAvailabilityZone = this.TargetCustomAvailabilityZone;
context.TargetDBSnapshotIdentifier = this.TargetDBSnapshotIdentifier;
#if MODULAR
if (this.TargetDBSnapshotIdentifier == null && ParameterWasBound(nameof(this.TargetDBSnapshotIdentifier)))
{
WriteWarning("You are passing $null as a value for parameter TargetDBSnapshotIdentifier which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.RDS.Model.CopyDBSnapshotRequest();
if (cmdletContext.SourceRegion != null)
{
request.SourceRegion = cmdletContext.SourceRegion;
}
if (cmdletContext.CopyOptionGroup != null)
{
request.CopyOptionGroup = cmdletContext.CopyOptionGroup.Value;
}
if (cmdletContext.CopyTag != null)
{
request.CopyTags = cmdletContext.CopyTag.Value;
}
if (cmdletContext.KmsKeyId != null)
{
request.KmsKeyId = cmdletContext.KmsKeyId;
}
if (cmdletContext.OptionGroupName != null)
{
request.OptionGroupName = cmdletContext.OptionGroupName;
}
if (cmdletContext.PreSignedUrl != null)
{
request.PreSignedUrl = cmdletContext.PreSignedUrl;
}
if (cmdletContext.SourceDBSnapshotIdentifier != null)
{
request.SourceDBSnapshotIdentifier = cmdletContext.SourceDBSnapshotIdentifier;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
if (cmdletContext.TargetCustomAvailabilityZone != null)
{
request.TargetCustomAvailabilityZone = cmdletContext.TargetCustomAvailabilityZone;
}
if (cmdletContext.TargetDBSnapshotIdentifier != null)
{
request.TargetDBSnapshotIdentifier = cmdletContext.TargetDBSnapshotIdentifier;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.RDS.Model.CopyDBSnapshotResponse CallAWSServiceOperation(IAmazonRDS client, Amazon.RDS.Model.CopyDBSnapshotRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Relational Database Service", "CopyDBSnapshot");
try
{
#if DESKTOP
return client.CopyDBSnapshot(request);
#elif CORECLR
return client.CopyDBSnapshotAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.String SourceRegion { get; set; }
public System.Boolean? CopyOptionGroup { get; set; }
public System.Boolean? CopyTag { get; set; }
public System.String KmsKeyId { get; set; }
public System.String OptionGroupName { get; set; }
public System.String PreSignedUrl { get; set; }
public System.String SourceDBSnapshotIdentifier { get; set; }
public List Tag { get; set; }
public System.String TargetCustomAvailabilityZone { get; set; }
public System.String TargetDBSnapshotIdentifier { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.DBSnapshot;
}
}
}