/******************************************************************************* * 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.SecretsManager; using Amazon.SecretsManager.Model; namespace Amazon.PowerShell.Cmdlets.SEC { /// /// Configures and starts the asynchronous process of rotating the secret. For information /// about rotation, see Rotate /// secrets in the Secrets Manager User Guide. If you include the configuration /// parameters, the operation sets the values for the secret and then immediately starts /// a rotation. If you don't include the configuration parameters, the operation starts /// a rotation with the values already stored in the secret. /// /// /// /// When rotation is successful, the AWSPENDING staging label might be attached /// to the same version as the AWSCURRENT version, or it might not be attached /// to any version. If the AWSPENDING staging label is present but not attached /// to the same version as AWSCURRENT, then any later invocation of RotateSecret /// assumes that a previous rotation request is still in progress and returns an error. /// When rotation is unsuccessful, the AWSPENDING staging label might be /// attached to an empty secret version. For more information, see Troubleshoot /// rotation in the Secrets Manager User Guide. /// /// Secrets Manager generates a CloudTrail log entry when you call this action. Do not /// include sensitive information in request parameters because it might be logged. For /// more information, see Logging /// Secrets Manager events with CloudTrail. /// Required permissions: secretsmanager:RotateSecret. For more /// information, see /// IAM policy actions for Secrets Manager and Authentication /// and access control in Secrets Manager. You also need lambda:InvokeFunction /// permissions on the rotation function. For more information, see /// Permissions for rotation. /// /// [Cmdlet("Invoke", "SECSecretRotation", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.SecretsManager.Model.RotateSecretResponse")] [AWSCmdlet("Calls the AWS Secrets Manager RotateSecret API operation.", Operation = new[] {"RotateSecret"}, SelectReturnType = typeof(Amazon.SecretsManager.Model.RotateSecretResponse))] [AWSCmdletOutput("Amazon.SecretsManager.Model.RotateSecretResponse", "This cmdlet returns an Amazon.SecretsManager.Model.RotateSecretResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class InvokeSECSecretRotationCmdlet : AmazonSecretsManagerClientCmdlet, IExecutor { #region Parameter RotationRules_AutomaticallyAfterDay /// /// /// The number of days between rotations of the secret. You can use this value to check /// that your secret meets your compliance guidelines for how often secrets must be rotated. /// If you use this field to set the rotation schedule, Secrets Manager calculates the /// next rotation date based on the previous rotation. Manually updating the secret value /// by calling PutSecretValue or UpdateSecret is considered /// a valid rotation.In DescribeSecret and ListSecrets, this value is calculated /// from the rotation schedule after every successful rotation. In RotateSecret, /// you can set the rotation schedule in RotationRules with AutomaticallyAfterDays /// or ScheduleExpression, but not both. To set a rotation schedule in hours, /// use ScheduleExpression. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("RotationRules_AutomaticallyAfterDays")] public System.Int64? RotationRules_AutomaticallyAfterDay { get; set; } #endregion #region Parameter ClientRequestToken /// /// /// A unique identifier for the new version of the secret that helps ensure idempotency. /// Secrets Manager uses this value to prevent the accidental creation of duplicate versions /// if there are failures and retries during rotation. This value becomes the VersionId /// of the new version.If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call /// this operation, then you can leave this parameter empty. The CLI or SDK generates /// a random UUID for you and includes that in the request for this parameter. If you /// don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service /// endpoint, then you must generate a ClientRequestToken yourself for new /// versions and include that value in the request.You only need to specify this value if you implement your own retry logic and you /// want to ensure that Secrets Manager doesn't attempt to create a secret version twice. /// We recommend that you generate a UUID-type /// value to ensure uniqueness within the specified secret. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientRequestToken { get; set; } #endregion #region Parameter RotationRules_Duration /// /// /// The length of the rotation window in hours, for example 3h for a three /// hour window. Secrets Manager rotates your secret at any time during this window. The /// window must not extend into the next rotation window or the next UTC day. The window /// starts according to the ScheduleExpression. If you don't specify a Duration, /// for a ScheduleExpression in hours, the window automatically closes after /// one hour. For a ScheduleExpression in days, the window automatically /// closes at the end of the UTC day. For more information, including examples, see Schedule /// expressions in Secrets Manager rotation in the Secrets Manager Users Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RotationRules_Duration { get; set; } #endregion #region Parameter RotateImmediately /// /// /// Specifies whether to rotate the secret immediately or wait until the next scheduled /// rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.For secrets that use a Lambda rotation function to rotate, if you don't immediately /// rotate the secret, Secrets Manager tests the rotation configuration by running the /// testSecret step of the Lambda rotation function. The test creates /// an AWSPENDING version of the secret and then removes it.By default, Secrets Manager rotates the secret immediately. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? RotateImmediately { get; set; } #endregion #region Parameter RotationLambdaARN /// /// /// For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation /// function. For secrets that use managed rotation, omit this field. For more information, /// see Managed /// rotation in the Secrets Manager User Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RotationLambdaARN { get; set; } #endregion #region Parameter RotationRules_ScheduleExpression /// /// /// A cron() or rate() expression that defines the schedule /// for rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets /// Manager rotates your secret any time during a rotation window.Secrets Manager rate() expressions represent the interval in hours or /// days that you want to rotate your secret, for example rate(12 hours) /// or rate(10 days). You can rotate a secret as often as every four hours. /// If you use a rate() expression, the rotation window starts at midnight. /// For a rate in hours, the default rotation window closes after one hour. For a rate /// in days, the default rotation window closes at the end of the day. You can set the /// Duration to change the rotation window. The rotation window must not /// extend into the next UTC day or into the next rotation window.You can use a cron() expression to create a rotation schedule that is /// more detailed than a rotation interval. For more information, including examples, /// see Schedule /// expressions in Secrets Manager rotation in the Secrets Manager Users Guide. /// For a cron expression that represents a schedule in hours, the default rotation window /// closes after one hour. For a cron expression that represents a schedule in days, the /// default rotation window closes at the end of the day. You can set the Duration /// to change the rotation window. The rotation window must not extend into the next UTC /// day or into the next rotation window. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RotationRules_ScheduleExpression { get; set; } #endregion #region Parameter SecretId /// /// /// The ARN or name of the secret to rotate.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. /// See Finding /// a secret from a partial ARN. /// /// #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 SecretId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecretsManager.Model.RotateSecretResponse). /// Specifying the name of a property of type Amazon.SecretsManager.Model.RotateSecretResponse 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; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the SecretId parameter. /// The -PassThru parameter is deprecated, use -Select '^SecretId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SecretId' 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.SecretId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Invoke-SECSecretRotation (RotateSecret)")) { 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.SecretId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClientRequestToken = this.ClientRequestToken; context.RotateImmediately = this.RotateImmediately; context.RotationLambdaARN = this.RotationLambdaARN; context.RotationRules_AutomaticallyAfterDay = this.RotationRules_AutomaticallyAfterDay; context.RotationRules_Duration = this.RotationRules_Duration; context.RotationRules_ScheduleExpression = this.RotationRules_ScheduleExpression; context.SecretId = this.SecretId; #if MODULAR if (this.SecretId == null && ParameterWasBound(nameof(this.SecretId))) { WriteWarning("You are passing $null as a value for parameter SecretId 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.SecretsManager.Model.RotateSecretRequest(); if (cmdletContext.ClientRequestToken != null) { request.ClientRequestToken = cmdletContext.ClientRequestToken; } if (cmdletContext.RotateImmediately != null) { request.RotateImmediately = cmdletContext.RotateImmediately.Value; } if (cmdletContext.RotationLambdaARN != null) { request.RotationLambdaARN = cmdletContext.RotationLambdaARN; } // populate RotationRules var requestRotationRulesIsNull = true; request.RotationRules = new Amazon.SecretsManager.Model.RotationRulesType(); System.Int64? requestRotationRules_rotationRules_AutomaticallyAfterDay = null; if (cmdletContext.RotationRules_AutomaticallyAfterDay != null) { requestRotationRules_rotationRules_AutomaticallyAfterDay = cmdletContext.RotationRules_AutomaticallyAfterDay.Value; } if (requestRotationRules_rotationRules_AutomaticallyAfterDay != null) { request.RotationRules.AutomaticallyAfterDays = requestRotationRules_rotationRules_AutomaticallyAfterDay.Value; requestRotationRulesIsNull = false; } System.String requestRotationRules_rotationRules_Duration = null; if (cmdletContext.RotationRules_Duration != null) { requestRotationRules_rotationRules_Duration = cmdletContext.RotationRules_Duration; } if (requestRotationRules_rotationRules_Duration != null) { request.RotationRules.Duration = requestRotationRules_rotationRules_Duration; requestRotationRulesIsNull = false; } System.String requestRotationRules_rotationRules_ScheduleExpression = null; if (cmdletContext.RotationRules_ScheduleExpression != null) { requestRotationRules_rotationRules_ScheduleExpression = cmdletContext.RotationRules_ScheduleExpression; } if (requestRotationRules_rotationRules_ScheduleExpression != null) { request.RotationRules.ScheduleExpression = requestRotationRules_rotationRules_ScheduleExpression; requestRotationRulesIsNull = false; } // determine if request.RotationRules should be set to null if (requestRotationRulesIsNull) { request.RotationRules = null; } if (cmdletContext.SecretId != null) { request.SecretId = cmdletContext.SecretId; } 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.SecretsManager.Model.RotateSecretResponse CallAWSServiceOperation(IAmazonSecretsManager client, Amazon.SecretsManager.Model.RotateSecretRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Secrets Manager", "RotateSecret"); try { #if DESKTOP return client.RotateSecret(request); #elif CORECLR return client.RotateSecretAsync(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 ClientRequestToken { get; set; } public System.Boolean? RotateImmediately { get; set; } public System.String RotationLambdaARN { get; set; } public System.Int64? RotationRules_AutomaticallyAfterDay { get; set; } public System.String RotationRules_Duration { get; set; } public System.String RotationRules_ScheduleExpression { get; set; } public System.String SecretId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }