/******************************************************************************* * 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.DAX; using Amazon.DAX.Model; namespace Amazon.PowerShell.Cmdlets.DAX { /// /// Modifies the settings for a DAX cluster. You can use this action to change one or /// more cluster configuration parameters by specifying the parameters and the new values. /// [Cmdlet("Update", "DAXCluster", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.DAX.Model.Cluster")] [AWSCmdlet("Calls the Amazon DynamoDB Accelerator (DAX) UpdateCluster API operation.", Operation = new[] {"UpdateCluster"}, SelectReturnType = typeof(Amazon.DAX.Model.UpdateClusterResponse))] [AWSCmdletOutput("Amazon.DAX.Model.Cluster or Amazon.DAX.Model.UpdateClusterResponse", "This cmdlet returns an Amazon.DAX.Model.Cluster object.", "The service call response (type Amazon.DAX.Model.UpdateClusterResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateDAXClusterCmdlet : AmazonDAXClientCmdlet, IExecutor { #region Parameter ClusterName /// /// /// The name of the DAX cluster to be modified. /// /// #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 ClusterName { get; set; } #endregion #region Parameter Description /// /// /// A description of the changes being made to the cluster. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter NotificationTopicArn /// /// /// The Amazon Resource Name (ARN) that identifies the topic. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NotificationTopicArn { get; set; } #endregion #region Parameter NotificationTopicStatus /// /// /// The current state of the topic. A value of “active” means that notifications will /// be sent to the topic. A value of “inactive” means that notifications will not be sent /// to the topic. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NotificationTopicStatus { get; set; } #endregion #region Parameter ParameterGroupName /// /// /// The name of a parameter group for this cluster. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ParameterGroupName { get; set; } #endregion #region Parameter PreferredMaintenanceWindow /// /// /// A range of time when maintenance of DAX cluster software will be performed. For example: /// sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 /// minutes, and is performed automatically within the maintenance window. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PreferredMaintenanceWindow { get; set; } #endregion #region Parameter SecurityGroupId /// /// /// A list of user-specified security group IDs to be assigned to each node in the DAX /// cluster. If this parameter is not specified, DAX assigns the default VPC security /// group to each node. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SecurityGroupIds")] public System.String[] SecurityGroupId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DAX.Model.UpdateClusterResponse). /// Specifying the name of a property of type Amazon.DAX.Model.UpdateClusterResponse 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; } = "Cluster"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ClusterName parameter. /// The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ClusterName' 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.ClusterName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-DAXCluster (UpdateCluster)")) { 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.ClusterName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClusterName = this.ClusterName; #if MODULAR if (this.ClusterName == null && ParameterWasBound(nameof(this.ClusterName))) { WriteWarning("You are passing $null as a value for parameter ClusterName 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.Description = this.Description; context.NotificationTopicArn = this.NotificationTopicArn; context.NotificationTopicStatus = this.NotificationTopicStatus; context.ParameterGroupName = this.ParameterGroupName; context.PreferredMaintenanceWindow = this.PreferredMaintenanceWindow; if (this.SecurityGroupId != null) { context.SecurityGroupId = new List(this.SecurityGroupId); } // 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.DAX.Model.UpdateClusterRequest(); if (cmdletContext.ClusterName != null) { request.ClusterName = cmdletContext.ClusterName; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.NotificationTopicArn != null) { request.NotificationTopicArn = cmdletContext.NotificationTopicArn; } if (cmdletContext.NotificationTopicStatus != null) { request.NotificationTopicStatus = cmdletContext.NotificationTopicStatus; } if (cmdletContext.ParameterGroupName != null) { request.ParameterGroupName = cmdletContext.ParameterGroupName; } if (cmdletContext.PreferredMaintenanceWindow != null) { request.PreferredMaintenanceWindow = cmdletContext.PreferredMaintenanceWindow; } if (cmdletContext.SecurityGroupId != null) { request.SecurityGroupIds = cmdletContext.SecurityGroupId; } 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.DAX.Model.UpdateClusterResponse CallAWSServiceOperation(IAmazonDAX client, Amazon.DAX.Model.UpdateClusterRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon DynamoDB Accelerator (DAX)", "UpdateCluster"); try { #if DESKTOP return client.UpdateCluster(request); #elif CORECLR return client.UpdateClusterAsync(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 ClusterName { get; set; } public System.String Description { get; set; } public System.String NotificationTopicArn { get; set; } public System.String NotificationTopicStatus { get; set; } public System.String ParameterGroupName { get; set; } public System.String PreferredMaintenanceWindow { get; set; } public List SecurityGroupId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Cluster; } } }