/******************************************************************************* * 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.S3; using Amazon.S3.Model; namespace Amazon.PowerShell.Cmdlets.S3 { /// /// Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. /// You can have up to 1,000 metrics configurations per bucket. If you're updating an /// existing metrics configuration, note that this is a full replacement of the existing /// metrics configuration. If you don't include the elements you want to keep, they are /// erased. /// /// /// /// To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see Permissions /// Related to Bucket Subresource Operations and Managing /// Access Permissions to Your Amazon S3 Resources. /// /// For information about CloudWatch request metrics for Amazon S3, see Monitoring /// Metrics with Amazon CloudWatch. /// /// The following operations are related to PutBucketMetricsConfiguration: /// PutBucketMetricsConfiguration has the following special error: /// /// [Cmdlet("Write", "S3BucketMetricsConfiguration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the Amazon Simple Storage Service (S3) PutBucketMetricsConfiguration API operation.", Operation = new[] {"PutBucketMetricsConfiguration"}, SelectReturnType = typeof(Amazon.S3.Model.PutBucketMetricsConfigurationResponse))] [AWSCmdletOutput("None or Amazon.S3.Model.PutBucketMetricsConfigurationResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.S3.Model.PutBucketMetricsConfigurationResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WriteS3BucketMetricsConfigurationCmdlet : AmazonS3ClientCmdlet, IExecutor { #region Parameter BucketName /// /// /// The name of the bucket for which the metrics configuration is set. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String BucketName { get; set; } #endregion #region Parameter ExpectedBucketOwner /// /// /// The account ID of the expected bucket owner. /// If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ExpectedBucketOwner { get; set; } #endregion #region Parameter MetricsFilter_MetricsFilterPredicate /// /// /// Filter Predicate setup for specific filter types. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MetricsConfiguration_MetricsFilter_MetricsFilterPredicate")] public Amazon.S3.Model.MetricsFilterPredicate MetricsFilter_MetricsFilterPredicate { get; set; } #endregion #region Parameter MetricsId /// /// /// The ID used to identify the metrics configuration. /// The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String MetricsId { get; set; } #endregion #region Parameter MetricsConfiguration_MetricsId /// /// /// The ID used to identify the metrics configuration. /// The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String MetricsConfiguration_MetricsId { 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.S3.Model.PutBucketMetricsConfigurationResponse). /// 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 BucketName parameter. /// The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^BucketName' 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 = "s3"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.BucketName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-S3BucketMetricsConfiguration (PutBucketMetricsConfiguration)")) { 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.BucketName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.BucketName = this.BucketName; context.MetricsId = this.MetricsId; context.MetricsFilter_MetricsFilterPredicate = this.MetricsFilter_MetricsFilterPredicate; context.MetricsConfiguration_MetricsId = this.MetricsConfiguration_MetricsId; context.ExpectedBucketOwner = this.ExpectedBucketOwner; // 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.S3.Model.PutBucketMetricsConfigurationRequest(); if (cmdletContext.BucketName != null) { request.BucketName = cmdletContext.BucketName; } if (cmdletContext.MetricsId != null) { request.MetricsId = cmdletContext.MetricsId; } // populate MetricsConfiguration var requestMetricsConfigurationIsNull = true; request.MetricsConfiguration = new Amazon.S3.Model.MetricsConfiguration(); System.String requestMetricsConfiguration_metricsConfiguration_MetricsId = null; if (cmdletContext.MetricsConfiguration_MetricsId != null) { requestMetricsConfiguration_metricsConfiguration_MetricsId = cmdletContext.MetricsConfiguration_MetricsId; } if (requestMetricsConfiguration_metricsConfiguration_MetricsId != null) { request.MetricsConfiguration.MetricsId = requestMetricsConfiguration_metricsConfiguration_MetricsId; requestMetricsConfigurationIsNull = false; } Amazon.S3.Model.MetricsFilter requestMetricsConfiguration_metricsConfiguration_MetricsFilter = null; // populate MetricsFilter var requestMetricsConfiguration_metricsConfiguration_MetricsFilterIsNull = true; requestMetricsConfiguration_metricsConfiguration_MetricsFilter = new Amazon.S3.Model.MetricsFilter(); Amazon.S3.Model.MetricsFilterPredicate requestMetricsConfiguration_metricsConfiguration_MetricsFilter_metricsFilter_MetricsFilterPredicate = null; if (cmdletContext.MetricsFilter_MetricsFilterPredicate != null) { requestMetricsConfiguration_metricsConfiguration_MetricsFilter_metricsFilter_MetricsFilterPredicate = cmdletContext.MetricsFilter_MetricsFilterPredicate; } if (requestMetricsConfiguration_metricsConfiguration_MetricsFilter_metricsFilter_MetricsFilterPredicate != null) { requestMetricsConfiguration_metricsConfiguration_MetricsFilter.MetricsFilterPredicate = requestMetricsConfiguration_metricsConfiguration_MetricsFilter_metricsFilter_MetricsFilterPredicate; requestMetricsConfiguration_metricsConfiguration_MetricsFilterIsNull = false; } // determine if requestMetricsConfiguration_metricsConfiguration_MetricsFilter should be set to null if (requestMetricsConfiguration_metricsConfiguration_MetricsFilterIsNull) { requestMetricsConfiguration_metricsConfiguration_MetricsFilter = null; } if (requestMetricsConfiguration_metricsConfiguration_MetricsFilter != null) { request.MetricsConfiguration.MetricsFilter = requestMetricsConfiguration_metricsConfiguration_MetricsFilter; requestMetricsConfigurationIsNull = false; } // determine if request.MetricsConfiguration should be set to null if (requestMetricsConfigurationIsNull) { request.MetricsConfiguration = null; } if (cmdletContext.ExpectedBucketOwner != null) { request.ExpectedBucketOwner = cmdletContext.ExpectedBucketOwner; } 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.S3.Model.PutBucketMetricsConfigurationResponse CallAWSServiceOperation(IAmazonS3 client, Amazon.S3.Model.PutBucketMetricsConfigurationRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Storage Service (S3)", "PutBucketMetricsConfiguration"); try { #if DESKTOP return client.PutBucketMetricsConfiguration(request); #elif CORECLR return client.PutBucketMetricsConfigurationAsync(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 BucketName { get; set; } public System.String MetricsId { get; set; } public Amazon.S3.Model.MetricsFilterPredicate MetricsFilter_MetricsFilterPredicate { get; set; } public System.String MetricsConfiguration_MetricsId { get; set; } public System.String ExpectedBucketOwner { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }