/******************************************************************************* * 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 { /// <summary> /// Creates a DAX cluster. All nodes in the cluster run the same DAX caching software. /// </summary> [Cmdlet("New", "DAXCluster", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.DAX.Model.Cluster")] [AWSCmdlet("Calls the Amazon DynamoDB Accelerator (DAX) CreateCluster API operation.", Operation = new[] {"CreateCluster"}, SelectReturnType = typeof(Amazon.DAX.Model.CreateClusterResponse))] [AWSCmdletOutput("Amazon.DAX.Model.Cluster or Amazon.DAX.Model.CreateClusterResponse", "This cmdlet returns an Amazon.DAX.Model.Cluster object.", "The service call response (type Amazon.DAX.Model.CreateClusterResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewDAXClusterCmdlet : AmazonDAXClientCmdlet, IExecutor { #region Parameter AvailabilityZone /// <summary> /// <para> /// <para>The Availability Zones (AZs) in which the cluster nodes will reside after the cluster /// has been created or updated. If provided, the length of this list must equal the <code>ReplicationFactor</code> /// parameter. If you omit this parameter, DAX will spread the nodes across Availability /// Zones for the highest availability.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("AvailabilityZones")] public System.String[] AvailabilityZone { get; set; } #endregion #region Parameter ClusterEndpointEncryptionType /// <summary> /// <para> /// <para>The type of encryption the cluster's endpoint should support. Values are:</para><ul><li><para><code>NONE</code> for no encryption</para></li><li><para><code>TLS</code> for Transport Layer Security</para></li></ul> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.DAX.ClusterEndpointEncryptionType")] public Amazon.DAX.ClusterEndpointEncryptionType ClusterEndpointEncryptionType { get; set; } #endregion #region Parameter ClusterName /// <summary> /// <para> /// <para>The cluster identifier. This parameter is stored as a lowercase string.</para><para><b>Constraints:</b></para><ul><li><para>A name must contain from 1 to 20 alphanumeric characters or hyphens.</para></li><li><para>The first character must be a letter.</para></li><li><para>A name cannot end with a hyphen or contain two consecutive hyphens.</para></li></ul> /// </para> /// </summary> #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 /// <summary> /// <para> /// <para>A description of the cluster.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter SSESpecification_Enabled /// <summary> /// <para> /// <para>Indicates whether server-side encryption is enabled (true) or disabled (false) on /// the cluster.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? SSESpecification_Enabled { get; set; } #endregion #region Parameter IamRoleArn /// <summary> /// <para> /// <para>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will /// assume this role and use the role's permissions to access DynamoDB on your behalf.</para> /// </para> /// </summary> #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 IamRoleArn { get; set; } #endregion #region Parameter NodeType /// <summary> /// <para> /// <para>The compute and memory capacity of the nodes in the cluster.</para> /// </para> /// </summary> #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 NodeType { get; set; } #endregion #region Parameter NotificationTopicArn /// <summary> /// <para> /// <para>The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will /// be sent.</para><note><para>The Amazon SNS topic owner must be same as the DAX cluster owner.</para></note> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NotificationTopicArn { get; set; } #endregion #region Parameter ParameterGroupName /// <summary> /// <para> /// <para>The parameter group to be associated with the DAX cluster.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ParameterGroupName { get; set; } #endregion #region Parameter PreferredMaintenanceWindow /// <summary> /// <para> /// <para>Specifies the weekly time range during which maintenance on the DAX cluster is performed. /// It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). /// The minimum maintenance window is a 60 minute period. Valid values for <code>ddd</code> /// are:</para><ul><li><para><code>sun</code></para></li><li><para><code>mon</code></para></li><li><para><code>tue</code></para></li><li><para><code>wed</code></para></li><li><para><code>thu</code></para></li><li><para><code>fri</code></para></li><li><para><code>sat</code></para></li></ul><para>Example: <code>sun:05:00-sun:09:00</code></para><note><para>If you don't specify a preferred maintenance window when you create or modify a cache /// cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of /// the week.</para></note> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PreferredMaintenanceWindow { get; set; } #endregion #region Parameter ReplicationFactor /// <summary> /// <para> /// <para>The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node /// cluster, without any read replicas. For additional fault tolerance, you can create /// a multiple node cluster with one or more read replicas. To do this, set <code>ReplicationFactor</code> /// to a number between 3 (one primary and two read replicas) and 10 (one primary and /// nine read replicas). <code>If the AvailabilityZones</code> parameter is provided, /// its length must equal the <code>ReplicationFactor</code>.</para><note><para>AWS recommends that you have at least two read replicas per cluster.</para></note> /// </para> /// </summary> #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.Int32? ReplicationFactor { get; set; } #endregion #region Parameter SecurityGroupId /// <summary> /// <para> /// <para>A list of security group IDs to be assigned to each node in the DAX cluster. (Each /// of the security group ID is system-generated.)</para><para>If this parameter is not specified, DAX assigns the default VPC security group to /// each node.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SecurityGroupIds")] public System.String[] SecurityGroupId { get; set; } #endregion #region Parameter SubnetGroupName /// <summary> /// <para> /// <para>The name of the subnet group to be used for the replication group.</para><important><para>DAX clusters can only run in an Amazon VPC environment. All of the subnets that you /// specify in a subnet group must exist in the same VPC.</para></important> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SubnetGroupName { get; set; } #endregion #region Parameter Tag /// <summary> /// <para> /// <para>A set of tags to associate with the DAX cluster. </para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.DAX.Model.Tag[] Tag { get; set; } #endregion #region Parameter Select /// <summary> /// 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.CreateClusterResponse). /// Specifying the name of a property of type Amazon.DAX.Model.CreateClusterResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "Cluster"; #endregion #region Parameter PassThru /// <summary> /// 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. /// </summary> [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 /// <summary> /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// </summary> [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, "New-DAXCluster (CreateCluster)")) { 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<Amazon.DAX.Model.CreateClusterResponse, NewDAXClusterCmdlet>(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 if (this.AvailabilityZone != null) { context.AvailabilityZone = new List<System.String>(this.AvailabilityZone); } context.ClusterEndpointEncryptionType = this.ClusterEndpointEncryptionType; 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.IamRoleArn = this.IamRoleArn; #if MODULAR if (this.IamRoleArn == null && ParameterWasBound(nameof(this.IamRoleArn))) { WriteWarning("You are passing $null as a value for parameter IamRoleArn 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.NodeType = this.NodeType; #if MODULAR if (this.NodeType == null && ParameterWasBound(nameof(this.NodeType))) { WriteWarning("You are passing $null as a value for parameter NodeType 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.NotificationTopicArn = this.NotificationTopicArn; context.ParameterGroupName = this.ParameterGroupName; context.PreferredMaintenanceWindow = this.PreferredMaintenanceWindow; context.ReplicationFactor = this.ReplicationFactor; #if MODULAR if (this.ReplicationFactor == null && ParameterWasBound(nameof(this.ReplicationFactor))) { WriteWarning("You are passing $null as a value for parameter ReplicationFactor 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.SecurityGroupId != null) { context.SecurityGroupId = new List<System.String>(this.SecurityGroupId); } context.SSESpecification_Enabled = this.SSESpecification_Enabled; context.SubnetGroupName = this.SubnetGroupName; if (this.Tag != null) { context.Tag = new List<Amazon.DAX.Model.Tag>(this.Tag); } // 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.CreateClusterRequest(); if (cmdletContext.AvailabilityZone != null) { request.AvailabilityZones = cmdletContext.AvailabilityZone; } if (cmdletContext.ClusterEndpointEncryptionType != null) { request.ClusterEndpointEncryptionType = cmdletContext.ClusterEndpointEncryptionType; } if (cmdletContext.ClusterName != null) { request.ClusterName = cmdletContext.ClusterName; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.IamRoleArn != null) { request.IamRoleArn = cmdletContext.IamRoleArn; } if (cmdletContext.NodeType != null) { request.NodeType = cmdletContext.NodeType; } if (cmdletContext.NotificationTopicArn != null) { request.NotificationTopicArn = cmdletContext.NotificationTopicArn; } if (cmdletContext.ParameterGroupName != null) { request.ParameterGroupName = cmdletContext.ParameterGroupName; } if (cmdletContext.PreferredMaintenanceWindow != null) { request.PreferredMaintenanceWindow = cmdletContext.PreferredMaintenanceWindow; } if (cmdletContext.ReplicationFactor != null) { request.ReplicationFactor = cmdletContext.ReplicationFactor.Value; } if (cmdletContext.SecurityGroupId != null) { request.SecurityGroupIds = cmdletContext.SecurityGroupId; } // populate SSESpecification var requestSSESpecificationIsNull = true; request.SSESpecification = new Amazon.DAX.Model.SSESpecification(); System.Boolean? requestSSESpecification_sSESpecification_Enabled = null; if (cmdletContext.SSESpecification_Enabled != null) { requestSSESpecification_sSESpecification_Enabled = cmdletContext.SSESpecification_Enabled.Value; } if (requestSSESpecification_sSESpecification_Enabled != null) { request.SSESpecification.Enabled = requestSSESpecification_sSESpecification_Enabled.Value; requestSSESpecificationIsNull = false; } // determine if request.SSESpecification should be set to null if (requestSSESpecificationIsNull) { request.SSESpecification = null; } if (cmdletContext.SubnetGroupName != null) { request.SubnetGroupName = cmdletContext.SubnetGroupName; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } 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.CreateClusterResponse CallAWSServiceOperation(IAmazonDAX client, Amazon.DAX.Model.CreateClusterRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon DynamoDB Accelerator (DAX)", "CreateCluster"); try { #if DESKTOP return client.CreateCluster(request); #elif CORECLR return client.CreateClusterAsync(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<System.String> AvailabilityZone { get; set; } public Amazon.DAX.ClusterEndpointEncryptionType ClusterEndpointEncryptionType { get; set; } public System.String ClusterName { get; set; } public System.String Description { get; set; } public System.String IamRoleArn { get; set; } public System.String NodeType { get; set; } public System.String NotificationTopicArn { get; set; } public System.String ParameterGroupName { get; set; } public System.String PreferredMaintenanceWindow { get; set; } public System.Int32? ReplicationFactor { get; set; } public List<System.String> SecurityGroupId { get; set; } public System.Boolean? SSESpecification_Enabled { get; set; } public System.String SubnetGroupName { get; set; } public List<Amazon.DAX.Model.Tag> Tag { get; set; } public System.Func<Amazon.DAX.Model.CreateClusterResponse, NewDAXClusterCmdlet, object> Select { get; set; } = (response, cmdlet) => response.Cluster; } } }