/******************************************************************************* * 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.ACMPCA; using Amazon.ACMPCA.Model; namespace Amazon.PowerShell.Cmdlets.PCA { /// /// Restores a certificate authority (CA) that is in the DELETED state. You /// can restore a CA during the period that you defined in the PermanentDeletionTimeInDays /// parameter of the DeleteCertificateAuthority /// action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays /// value, by default you can restore the CA at any time in a 30 day period. You can check /// the time remaining in the restoration period of a private CA in the DELETED /// state by calling the DescribeCertificateAuthority /// or ListCertificateAuthorities /// actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority /// action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority /// action. If the private CA was in the PENDING_CERTIFICATE state at deletion, /// you must use the ImportCertificateAuthorityCertificate /// action to import a certificate authority into the private CA before it can be activated. /// You cannot restore a CA after the restoration period has ended. /// [Cmdlet("Restore", "PCACertificateAuthority", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the AWS Certificate Manager Private Certificate Authority RestoreCertificateAuthority API operation.", Operation = new[] {"RestoreCertificateAuthority"}, SelectReturnType = typeof(Amazon.ACMPCA.Model.RestoreCertificateAuthorityResponse))] [AWSCmdletOutput("None or Amazon.ACMPCA.Model.RestoreCertificateAuthorityResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.ACMPCA.Model.RestoreCertificateAuthorityResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RestorePCACertificateAuthorityCmdlet : AmazonACMPCAClientCmdlet, IExecutor { #region Parameter CertificateAuthorityArn /// /// /// The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority /// action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 /// /// #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 CertificateAuthorityArn { 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.ACMPCA.Model.RestoreCertificateAuthorityResponse). /// 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 CertificateAuthorityArn parameter. /// The -PassThru parameter is deprecated, use -Select '^CertificateAuthorityArn' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^CertificateAuthorityArn' 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.CertificateAuthorityArn), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Restore-PCACertificateAuthority (RestoreCertificateAuthority)")) { 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.CertificateAuthorityArn; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.CertificateAuthorityArn = this.CertificateAuthorityArn; #if MODULAR if (this.CertificateAuthorityArn == null && ParameterWasBound(nameof(this.CertificateAuthorityArn))) { WriteWarning("You are passing $null as a value for parameter CertificateAuthorityArn 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.ACMPCA.Model.RestoreCertificateAuthorityRequest(); if (cmdletContext.CertificateAuthorityArn != null) { request.CertificateAuthorityArn = cmdletContext.CertificateAuthorityArn; } 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.ACMPCA.Model.RestoreCertificateAuthorityResponse CallAWSServiceOperation(IAmazonACMPCA client, Amazon.ACMPCA.Model.RestoreCertificateAuthorityRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Certificate Manager Private Certificate Authority", "RestoreCertificateAuthority"); try { #if DESKTOP return client.RestoreCertificateAuthority(request); #elif CORECLR return client.RestoreCertificateAuthorityAsync(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 CertificateAuthorityArn { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }