/*******************************************************************************
* 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.Neptune;
using Amazon.Neptune.Model;
namespace Amazon.PowerShell.Cmdlets.NPT
{
/// <summary>
/// Copies a snapshot of a DB cluster.
///
///
/// <para>
/// To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code>
/// must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
/// </para>
/// </summary>
[Cmdlet("Copy", "NPTDBClusterSnapshot", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.Neptune.Model.DBClusterSnapshot")]
[AWSCmdlet("Calls the Amazon Neptune CopyDBClusterSnapshot API operation.", Operation = new[] {"CopyDBClusterSnapshot"}, SelectReturnType = typeof(Amazon.Neptune.Model.CopyDBClusterSnapshotResponse))]
[AWSCmdletOutput("Amazon.Neptune.Model.DBClusterSnapshot or Amazon.Neptune.Model.CopyDBClusterSnapshotResponse",
"This cmdlet returns an Amazon.Neptune.Model.DBClusterSnapshot object.",
"The service call response (type Amazon.Neptune.Model.CopyDBClusterSnapshotResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class CopyNPTDBClusterSnapshotCmdlet : AmazonNeptuneClientCmdlet, IExecutor
{
#region Parameter CopyTag
/// <summary>
/// <para>
/// <para>True to copy all tags from the source DB cluster snapshot to the target DB cluster
/// snapshot, and otherwise false. The default is false.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("CopyTags")]
public System.Boolean? CopyTag { get; set; }
#endregion
#region Parameter KmsKeyId
/// <summary>
/// <para>
/// <para>The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID
/// is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the
/// KMS encryption key.</para><para>If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify
/// a value for <code>KmsKeyId</code> to encrypt the copy with a new KMS encryption key.
/// If you don't specify a value for <code>KmsKeyId</code>, then the copy of the DB cluster
/// snapshot is encrypted with the same KMS key as the source DB cluster snapshot.</para><para>If you copy an encrypted DB cluster snapshot that is shared from another Amazon account,
/// then you must specify a value for <code>KmsKeyId</code>.</para><para> KMS encryption keys are specific to the Amazon Region that they are created in, and
/// you can't use encryption keys from one Amazon Region in another Amazon Region.</para><para>You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try
/// to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter,
/// an error is returned.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String KmsKeyId { get; set; }
#endregion
#region Parameter PreSignedUrl
/// <summary>
/// <para>
/// <para>Not currently supported.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PreSignedUrl { get; set; }
#endregion
#region Parameter SourceDBClusterSnapshotIdentifier
/// <summary>
/// <para>
/// <para>The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.</para><para>Constraints:</para><ul><li><para>Must specify a valid system snapshot in the "available" state.</para></li><li><para>Specify a valid DB snapshot identifier.</para></li></ul><para>Example: <code>my-cluster-snapshot1</code></para>
/// </para>
/// </summary>
#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 SourceDBClusterSnapshotIdentifier { get; set; }
#endregion
#region Parameter SourceRegion
/// <summary>
/// <para>
/// 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.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SourceRegion { get; set; }
#endregion
#region Parameter Tag
/// <summary>
/// <para>
/// <para>The tags to assign to the new DB cluster snapshot copy.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.Neptune.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter TargetDBClusterSnapshotIdentifier
/// <summary>
/// <para>
/// <para>The identifier of the new DB cluster snapshot to create from the source DB cluster
/// snapshot. This parameter is not case-sensitive.</para><para>Constraints:</para><ul><li><para>Must contain from 1 to 63 letters, numbers, or hyphens.</para></li><li><para>First character must be a letter.</para></li><li><para>Cannot end with a hyphen or contain two consecutive hyphens.</para></li></ul><para>Example: <code>my-cluster-snapshot2</code></para>
/// </para>
/// </summary>
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String TargetDBClusterSnapshotIdentifier { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// Use the -Select parameter to control the cmdlet output. The default value is 'DBClusterSnapshot'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Neptune.Model.CopyDBClusterSnapshotResponse).
/// Specifying the name of a property of type Amazon.Neptune.Model.CopyDBClusterSnapshotResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "DBClusterSnapshot";
#endregion
#region Parameter PassThru
/// <summary>
/// Changes the cmdlet behavior to return the value passed to the SourceDBClusterSnapshotIdentifier parameter.
/// The -PassThru parameter is deprecated, use -Select '^SourceDBClusterSnapshotIdentifier' instead. This parameter will be removed in a future version.
/// </summary>
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SourceDBClusterSnapshotIdentifier' 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
/// <summary>
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
/// </summary>
[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.SourceDBClusterSnapshotIdentifier), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Copy-NPTDBClusterSnapshot (CopyDBClusterSnapshot)"))
{
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<Amazon.Neptune.Model.CopyDBClusterSnapshotResponse, CopyNPTDBClusterSnapshotCmdlet>(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.SourceDBClusterSnapshotIdentifier;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.SourceRegion = this.SourceRegion;
context.CopyTag = this.CopyTag;
context.KmsKeyId = this.KmsKeyId;
context.PreSignedUrl = this.PreSignedUrl;
context.SourceDBClusterSnapshotIdentifier = this.SourceDBClusterSnapshotIdentifier;
#if MODULAR
if (this.SourceDBClusterSnapshotIdentifier == null && ParameterWasBound(nameof(this.SourceDBClusterSnapshotIdentifier)))
{
WriteWarning("You are passing $null as a value for parameter SourceDBClusterSnapshotIdentifier 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<Amazon.Neptune.Model.Tag>(this.Tag);
}
context.TargetDBClusterSnapshotIdentifier = this.TargetDBClusterSnapshotIdentifier;
#if MODULAR
if (this.TargetDBClusterSnapshotIdentifier == null && ParameterWasBound(nameof(this.TargetDBClusterSnapshotIdentifier)))
{
WriteWarning("You are passing $null as a value for parameter TargetDBClusterSnapshotIdentifier 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.Neptune.Model.CopyDBClusterSnapshotRequest();
if (cmdletContext.SourceRegion != null)
{
request.SourceRegion = cmdletContext.SourceRegion;
}
if (cmdletContext.CopyTag != null)
{
request.CopyTags = cmdletContext.CopyTag.Value;
}
if (cmdletContext.KmsKeyId != null)
{
request.KmsKeyId = cmdletContext.KmsKeyId;
}
if (cmdletContext.PreSignedUrl != null)
{
request.PreSignedUrl = cmdletContext.PreSignedUrl;
}
if (cmdletContext.SourceDBClusterSnapshotIdentifier != null)
{
request.SourceDBClusterSnapshotIdentifier = cmdletContext.SourceDBClusterSnapshotIdentifier;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
if (cmdletContext.TargetDBClusterSnapshotIdentifier != null)
{
request.TargetDBClusterSnapshotIdentifier = cmdletContext.TargetDBClusterSnapshotIdentifier;
}
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.Neptune.Model.CopyDBClusterSnapshotResponse CallAWSServiceOperation(IAmazonNeptune client, Amazon.Neptune.Model.CopyDBClusterSnapshotRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Neptune", "CopyDBClusterSnapshot");
try
{
#if DESKTOP
return client.CopyDBClusterSnapshot(request);
#elif CORECLR
return client.CopyDBClusterSnapshotAsync(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? CopyTag { get; set; }
public System.String KmsKeyId { get; set; }
public System.String PreSignedUrl { get; set; }
public System.String SourceDBClusterSnapshotIdentifier { get; set; }
public List<Amazon.Neptune.Model.Tag> Tag { get; set; }
public System.String TargetDBClusterSnapshotIdentifier { get; set; }
public System.Func<Amazon.Neptune.Model.CopyDBClusterSnapshotResponse, CopyNPTDBClusterSnapshotCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.DBClusterSnapshot;
}
}
}