/*******************************************************************************
* 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
{
///
/// Displays backups for both current and deleted instances. For example, use this operation
/// to find details about automated backups for previously deleted instances. Current
/// instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups
/// and DescribeDBInstances
operations.
///
///
///
/// All parameters are optional.
///
This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.
///
[Cmdlet("Get", "RDSDBInstanceAutomatedBackup")]
[OutputType("Amazon.RDS.Model.DBInstanceAutomatedBackup")]
[AWSCmdlet("Calls the Amazon Relational Database Service DescribeDBInstanceAutomatedBackups API operation.", Operation = new[] {"DescribeDBInstanceAutomatedBackups"}, SelectReturnType = typeof(Amazon.RDS.Model.DescribeDBInstanceAutomatedBackupsResponse))]
[AWSCmdletOutput("Amazon.RDS.Model.DBInstanceAutomatedBackup or Amazon.RDS.Model.DescribeDBInstanceAutomatedBackupsResponse",
"This cmdlet returns a collection of Amazon.RDS.Model.DBInstanceAutomatedBackup objects.",
"The service call response (type Amazon.RDS.Model.DescribeDBInstanceAutomatedBackupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetRDSDBInstanceAutomatedBackupCmdlet : AmazonRDSClientCmdlet, IExecutor
{
#region Parameter DBInstanceAutomatedBackupsArn
///
///
/// The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.This setting doesn't apply to RDS Custom.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DBInstanceAutomatedBackupsArn { get; set; }
#endregion
#region Parameter DBInstanceIdentifier
///
///
/// (Optional) The user-supplied instance identifier. If this parameter is specified,
/// it must match the identifier of an existing DB instance. It returns information from
/// the specific DB instance' automated backup. This parameter isn't case-sensitive.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String DBInstanceIdentifier { get; set; }
#endregion
#region Parameter DbiResourceId
///
///
/// The resource ID of the DB instance that is the source of the automated backup. This
/// parameter isn't case-sensitive.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DbiResourceId { get; set; }
#endregion
#region Parameter Filter
///
///
/// A filter that specifies which resources to return based on status.Supported filters are the following:status
active
- automated backups for current instancesretained
- automated backups for deleted instances and after backup
/// replication is stoppedcreating
- automated backups that are waiting for the first automated
/// snapshot to be available
db-instance-id
- Accepts DB instance identifiers and Amazon Resource
/// Names (ARNs). The results list includes only information about the DB instance automated
/// backups identified by these ARNs.dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource
/// Names (ARNs). The results list includes only information about the DB instance resources
/// identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the
/// response.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Filters")]
public Amazon.RDS.Model.Filter[] Filter { get; set; }
#endregion
#region Parameter Marker
///
///
/// The pagination token provided in the previous request. If this parameter is specified
/// the response includes only records beyond the marker, up to MaxRecords
.
///
///
///
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
///
In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("NextToken")]
public System.String Marker { get; set; }
#endregion
#region Parameter MaxRecord
///
///
/// The maximum number of records to include in the response. If more records exist than
/// the specified MaxRecords
value, a pagination token called a marker is
/// included in the response so that you can retrieve the remaining results.
///
///
///
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet.
///
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call.
///
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxItems","MaxRecords")]
public int? MaxRecord { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'DBInstanceAutomatedBackups'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.DescribeDBInstanceAutomatedBackupsResponse).
/// Specifying the name of a property of type Amazon.RDS.Model.DescribeDBInstanceAutomatedBackupsResponse 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; } = "DBInstanceAutomatedBackups";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the DBInstanceIdentifier parameter.
/// The -PassThru parameter is deprecated, use -Select '^DBInstanceIdentifier' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DBInstanceIdentifier' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter NoAutoIteration
///
/// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple
/// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker
/// as the start point.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter NoAutoIteration { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
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.DBInstanceIdentifier;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.DBInstanceAutomatedBackupsArn = this.DBInstanceAutomatedBackupsArn;
context.DBInstanceIdentifier = this.DBInstanceIdentifier;
context.DbiResourceId = this.DbiResourceId;
if (this.Filter != null)
{
context.Filter = new List(this.Filter);
}
context.Marker = this.Marker;
context.MaxRecord = this.MaxRecord;
#if !MODULAR
if (ParameterWasBound(nameof(this.MaxRecord)) && this.MaxRecord.HasValue)
{
WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the MaxRecord parameter to limit the total number of items returned by the cmdlet." +
" This behavior is obsolete and will be removed in a future version of these modules. Pipe the output of this cmdlet into Select-Object -First to terminate" +
" retrieving data pages early and control the number of items returned. AWS.Tools already implements the new behavior of simply passing MaxRecord" +
" to the service to specify how many items should be returned by each service call.");
}
#endif
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
#if MODULAR
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
// create request and set iteration invariants
var request = new Amazon.RDS.Model.DescribeDBInstanceAutomatedBackupsRequest();
if (cmdletContext.DBInstanceAutomatedBackupsArn != null)
{
request.DBInstanceAutomatedBackupsArn = cmdletContext.DBInstanceAutomatedBackupsArn;
}
if (cmdletContext.DBInstanceIdentifier != null)
{
request.DBInstanceIdentifier = cmdletContext.DBInstanceIdentifier;
}
if (cmdletContext.DbiResourceId != null)
{
request.DbiResourceId = cmdletContext.DbiResourceId;
}
if (cmdletContext.Filter != null)
{
request.Filters = cmdletContext.Filter;
}
if (cmdletContext.MaxRecord != null)
{
request.MaxRecords = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.MaxRecord.Value);
}
// Initialize loop variant and commence piping
var _nextToken = cmdletContext.Marker;
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.Marker = _nextToken;
CmdletOutput output;
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
if (!useParameterSelect)
{
pipelineOutput = cmdletContext.Select(response, this);
}
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
_nextToken = response.Marker;
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return null;
}
#else
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent;
// create request and set iteration invariants
var request = new Amazon.RDS.Model.DescribeDBInstanceAutomatedBackupsRequest();
if (cmdletContext.DBInstanceAutomatedBackupsArn != null)
{
request.DBInstanceAutomatedBackupsArn = cmdletContext.DBInstanceAutomatedBackupsArn;
}
if (cmdletContext.DBInstanceIdentifier != null)
{
request.DBInstanceIdentifier = cmdletContext.DBInstanceIdentifier;
}
if (cmdletContext.DbiResourceId != null)
{
request.DbiResourceId = cmdletContext.DbiResourceId;
}
if (cmdletContext.Filter != null)
{
request.Filters = cmdletContext.Filter;
}
// Initialize loop variants and commence piping
System.String _nextToken = null;
int? _emitLimit = null;
int _retrievedSoFar = 0;
if (AutoIterationHelpers.HasValue(cmdletContext.Marker))
{
_nextToken = cmdletContext.Marker;
}
if (cmdletContext.MaxRecord.HasValue)
{
_emitLimit = cmdletContext.MaxRecord;
}
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.Marker = _nextToken;
if (_emitLimit.HasValue)
{
request.MaxRecords = AutoIterationHelpers.ConvertEmitLimitToInt32(_emitLimit.Value);
}
CmdletOutput output;
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
if (!useParameterSelect)
{
pipelineOutput = cmdletContext.Select(response, this);
}
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
int _receivedThisCall = response.DBInstanceAutomatedBackups.Count;
_nextToken = response.Marker;
_retrievedSoFar += _receivedThisCall;
if (_emitLimit.HasValue)
{
_emitLimit -= _receivedThisCall;
}
}
catch (Exception e)
{
if (_retrievedSoFar == 0 || !_emitLimit.HasValue)
{
output = new CmdletOutput { ErrorResponse = e };
}
else
{
break;
}
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken) && (!_emitLimit.HasValue || _emitLimit.Value >= 1));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return null;
}
#endif
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.RDS.Model.DescribeDBInstanceAutomatedBackupsResponse CallAWSServiceOperation(IAmazonRDS client, Amazon.RDS.Model.DescribeDBInstanceAutomatedBackupsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Relational Database Service", "DescribeDBInstanceAutomatedBackups");
try
{
#if DESKTOP
return client.DescribeDBInstanceAutomatedBackups(request);
#elif CORECLR
return client.DescribeDBInstanceAutomatedBackupsAsync(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 DBInstanceAutomatedBackupsArn { get; set; }
public System.String DBInstanceIdentifier { get; set; }
public System.String DbiResourceId { get; set; }
public List Filter { get; set; }
public System.String Marker { get; set; }
public int? MaxRecord { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.DBInstanceAutomatedBackups;
}
}
}