/******************************************************************************* * 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.KeyManagementService; using Amazon.KeyManagementService.Model; namespace Amazon.PowerShell.Cmdlets.KMS { /// /// Associates an existing KMS alias with a different KMS key. Each alias is associated /// with only one KMS key at a time, although a KMS key can have multiple aliases. The /// alias and the KMS key must be in the same Amazon Web Services account and Region. /// /// /// Adding, deleting, or updating an alias can allow or deny permission to the KMS key. /// For details, see ABAC /// for KMS in the Key Management Service Developer Guide. /// /// The current and new KMS key must be the same type (both symmetric or both asymmetric /// or both HMAC), and they must have the same key usage. This restriction prevents errors /// in code that uses aliases. If you must assign an alias to a different type of KMS /// key, use DeleteAlias to delete the old alias and CreateAlias to create /// a new alias. /// /// You cannot use UpdateAlias to change an alias name. To change an alias /// name, use DeleteAlias to delete the old alias and CreateAlias to create /// a new alias. /// /// Because an alias is not a property of a KMS key, you can create, update, and delete /// the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear /// in the response from the DescribeKey operation. To get the aliases of all KMS /// keys in the account, use the ListAliases operation. /// /// The KMS key that you use for this operation must be in a compatible key state. For /// details, see Key /// states of KMS keys in the Key Management Service Developer Guide. /// Cross-account use: No. You cannot perform this operation on a KMS key in a /// different Amazon Web Services account. /// Required permissions /// For details, see Controlling /// access to aliases in the Key Management Service Developer Guide. /// Related operations: /// [Cmdlet("Update", "KMSAlias", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the AWS Key Management Service UpdateAlias API operation.", Operation = new[] {"UpdateAlias"}, SelectReturnType = typeof(Amazon.KeyManagementService.Model.UpdateAliasResponse))] [AWSCmdletOutput("None or Amazon.KeyManagementService.Model.UpdateAliasResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.KeyManagementService.Model.UpdateAliasResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateKMSAliasCmdlet : AmazonKeyManagementServiceClientCmdlet, IExecutor { #region Parameter AliasName /// /// /// Identifies the alias that is changing its KMS key. This value must begin with alias/ /// followed by the alias name, such as alias/ExampleAlias. You cannot use /// UpdateAlias to change the alias name.Do not include confidential or sensitive information in this field. This field may /// be displayed in plaintext in CloudTrail logs and other output. /// /// #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 AliasName { get; set; } #endregion #region Parameter TargetKeyId /// /// /// Identifies the customer /// managed key to associate with the alias. You don't have permission to associate /// an alias with an Amazon /// Web Services managed key.The KMS key must be in the same Amazon Web Services account and Region as the alias. /// Also, the new target KMS key must be the same type as the current target KMS key (both /// symmetric or both asymmetric or both HMAC) and they must have the same key usage. /// Specify the key ID or key ARN of the KMS key.For example:To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.To verify that the alias is mapped to the correct KMS key, use ListAliases. /// /// #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 TargetKeyId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KeyManagementService.Model.UpdateAliasResponse). /// 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; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the TargetKeyId parameter. /// The -PassThru parameter is deprecated, use -Select '^TargetKeyId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^TargetKeyId' 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.TargetKeyId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-KMSAlias (UpdateAlias)")) { 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.TargetKeyId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AliasName = this.AliasName; #if MODULAR if (this.AliasName == null && ParameterWasBound(nameof(this.AliasName))) { WriteWarning("You are passing $null as a value for parameter AliasName 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.TargetKeyId = this.TargetKeyId; #if MODULAR if (this.TargetKeyId == null && ParameterWasBound(nameof(this.TargetKeyId))) { WriteWarning("You are passing $null as a value for parameter TargetKeyId 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.KeyManagementService.Model.UpdateAliasRequest(); if (cmdletContext.AliasName != null) { request.AliasName = cmdletContext.AliasName; } if (cmdletContext.TargetKeyId != null) { request.TargetKeyId = cmdletContext.TargetKeyId; } 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.KeyManagementService.Model.UpdateAliasResponse CallAWSServiceOperation(IAmazonKeyManagementService client, Amazon.KeyManagementService.Model.UpdateAliasRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Key Management Service", "UpdateAlias"); try { #if DESKTOP return client.UpdateAlias(request); #elif CORECLR return client.UpdateAliasAsync(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 AliasName { get; set; } public System.String TargetKeyId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }