/*******************************************************************************
* 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.StorageGateway;
using Amazon.StorageGateway.Model;
namespace Amazon.PowerShell.Cmdlets.SG
{
///
/// Updates a snapshot schedule configured for a gateway volume. This operation is only
/// supported in the cached volume and stored volume gateway types.
///
///
///
/// The default snapshot schedule for volume is once every 24 hours, starting at the creation
/// time of the volume. You can use this API to change the snapshot schedule configured
/// for the volume.
///
/// In the request you must identify the gateway volume whose snapshot schedule you want
/// to update, and the schedule information, including when you want the snapshot to begin
/// on a day and the frequency (in hours) of snapshots.
///
///
[Cmdlet("Update", "SGSnapshotSchedule", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS Storage Gateway UpdateSnapshotSchedule API operation.", Operation = new[] {"UpdateSnapshotSchedule"}, SelectReturnType = typeof(Amazon.StorageGateway.Model.UpdateSnapshotScheduleResponse))]
[AWSCmdletOutput("System.String or Amazon.StorageGateway.Model.UpdateSnapshotScheduleResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.StorageGateway.Model.UpdateSnapshotScheduleResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateSGSnapshotScheduleCmdlet : AmazonStorageGatewayClientCmdlet, IExecutor
{
#region Parameter Description
///
///
/// Optional description of the snapshot that overwrites the existing description.
///
///
[System.Management.Automation.Parameter(Position = 3, ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter RecurrenceInHours
///
///
/// Frequency of snapshots. Specify the number of hours between snapshots.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.Int32? RecurrenceInHours { get; set; }
#endregion
#region Parameter StartAt
///
///
/// The hour of the day at which the snapshot schedule begins represented as hh,
/// where hh is the hour (0 to 23). The hour of the day is in the time zone of
/// the gateway.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.Int32? StartAt { get; set; }
#endregion
#region Parameter Tag
///
///
/// A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value
/// pair.Valid characters for key and value are letters, spaces, and numbers representable
/// in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum
/// length of a tag's key is 128 characters, and the maximum length for a tag's value
/// is 256.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.StorageGateway.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter VolumeARN
///
///
/// The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
/// to return a list of gateway volumes.
///
///
#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 VolumeARN { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'VolumeARN'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StorageGateway.Model.UpdateSnapshotScheduleResponse).
/// Specifying the name of a property of type Amazon.StorageGateway.Model.UpdateSnapshotScheduleResponse 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; } = "VolumeARN";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the VolumeARN parameter.
/// The -PassThru parameter is deprecated, use -Select '^VolumeARN' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^VolumeARN' 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.VolumeARN), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-SGSnapshotSchedule (UpdateSnapshotSchedule)"))
{
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.VolumeARN;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.Description = this.Description;
context.RecurrenceInHours = this.RecurrenceInHours;
#if MODULAR
if (this.RecurrenceInHours == null && ParameterWasBound(nameof(this.RecurrenceInHours)))
{
WriteWarning("You are passing $null as a value for parameter RecurrenceInHours 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
context.StartAt = this.StartAt;
#if MODULAR
if (this.StartAt == null && ParameterWasBound(nameof(this.StartAt)))
{
WriteWarning("You are passing $null as a value for parameter StartAt 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.VolumeARN = this.VolumeARN;
#if MODULAR
if (this.VolumeARN == null && ParameterWasBound(nameof(this.VolumeARN)))
{
WriteWarning("You are passing $null as a value for parameter VolumeARN 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.StorageGateway.Model.UpdateSnapshotScheduleRequest();
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.RecurrenceInHours != null)
{
request.RecurrenceInHours = cmdletContext.RecurrenceInHours.Value;
}
if (cmdletContext.StartAt != null)
{
request.StartAt = cmdletContext.StartAt.Value;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
if (cmdletContext.VolumeARN != null)
{
request.VolumeARN = cmdletContext.VolumeARN;
}
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.StorageGateway.Model.UpdateSnapshotScheduleResponse CallAWSServiceOperation(IAmazonStorageGateway client, Amazon.StorageGateway.Model.UpdateSnapshotScheduleRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Storage Gateway", "UpdateSnapshotSchedule");
try
{
#if DESKTOP
return client.UpdateSnapshotSchedule(request);
#elif CORECLR
return client.UpdateSnapshotScheduleAsync(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 Description { get; set; }
public System.Int32? RecurrenceInHours { get; set; }
public System.Int32? StartAt { get; set; }
public List Tag { get; set; }
public System.String VolumeARN { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.VolumeARN;
}
}
}