/******************************************************************************* * 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 { /// /// Creates an audit report that lists every time that your CA private key is used. The /// report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate /// and RevokeCertificate /// actions use the private key. /// /// /// Both Amazon Web Services Private CA and the IAM principal must have permission to /// write to the S3 bucket that you specify. If the IAM principal making the call does /// not have permission to write to the bucket, then an exception is thrown. For more /// information, see Access /// policies for CRLs in Amazon S3. /// /// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected /// with encryption. For more information, see Encrypting /// Your Audit Reports. /// /// You can generate a maximum of one report every 30 minutes. /// /// [Cmdlet("New", "PCACertificateAuthorityAuditReport", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.ACMPCA.Model.CreateCertificateAuthorityAuditReportResponse")] [AWSCmdlet("Calls the AWS Certificate Manager Private Certificate Authority CreateCertificateAuthorityAuditReport API operation.", Operation = new[] {"CreateCertificateAuthorityAuditReport"}, SelectReturnType = typeof(Amazon.ACMPCA.Model.CreateCertificateAuthorityAuditReportResponse))] [AWSCmdletOutput("Amazon.ACMPCA.Model.CreateCertificateAuthorityAuditReportResponse", "This cmdlet returns an Amazon.ACMPCA.Model.CreateCertificateAuthorityAuditReportResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewPCACertificateAuthorityAuditReportCmdlet : AmazonACMPCAClientCmdlet, IExecutor { #region Parameter AuditReportResponseFormat /// /// /// The format in which to create the report. This can be either JSON or CSV. /// /// #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] [AWSConstantClassSource("Amazon.ACMPCA.AuditReportResponseFormat")] public Amazon.ACMPCA.AuditReportResponseFormat AuditReportResponseFormat { get; set; } #endregion #region Parameter CertificateAuthorityArn /// /// /// The Amazon Resource Name (ARN) of the CA to be audited. This is 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 S3BucketName /// /// /// The name of the S3 bucket that will contain the audit report. /// /// #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 S3BucketName { 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.ACMPCA.Model.CreateCertificateAuthorityAuditReportResponse). /// Specifying the name of a property of type Amazon.ACMPCA.Model.CreateCertificateAuthorityAuditReportResponse 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 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, "New-PCACertificateAuthorityAuditReport (CreateCertificateAuthorityAuditReport)")) { 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.AuditReportResponseFormat = this.AuditReportResponseFormat; #if MODULAR if (this.AuditReportResponseFormat == null && ParameterWasBound(nameof(this.AuditReportResponseFormat))) { WriteWarning("You are passing $null as a value for parameter AuditReportResponseFormat 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.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 context.S3BucketName = this.S3BucketName; #if MODULAR if (this.S3BucketName == null && ParameterWasBound(nameof(this.S3BucketName))) { WriteWarning("You are passing $null as a value for parameter S3BucketName 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.CreateCertificateAuthorityAuditReportRequest(); if (cmdletContext.AuditReportResponseFormat != null) { request.AuditReportResponseFormat = cmdletContext.AuditReportResponseFormat; } if (cmdletContext.CertificateAuthorityArn != null) { request.CertificateAuthorityArn = cmdletContext.CertificateAuthorityArn; } if (cmdletContext.S3BucketName != null) { request.S3BucketName = cmdletContext.S3BucketName; } 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.CreateCertificateAuthorityAuditReportResponse CallAWSServiceOperation(IAmazonACMPCA client, Amazon.ACMPCA.Model.CreateCertificateAuthorityAuditReportRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Certificate Manager Private Certificate Authority", "CreateCertificateAuthorityAuditReport"); try { #if DESKTOP return client.CreateCertificateAuthorityAuditReport(request); #elif CORECLR return client.CreateCertificateAuthorityAuditReportAsync(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 Amazon.ACMPCA.AuditReportResponseFormat AuditReportResponseFormat { get; set; } public System.String CertificateAuthorityArn { get; set; } public System.String S3BucketName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }