/*******************************************************************************
* 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.Backup;
using Amazon.Backup.Model;
namespace Amazon.PowerShell.Cmdlets.BAK
{
///
/// Creates a backup plan using a backup plan name and backup rules. A backup plan is
/// a document that contains information that Backup uses to schedule tasks that create
/// recovery points for resources.
///
///
///
/// If you call CreateBackupPlan
with a plan that already exists, you receive
/// an AlreadyExistsException
exception.
///
///
[Cmdlet("New", "BAKBackupPlan", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.Backup.Model.CreateBackupPlanResponse")]
[AWSCmdlet("Calls the AWS Backup CreateBackupPlan API operation.", Operation = new[] {"CreateBackupPlan"}, SelectReturnType = typeof(Amazon.Backup.Model.CreateBackupPlanResponse))]
[AWSCmdletOutput("Amazon.Backup.Model.CreateBackupPlanResponse",
"This cmdlet returns an Amazon.Backup.Model.CreateBackupPlanResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewBAKBackupPlanCmdlet : AmazonBackupClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
#region Parameter BackupPlan_AdvancedBackupSetting
///
///
/// Specifies a list of BackupOptions
for each resource type. These settings
/// are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("BackupPlan_AdvancedBackupSettings")]
public Amazon.Backup.Model.AdvancedBackupSetting[] BackupPlan_AdvancedBackupSetting { get; set; }
#endregion
#region Parameter BackupPlan_BackupPlanName
///
///
/// The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
///
///
#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 BackupPlan_BackupPlanName { get; set; }
#endregion
#region Parameter BackupPlanTag
///
///
/// To help organize your resources, you can assign your own metadata to the resources
/// that you create. Each tag is a key-value pair. The specified tags are assigned to
/// all backups created with this plan.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("BackupPlanTags")]
public System.Collections.Hashtable BackupPlanTag { get; set; }
#endregion
#region Parameter CreatorRequestId
///
///
/// Identifies the request and allows failed requests to be retried without the risk of
/// running the operation twice. If the request includes a CreatorRequestId
/// that matches an existing backup plan, that plan is returned. This parameter is optional.If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String CreatorRequestId { get; set; }
#endregion
#region Parameter BackupPlan_Rule
///
///
/// An array of BackupRule
objects, each of which specifies a scheduled task
/// that is used to back up a selection of resources.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("BackupPlan_Rules")]
public Amazon.Backup.Model.BackupRuleInput[] BackupPlan_Rule { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.CreateBackupPlanResponse).
/// Specifying the name of a property of type Amazon.Backup.Model.CreateBackupPlanResponse 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; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the BackupPlan_BackupPlanName parameter.
/// The -PassThru parameter is deprecated, use -Select '^BackupPlan_BackupPlanName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^BackupPlan_BackupPlanName' 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 = string.Empty;
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-BAKBackupPlan (CreateBackupPlan)"))
{
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.BackupPlan_BackupPlanName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.BackupPlan_AdvancedBackupSetting != null)
{
context.BackupPlan_AdvancedBackupSetting = new List(this.BackupPlan_AdvancedBackupSetting);
}
context.BackupPlan_BackupPlanName = this.BackupPlan_BackupPlanName;
#if MODULAR
if (this.BackupPlan_BackupPlanName == null && ParameterWasBound(nameof(this.BackupPlan_BackupPlanName)))
{
WriteWarning("You are passing $null as a value for parameter BackupPlan_BackupPlanName 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.BackupPlan_Rule != null)
{
context.BackupPlan_Rule = new List(this.BackupPlan_Rule);
}
#if MODULAR
if (this.BackupPlan_Rule == null && ParameterWasBound(nameof(this.BackupPlan_Rule)))
{
WriteWarning("You are passing $null as a value for parameter BackupPlan_Rule 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.BackupPlanTag != null)
{
context.BackupPlanTag = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.BackupPlanTag.Keys)
{
context.BackupPlanTag.Add((String)hashKey, (String)(this.BackupPlanTag[hashKey]));
}
}
context.CreatorRequestId = this.CreatorRequestId;
// 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.Backup.Model.CreateBackupPlanRequest();
// populate BackupPlan
var requestBackupPlanIsNull = true;
request.BackupPlan = new Amazon.Backup.Model.BackupPlanInput();
List requestBackupPlan_backupPlan_AdvancedBackupSetting = null;
if (cmdletContext.BackupPlan_AdvancedBackupSetting != null)
{
requestBackupPlan_backupPlan_AdvancedBackupSetting = cmdletContext.BackupPlan_AdvancedBackupSetting;
}
if (requestBackupPlan_backupPlan_AdvancedBackupSetting != null)
{
request.BackupPlan.AdvancedBackupSettings = requestBackupPlan_backupPlan_AdvancedBackupSetting;
requestBackupPlanIsNull = false;
}
System.String requestBackupPlan_backupPlan_BackupPlanName = null;
if (cmdletContext.BackupPlan_BackupPlanName != null)
{
requestBackupPlan_backupPlan_BackupPlanName = cmdletContext.BackupPlan_BackupPlanName;
}
if (requestBackupPlan_backupPlan_BackupPlanName != null)
{
request.BackupPlan.BackupPlanName = requestBackupPlan_backupPlan_BackupPlanName;
requestBackupPlanIsNull = false;
}
List requestBackupPlan_backupPlan_Rule = null;
if (cmdletContext.BackupPlan_Rule != null)
{
requestBackupPlan_backupPlan_Rule = cmdletContext.BackupPlan_Rule;
}
if (requestBackupPlan_backupPlan_Rule != null)
{
request.BackupPlan.Rules = requestBackupPlan_backupPlan_Rule;
requestBackupPlanIsNull = false;
}
// determine if request.BackupPlan should be set to null
if (requestBackupPlanIsNull)
{
request.BackupPlan = null;
}
if (cmdletContext.BackupPlanTag != null)
{
request.BackupPlanTags = cmdletContext.BackupPlanTag;
}
if (cmdletContext.CreatorRequestId != null)
{
request.CreatorRequestId = cmdletContext.CreatorRequestId;
}
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.Backup.Model.CreateBackupPlanResponse CallAWSServiceOperation(IAmazonBackup client, Amazon.Backup.Model.CreateBackupPlanRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Backup", "CreateBackupPlan");
try
{
#if DESKTOP
return client.CreateBackupPlan(request);
#elif CORECLR
return client.CreateBackupPlanAsync(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 List BackupPlan_AdvancedBackupSetting { get; set; }
public System.String BackupPlan_BackupPlanName { get; set; }
public List BackupPlan_Rule { get; set; }
public Dictionary BackupPlanTag { get; set; }
public System.String CreatorRequestId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}