/******************************************************************************* * 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.DynamoDBv2; using Amazon.DynamoDBv2.Model; namespace Amazon.PowerShell.Cmdlets.DDB { /// /// Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB /// Streams settings for a given table. /// /// /// This operation only applies to Version /// 2019.11.21 (Current) of global tables. /// /// You can only perform one of the following operations at once: /// UpdateTable is an asynchronous operation; while it is executing, the /// table status changes from ACTIVE to UPDATING. While it is /// UPDATING, you cannot issue another UpdateTable request. /// When the table returns to the ACTIVE state, the UpdateTable /// operation is complete. /// /// [Cmdlet("Update", "DDBTable", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.DynamoDBv2.Model.TableDescription")] [AWSCmdlet("Calls the Amazon DynamoDB UpdateTable API operation.", Operation = new[] {"UpdateTable"}, SelectReturnType = typeof(Amazon.DynamoDBv2.Model.UpdateTableResponse))] [AWSCmdletOutput("Amazon.DynamoDBv2.Model.TableDescription or Amazon.DynamoDBv2.Model.UpdateTableResponse", "This cmdlet returns an Amazon.DynamoDBv2.Model.TableDescription object.", "The service call response (type Amazon.DynamoDBv2.Model.UpdateTableResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateDDBTableCmdlet : AmazonDynamoDBClientCmdlet, IExecutor { #region Parameter AttributeDefinition /// /// /// An array of attributes that describe the key schema for the table and indexes. If /// you are adding a new global secondary index to the table, AttributeDefinitions /// must include the key element(s) of the new index. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("AttributeDefinitions")] public Amazon.DynamoDBv2.Model.AttributeDefinition[] AttributeDefinition { get; set; } #endregion #region Parameter BillingMode /// /// /// Controls how you are charged for read and write throughput and how you manage capacity. /// When switching from pay-per-request to provisioned capacity, initial provisioned capacity /// values must be set. The initial provisioned capacity values are estimated based on /// the consumed read and write capacity of your table and global secondary indexes over /// the past 30 minutes. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.DynamoDBv2.BillingMode")] public Amazon.DynamoDBv2.BillingMode BillingMode { get; set; } #endregion #region Parameter DeletionProtectionEnabled /// /// /// Indicates whether deletion protection is to be enabled (true) or disabled (false) /// on the table. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? DeletionProtectionEnabled { get; set; } #endregion #region Parameter SSESpecification_Enabled /// /// /// Indicates whether server-side encryption is done using an Amazon Web Services managed /// key or an Amazon Web Services owned key. If enabled (true), server-side encryption /// type is set to KMS and an Amazon Web Services managed key is used (KMS /// charges apply). If disabled (false) or not specified, server-side encryption is set /// to Amazon Web Services owned key. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? SSESpecification_Enabled { get; set; } #endregion #region Parameter GlobalSecondaryIndexUpdate /// /// /// An array of one or more global secondary indexes for the table. For each index in /// the array, you can request one action:You can create or delete only one global secondary index per UpdateTable /// operation.For more information, see Managing /// Global Secondary Indexes in the Amazon DynamoDB Developer Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("GlobalSecondaryIndexUpdates")] public Amazon.DynamoDBv2.Model.GlobalSecondaryIndexUpdate[] GlobalSecondaryIndexUpdate { get; set; } #endregion #region Parameter SSESpecification_KMSMasterKeyId /// /// /// The KMS key that should be used for the KMS encryption. To specify a key, use its /// key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should /// only provide this parameter if the key is different from the default DynamoDB key /// alias/aws/dynamodb. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SSESpecification_KMSMasterKeyId { get; set; } #endregion #region Parameter ReadCapacity /// /// /// The maximum number of strongly consistent reads consumed per second before DynamoDB /// returns a ThrottlingException. For more information, see Specifying /// Read and Write Requirements in the Amazon DynamoDB Developer Guide.If read/write capacity mode is PAY_PER_REQUEST the value is set to 0. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ProvisionedThroughput_ReadCapacityUnits")] public System.Int64? ReadCapacity { get; set; } #endregion #region Parameter ReplicaUpdate /// /// /// A list of replica update actions (create, delete, or update) for the table.This property only applies to Version /// 2019.11.21 (Current) of global tables. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ReplicaUpdates")] public Amazon.DynamoDBv2.Model.ReplicationGroupUpdate[] ReplicaUpdate { get; set; } #endregion #region Parameter SSESpecification_SSEType /// /// /// Server-side encryption type. The only supported value is: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.DynamoDBv2.SSEType")] public Amazon.DynamoDBv2.SSEType SSESpecification_SSEType { get; set; } #endregion #region Parameter StreamSpecification_StreamEnabled /// /// /// Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? StreamSpecification_StreamEnabled { get; set; } #endregion #region Parameter StreamSpecification_StreamViewType /// /// /// When an item in the table is modified, StreamViewType determines what /// information is written to the stream for this table. Valid values for StreamViewType /// are: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.DynamoDBv2.StreamViewType")] public Amazon.DynamoDBv2.StreamViewType StreamSpecification_StreamViewType { get; set; } #endregion #region Parameter TableClass /// /// /// The table class of the table to be updated. Valid values are STANDARD /// and STANDARD_INFREQUENT_ACCESS. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.DynamoDBv2.TableClass")] public Amazon.DynamoDBv2.TableClass TableClass { get; set; } #endregion #region Parameter TableName /// /// /// The name of the table to be updated. /// /// #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 TableName { get; set; } #endregion #region Parameter WriteCapacity /// /// /// The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. /// For more information, see Specifying /// Read and Write Requirements in the Amazon DynamoDB Developer Guide.If read/write capacity mode is PAY_PER_REQUEST the value is set to 0. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ProvisionedThroughput_WriteCapacityUnits")] public System.Int64? WriteCapacity { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'TableDescription'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DynamoDBv2.Model.UpdateTableResponse). /// Specifying the name of a property of type Amazon.DynamoDBv2.Model.UpdateTableResponse 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; } = "TableDescription"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the TableName parameter. /// The -PassThru parameter is deprecated, use -Select '^TableName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^TableName' 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.TableName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-DDBTable (UpdateTable)")) { 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.TableName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.AttributeDefinition != null) { context.AttributeDefinition = new List(this.AttributeDefinition); } context.BillingMode = this.BillingMode; context.DeletionProtectionEnabled = this.DeletionProtectionEnabled; if (this.GlobalSecondaryIndexUpdate != null) { context.GlobalSecondaryIndexUpdate = new List(this.GlobalSecondaryIndexUpdate); } context.ReadCapacity = this.ReadCapacity; context.WriteCapacity = this.WriteCapacity; if (this.ReplicaUpdate != null) { context.ReplicaUpdate = new List(this.ReplicaUpdate); } context.SSESpecification_Enabled = this.SSESpecification_Enabled; context.SSESpecification_KMSMasterKeyId = this.SSESpecification_KMSMasterKeyId; context.SSESpecification_SSEType = this.SSESpecification_SSEType; context.StreamSpecification_StreamEnabled = this.StreamSpecification_StreamEnabled; context.StreamSpecification_StreamViewType = this.StreamSpecification_StreamViewType; context.TableClass = this.TableClass; context.TableName = this.TableName; #if MODULAR if (this.TableName == null && ParameterWasBound(nameof(this.TableName))) { WriteWarning("You are passing $null as a value for parameter TableName 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.DynamoDBv2.Model.UpdateTableRequest(); if (cmdletContext.AttributeDefinition != null) { request.AttributeDefinitions = cmdletContext.AttributeDefinition; } if (cmdletContext.BillingMode != null) { request.BillingMode = cmdletContext.BillingMode; } if (cmdletContext.DeletionProtectionEnabled != null) { request.DeletionProtectionEnabled = cmdletContext.DeletionProtectionEnabled.Value; } if (cmdletContext.GlobalSecondaryIndexUpdate != null) { request.GlobalSecondaryIndexUpdates = cmdletContext.GlobalSecondaryIndexUpdate; } // populate ProvisionedThroughput var requestProvisionedThroughputIsNull = true; request.ProvisionedThroughput = new Amazon.DynamoDBv2.Model.ProvisionedThroughput(); System.Int64? requestProvisionedThroughput_readCapacity = null; if (cmdletContext.ReadCapacity != null) { requestProvisionedThroughput_readCapacity = cmdletContext.ReadCapacity.Value; } if (requestProvisionedThroughput_readCapacity != null) { request.ProvisionedThroughput.ReadCapacityUnits = requestProvisionedThroughput_readCapacity.Value; requestProvisionedThroughputIsNull = false; } System.Int64? requestProvisionedThroughput_writeCapacity = null; if (cmdletContext.WriteCapacity != null) { requestProvisionedThroughput_writeCapacity = cmdletContext.WriteCapacity.Value; } if (requestProvisionedThroughput_writeCapacity != null) { request.ProvisionedThroughput.WriteCapacityUnits = requestProvisionedThroughput_writeCapacity.Value; requestProvisionedThroughputIsNull = false; } // determine if request.ProvisionedThroughput should be set to null if (requestProvisionedThroughputIsNull) { request.ProvisionedThroughput = null; } if (cmdletContext.ReplicaUpdate != null) { request.ReplicaUpdates = cmdletContext.ReplicaUpdate; } // populate SSESpecification var requestSSESpecificationIsNull = true; request.SSESpecification = new Amazon.DynamoDBv2.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; } System.String requestSSESpecification_sSESpecification_KMSMasterKeyId = null; if (cmdletContext.SSESpecification_KMSMasterKeyId != null) { requestSSESpecification_sSESpecification_KMSMasterKeyId = cmdletContext.SSESpecification_KMSMasterKeyId; } if (requestSSESpecification_sSESpecification_KMSMasterKeyId != null) { request.SSESpecification.KMSMasterKeyId = requestSSESpecification_sSESpecification_KMSMasterKeyId; requestSSESpecificationIsNull = false; } Amazon.DynamoDBv2.SSEType requestSSESpecification_sSESpecification_SSEType = null; if (cmdletContext.SSESpecification_SSEType != null) { requestSSESpecification_sSESpecification_SSEType = cmdletContext.SSESpecification_SSEType; } if (requestSSESpecification_sSESpecification_SSEType != null) { request.SSESpecification.SSEType = requestSSESpecification_sSESpecification_SSEType; requestSSESpecificationIsNull = false; } // determine if request.SSESpecification should be set to null if (requestSSESpecificationIsNull) { request.SSESpecification = null; } // populate StreamSpecification var requestStreamSpecificationIsNull = true; request.StreamSpecification = new Amazon.DynamoDBv2.Model.StreamSpecification(); System.Boolean? requestStreamSpecification_streamSpecification_StreamEnabled = null; if (cmdletContext.StreamSpecification_StreamEnabled != null) { requestStreamSpecification_streamSpecification_StreamEnabled = cmdletContext.StreamSpecification_StreamEnabled.Value; } if (requestStreamSpecification_streamSpecification_StreamEnabled != null) { request.StreamSpecification.StreamEnabled = requestStreamSpecification_streamSpecification_StreamEnabled.Value; requestStreamSpecificationIsNull = false; } Amazon.DynamoDBv2.StreamViewType requestStreamSpecification_streamSpecification_StreamViewType = null; if (cmdletContext.StreamSpecification_StreamViewType != null) { requestStreamSpecification_streamSpecification_StreamViewType = cmdletContext.StreamSpecification_StreamViewType; } if (requestStreamSpecification_streamSpecification_StreamViewType != null) { request.StreamSpecification.StreamViewType = requestStreamSpecification_streamSpecification_StreamViewType; requestStreamSpecificationIsNull = false; } // determine if request.StreamSpecification should be set to null if (requestStreamSpecificationIsNull) { request.StreamSpecification = null; } if (cmdletContext.TableClass != null) { request.TableClass = cmdletContext.TableClass; } if (cmdletContext.TableName != null) { request.TableName = cmdletContext.TableName; } 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.DynamoDBv2.Model.UpdateTableResponse CallAWSServiceOperation(IAmazonDynamoDB client, Amazon.DynamoDBv2.Model.UpdateTableRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon DynamoDB", "UpdateTable"); try { #if DESKTOP return client.UpdateTable(request); #elif CORECLR return client.UpdateTableAsync(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 AttributeDefinition { get; set; } public Amazon.DynamoDBv2.BillingMode BillingMode { get; set; } public System.Boolean? DeletionProtectionEnabled { get; set; } public List GlobalSecondaryIndexUpdate { get; set; } public System.Int64? ReadCapacity { get; set; } public System.Int64? WriteCapacity { get; set; } public List ReplicaUpdate { get; set; } public System.Boolean? SSESpecification_Enabled { get; set; } public System.String SSESpecification_KMSMasterKeyId { get; set; } public Amazon.DynamoDBv2.SSEType SSESpecification_SSEType { get; set; } public System.Boolean? StreamSpecification_StreamEnabled { get; set; } public Amazon.DynamoDBv2.StreamViewType StreamSpecification_StreamViewType { get; set; } public Amazon.DynamoDBv2.TableClass TableClass { get; set; } public System.String TableName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.TableDescription; } } }