/******************************************************************************* * 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 { /// /// Adds an attribute and values to, or removes an attribute and values from, a manual /// DB snapshot. /// /// /// /// To share a manual DB snapshot with other Amazon Web Services accounts, specify restore /// as the AttributeName and use the ValuesToAdd parameter to /// add a list of IDs of the Amazon Web Services accounts that are authorized to restore /// the manual DB snapshot. Uses the value all to make the manual DB snapshot /// public, which means it can be copied or restored by all Amazon Web Services accounts. /// /// Don't add the all value for any manual DB snapshots that contain private /// information that you don't want available to all Amazon Web Services accounts. /// /// If the manual DB snapshot is encrypted, it can be shared, but only by specifying a /// list of authorized Amazon Web Services account IDs for the ValuesToAdd /// parameter. You can't use all as a value for that parameter in this case. /// /// To view which Amazon Web Services accounts have access to copy or restore a manual /// DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes /// API operation. The accounts are returned as values for the restore attribute. /// /// [Cmdlet("Edit", "RDSDBSnapshotAttribute", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.RDS.Model.DBSnapshotAttributesResult")] [AWSCmdlet("Calls the Amazon Relational Database Service ModifyDBSnapshotAttribute API operation.", Operation = new[] {"ModifyDBSnapshotAttribute"}, SelectReturnType = typeof(Amazon.RDS.Model.ModifyDBSnapshotAttributeResponse))] [AWSCmdletOutput("Amazon.RDS.Model.DBSnapshotAttributesResult or Amazon.RDS.Model.ModifyDBSnapshotAttributeResponse", "This cmdlet returns an Amazon.RDS.Model.DBSnapshotAttributesResult object.", "The service call response (type Amazon.RDS.Model.ModifyDBSnapshotAttributeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class EditRDSDBSnapshotAttributeCmdlet : AmazonRDSClientCmdlet, IExecutor { #region Parameter AttributeName /// /// /// The name of the DB snapshot attribute to modify.To manage authorization for other Amazon Web Services accounts to copy or restore /// a manual DB snapshot, set this value to restore.To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes /// API operation. /// /// #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 AttributeName { get; set; } #endregion #region Parameter DBSnapshotIdentifier /// /// /// The identifier for the DB snapshot to modify the attributes for. /// /// #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 DBSnapshotIdentifier { get; set; } #endregion #region Parameter ValuesToAdd /// /// /// A list of DB snapshot attributes to add to the attribute specified by AttributeName.To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, /// set this list to include one or more Amazon Web Services account IDs, or all /// to make the manual DB snapshot restorable by any Amazon Web Services account. Do not /// add the all value for any manual DB snapshots that contain private information /// that you don't want available to all Amazon Web Services accounts. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String[] ValuesToAdd { get; set; } #endregion #region Parameter ValuesToRemove /// /// /// A list of DB snapshot attributes to remove from the attribute specified by AttributeName.To remove authorization for other Amazon Web Services accounts to copy or restore /// a manual snapshot, set this list to include one or more Amazon Web Services account /// identifiers, or all to remove authorization for any Amazon Web Services /// account to copy or restore the DB snapshot. If you specify all, an Amazon /// Web Services account whose account ID is explicitly added to the restore /// attribute can still copy or restore the manual DB snapshot. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String[] ValuesToRemove { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'DBSnapshotAttributesResult'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.ModifyDBSnapshotAttributeResponse). /// Specifying the name of a property of type Amazon.RDS.Model.ModifyDBSnapshotAttributeResponse 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; } = "DBSnapshotAttributesResult"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the DBSnapshotIdentifier parameter. /// The -PassThru parameter is deprecated, use -Select '^DBSnapshotIdentifier' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DBSnapshotIdentifier' 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.DBSnapshotIdentifier), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Edit-RDSDBSnapshotAttribute (ModifyDBSnapshotAttribute)")) { 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.DBSnapshotIdentifier; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AttributeName = this.AttributeName; #if MODULAR if (this.AttributeName == null && ParameterWasBound(nameof(this.AttributeName))) { WriteWarning("You are passing $null as a value for parameter AttributeName 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.DBSnapshotIdentifier = this.DBSnapshotIdentifier; #if MODULAR if (this.DBSnapshotIdentifier == null && ParameterWasBound(nameof(this.DBSnapshotIdentifier))) { WriteWarning("You are passing $null as a value for parameter DBSnapshotIdentifier 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.ValuesToAdd != null) { context.ValuesToAdd = new List(this.ValuesToAdd); } if (this.ValuesToRemove != null) { context.ValuesToRemove = new List(this.ValuesToRemove); } // 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.ModifyDBSnapshotAttributeRequest(); if (cmdletContext.AttributeName != null) { request.AttributeName = cmdletContext.AttributeName; } if (cmdletContext.DBSnapshotIdentifier != null) { request.DBSnapshotIdentifier = cmdletContext.DBSnapshotIdentifier; } if (cmdletContext.ValuesToAdd != null) { request.ValuesToAdd = cmdletContext.ValuesToAdd; } if (cmdletContext.ValuesToRemove != null) { request.ValuesToRemove = cmdletContext.ValuesToRemove; } 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.ModifyDBSnapshotAttributeResponse CallAWSServiceOperation(IAmazonRDS client, Amazon.RDS.Model.ModifyDBSnapshotAttributeRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Relational Database Service", "ModifyDBSnapshotAttribute"); try { #if DESKTOP return client.ModifyDBSnapshotAttribute(request); #elif CORECLR return client.ModifyDBSnapshotAttributeAsync(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 AttributeName { get; set; } public System.String DBSnapshotIdentifier { get; set; } public List ValuesToAdd { get; set; } public List ValuesToRemove { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.DBSnapshotAttributesResult; } } }