/******************************************************************************* * 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.S3Control; using Amazon.S3Control.Model; namespace Amazon.PowerShell.Cmdlets.S3C { /// /// /// This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To /// put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration /// in the Amazon S3 API Reference. /// /// Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an /// existing lifecycle configuration. Outposts buckets only support lifecycle configurations /// that delete/expire objects after a certain period of time and abort incomplete multipart /// uploads. /// /// All Amazon S3 on Outposts REST API requests for this action require an additional /// parameter of x-amz-outpost-id to be passed with the request. In addition, /// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. /// For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on /// Outposts endpoint hostname prefix and the x-amz-outpost-id derived by /// using the access point ARN, see the Examples /// section. /// /// The following actions are related to PutBucketLifecycleConfiguration: /// /// [Cmdlet("Write", "S3CBucketLifecycleConfiguration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the Amazon S3 Control PutBucketLifecycleConfiguration API operation.", Operation = new[] {"PutBucketLifecycleConfiguration"}, SelectReturnType = typeof(Amazon.S3Control.Model.PutBucketLifecycleConfigurationResponse))] [AWSCmdletOutput("None or Amazon.S3Control.Model.PutBucketLifecycleConfigurationResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.S3Control.Model.PutBucketLifecycleConfigurationResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WriteS3CBucketLifecycleConfigurationCmdlet : AmazonS3ControlClientCmdlet, IExecutor { #region Parameter AccountId /// /// /// The Amazon Web Services account ID of the Outposts bucket. /// /// #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 AccountId { get; set; } #endregion #region Parameter Bucket /// /// /// The name of the bucket for which to set the configuration. /// /// #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 Bucket { get; set; } #endregion #region Parameter LifecycleConfiguration_Rule /// /// /// A lifecycle rule for individual objects in an Outposts bucket. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("LifecycleConfiguration_Rules")] public Amazon.S3Control.Model.LifecycleRule[] LifecycleConfiguration_Rule { 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.S3Control.Model.PutBucketLifecycleConfigurationResponse). /// 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 AccountId parameter. /// The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^AccountId' 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 = "s3v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.AccountId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-S3CBucketLifecycleConfiguration (PutBucketLifecycleConfiguration)")) { 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.AccountId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AccountId = this.AccountId; #if MODULAR if (this.AccountId == null && ParameterWasBound(nameof(this.AccountId))) { WriteWarning("You are passing $null as a value for parameter AccountId 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.Bucket = this.Bucket; #if MODULAR if (this.Bucket == null && ParameterWasBound(nameof(this.Bucket))) { WriteWarning("You are passing $null as a value for parameter Bucket 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 if (this.LifecycleConfiguration_Rule != null) { context.LifecycleConfiguration_Rule = new List(this.LifecycleConfiguration_Rule); } // 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.S3Control.Model.PutBucketLifecycleConfigurationRequest(); if (cmdletContext.AccountId != null) { request.AccountId = cmdletContext.AccountId; } if (cmdletContext.Bucket != null) { request.Bucket = cmdletContext.Bucket; } // populate LifecycleConfiguration var requestLifecycleConfigurationIsNull = true; request.LifecycleConfiguration = new Amazon.S3Control.Model.LifecycleConfiguration(); List requestLifecycleConfiguration_lifecycleConfiguration_Rule = null; if (cmdletContext.LifecycleConfiguration_Rule != null) { requestLifecycleConfiguration_lifecycleConfiguration_Rule = cmdletContext.LifecycleConfiguration_Rule; } if (requestLifecycleConfiguration_lifecycleConfiguration_Rule != null) { request.LifecycleConfiguration.Rules = requestLifecycleConfiguration_lifecycleConfiguration_Rule; requestLifecycleConfigurationIsNull = false; } // determine if request.LifecycleConfiguration should be set to null if (requestLifecycleConfigurationIsNull) { request.LifecycleConfiguration = null; } 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.S3Control.Model.PutBucketLifecycleConfigurationResponse CallAWSServiceOperation(IAmazonS3Control client, Amazon.S3Control.Model.PutBucketLifecycleConfigurationRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon S3 Control", "PutBucketLifecycleConfiguration"); try { #if DESKTOP return client.PutBucketLifecycleConfiguration(request); #elif CORECLR return client.PutBucketLifecycleConfigurationAsync(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 AccountId { get; set; } public System.String Bucket { get; set; } public List LifecycleConfiguration_Rule { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }