/******************************************************************************* * 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 { /// /// Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle /// configuration. Keep in mind that this will overwrite an existing lifecycle configuration, /// so if you want to retain any configuration details, they must be included in the new /// lifecycle configuration. For information about lifecycle configuration, see Managing /// your storage lifecycle. /// /// /// Bucket lifecycle configuration now supports specifying a lifecycle rule using an object /// key name prefix, one or more object tags, or a combination of both. Accordingly, this /// section describes the latest API. The previous version of the API supported filtering /// based only on an object key name prefix, which is supported for backward compatibility. /// For the related API description, see PutBucketLifecycle. ///
Rules
/// You specify the lifecycle configuration in your request body. The lifecycle configuration /// is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration /// can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the /// following: ///
  • /// A filter identifying a subset of objects to which the rule applies. The filter can /// be based on a key name prefix, object tags, or a combination of both. ///
  • /// A status indicating whether the rule is in effect. ///
  • /// One or more lifecycle transition and expiration actions that you want Amazon S3 to /// perform on the objects identified by the filter. If the state of your bucket is versioning-enabled /// or versioning-suspended, you can have many versions of the same object (one current /// version and zero or more noncurrent versions). Amazon S3 provides predefined actions /// that you can specify for current and noncurrent object versions. ///
/// For more information, see Object /// Lifecycle Management and Lifecycle /// Configuration Elements. ///
Permissions
/// By default, all Amazon S3 resources are private, including buckets, objects, and related /// subresources (for example, lifecycle configuration and website configuration). Only /// the resource owner (that is, the Amazon Web Services account that created it) can /// access the resource. The resource owner can optionally grant access permissions to /// others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration /// permission. /// /// You can also explicitly deny permissions. An explicit deny also supersedes any other /// permissions. If you want to block users or accounts from removing or deleting objects /// from your bucket, you must deny them permissions for the following actions: ///
  • s3:DeleteObject
  • s3:DeleteObjectVersion
  • s3:PutLifecycleConfiguration
/// For more information about permissions, see Managing /// Access Permissions to Your Amazon S3 Resources. ///
/// The following operations are related to PutBucketLifecycleConfiguration: /// ///
[Cmdlet("Write", "S3LifecycleConfiguration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the Amazon Simple Storage Service (S3) PutLifecycleConfiguration API operation.", Operation = new[] {"PutLifecycleConfiguration"}, SelectReturnType = typeof(Amazon.S3.Model.PutLifecycleConfigurationResponse))] [AWSCmdletOutput("None or Amazon.S3.Model.PutLifecycleConfigurationResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.S3.Model.PutLifecycleConfigurationResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WriteS3LifecycleConfigurationCmdlet : AmazonS3ClientCmdlet, IExecutor { #region Parameter BucketName /// /// /// The name of the bucket for which to set the configuration. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String BucketName { get; set; } #endregion #region Parameter ChecksumAlgorithm /// /// /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.S3.ChecksumAlgorithm")] public Amazon.S3.ChecksumAlgorithm ChecksumAlgorithm { 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 Configuration_Rule /// /// /// These rules defined the lifecycle configuration. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Configuration_Rules")] public Amazon.S3.Model.LifecycleRule[] Configuration_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.S3.Model.PutLifecycleConfigurationResponse). /// 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-S3LifecycleConfiguration (PutLifecycleConfiguration)")) { 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.ChecksumAlgorithm = this.ChecksumAlgorithm; if (this.Configuration_Rule != null) { context.Configuration_Rule = new List(this.Configuration_Rule); } 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.PutLifecycleConfigurationRequest(); if (cmdletContext.BucketName != null) { request.BucketName = cmdletContext.BucketName; } if (cmdletContext.ChecksumAlgorithm != null) { request.ChecksumAlgorithm = cmdletContext.ChecksumAlgorithm; } // populate Configuration var requestConfigurationIsNull = true; request.Configuration = new Amazon.S3.Model.LifecycleConfiguration(); List requestConfiguration_configuration_Rule = null; if (cmdletContext.Configuration_Rule != null) { requestConfiguration_configuration_Rule = cmdletContext.Configuration_Rule; } if (requestConfiguration_configuration_Rule != null) { request.Configuration.Rules = requestConfiguration_configuration_Rule; requestConfigurationIsNull = false; } // determine if request.Configuration should be set to null if (requestConfigurationIsNull) { request.Configuration = 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.PutLifecycleConfigurationResponse CallAWSServiceOperation(IAmazonS3 client, Amazon.S3.Model.PutLifecycleConfigurationRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Storage Service (S3)", "PutLifecycleConfiguration"); try { #if DESKTOP return client.PutLifecycleConfiguration(request); #elif CORECLR return client.PutLifecycleConfigurationAsync(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 Amazon.S3.ChecksumAlgorithm ChecksumAlgorithm { get; set; } public List Configuration_Rule { get; set; } public System.String ExpectedBucketOwner { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }