/*******************************************************************************
* 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
{
///
/// This action uses the encryption
subresource to configure default encryption
/// and Amazon S3 Bucket Keys for an existing bucket.
///
///
///
/// By default, all buckets have a default encryption configuration that uses server-side
/// encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default
/// encryption for a bucket by using server-side encryption with Key Management Service
/// (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS
/// keys (DSSE-KMS), or server-side encryption with customer-provided keys (SSE-C). If
/// you specify default encryption by using SSE-KMS, you can also configure Amazon S3
/// Bucket Keys. For information about bucket default encryption, see Amazon
/// S3 bucket default encryption in the Amazon S3 User Guide. For more information
/// about S3 Bucket Keys, see Amazon
/// S3 Bucket Keys in the Amazon S3 User Guide.
///
/// This action requires Amazon Web Services Signature Version 4. For more information,
/// see
/// Authenticating Requests (Amazon Web Services Signature Version 4).
///
/// To use this operation, you must have permission to perform the s3:PutEncryptionConfiguration
/// 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 in the Amazon S3 User Guide.
///
///
/// The following operations are related to PutBucketEncryption
:
///
///
[Cmdlet("Set", "S3BucketEncryption", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon Simple Storage Service (S3) PutBucketEncryption API operation.", Operation = new[] {"PutBucketEncryption"}, SelectReturnType = typeof(Amazon.S3.PutBucketEncryptionResponse))]
[AWSCmdletOutput("None or Amazon.S3.PutBucketEncryptionResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.S3.PutBucketEncryptionResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class SetS3BucketEncryptionCmdlet : AmazonS3ClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
#region Parameter BucketName
///
///
/// Specifies default encryption for a bucket using server-side encryption with different
/// key options. By default, all buckets have a default encryption configuration that
/// uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally
/// configure default encryption for a bucket by using server-side encryption with an
/// Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). For information
/// about the bucket default encryption feature, see Amazon
/// S3 Bucket Default Encryption in the Amazon S3 User Guide.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String BucketName { get; set; }
#endregion
#region Parameter ChecksumAlgorithm
///
///
/// Indicates the algorithm used to create the checksum for the object. Amazon S3 will
/// fail the request with a 400 error if there is no checksum associated with the object.
/// For more information, see
/// Checking object integrity in the Amazon S3 User Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.S3.ChecksumAlgorithm")]
public Amazon.S3.ChecksumAlgorithm ChecksumAlgorithm { get; set; }
#endregion
#region Parameter ContentMD5
///
///
/// The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon
/// Web Services SDKs, this field is calculated automatically.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ContentMD5 { 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 ServerSideEncryptionConfiguration_ServerSideEncryptionRule
///
///
/// Container for information about a particular server-side encryption configuration rule.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ServerSideEncryptionConfiguration_ServerSideEncryptionRules")]
public Amazon.S3.Model.ServerSideEncryptionRule[] ServerSideEncryptionConfiguration_ServerSideEncryptionRule { 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.PutBucketEncryptionResponse).
/// 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, "Set-S3BucketEncryption (PutBucketEncryption)"))
{
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;
context.ContentMD5 = this.ContentMD5;
if (this.ServerSideEncryptionConfiguration_ServerSideEncryptionRule != null)
{
context.ServerSideEncryptionConfiguration_ServerSideEncryptionRule = new List(this.ServerSideEncryptionConfiguration_ServerSideEncryptionRule);
}
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.PutBucketEncryptionRequest();
if (cmdletContext.BucketName != null)
{
request.BucketName = cmdletContext.BucketName;
}
if (cmdletContext.ChecksumAlgorithm != null)
{
request.ChecksumAlgorithm = cmdletContext.ChecksumAlgorithm;
}
if (cmdletContext.ContentMD5 != null)
{
request.ContentMD5 = cmdletContext.ContentMD5;
}
// populate ServerSideEncryptionConfiguration
var requestServerSideEncryptionConfigurationIsNull = true;
request.ServerSideEncryptionConfiguration = new Amazon.S3.Model.ServerSideEncryptionConfiguration();
List requestServerSideEncryptionConfiguration_serverSideEncryptionConfiguration_ServerSideEncryptionRule = null;
if (cmdletContext.ServerSideEncryptionConfiguration_ServerSideEncryptionRule != null)
{
requestServerSideEncryptionConfiguration_serverSideEncryptionConfiguration_ServerSideEncryptionRule = cmdletContext.ServerSideEncryptionConfiguration_ServerSideEncryptionRule;
}
if (requestServerSideEncryptionConfiguration_serverSideEncryptionConfiguration_ServerSideEncryptionRule != null)
{
request.ServerSideEncryptionConfiguration.ServerSideEncryptionRules = requestServerSideEncryptionConfiguration_serverSideEncryptionConfiguration_ServerSideEncryptionRule;
requestServerSideEncryptionConfigurationIsNull = false;
}
// determine if request.ServerSideEncryptionConfiguration should be set to null
if (requestServerSideEncryptionConfigurationIsNull)
{
request.ServerSideEncryptionConfiguration = 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.PutBucketEncryptionResponse CallAWSServiceOperation(IAmazonS3 client, Amazon.S3.Model.PutBucketEncryptionRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Storage Service (S3)", "PutBucketEncryption");
try
{
#if DESKTOP
return client.PutBucketEncryption(request);
#elif CORECLR
return client.PutBucketEncryptionAsync(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 System.String ContentMD5 { get; set; }
public List ServerSideEncryptionConfiguration_ServerSideEncryptionRule { get; set; }
public System.String ExpectedBucketOwner { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}