/******************************************************************************* * 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 replication configuration or replaces an existing one. For more information, /// see Replication /// in the Amazon S3 User Guide. /// /// /// /// Specify the replication configuration in the request body. In the replication configuration, /// you provide the name of the destination bucket or buckets where you want Amazon S3 /// to replicate objects, the IAM role that Amazon S3 can assume to replicate objects /// on your behalf, and other relevant information. /// /// A replication configuration must include at least one rule, and can contain a maximum /// of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects /// in the source bucket. To choose additional subsets of objects to replicate, add a /// rule for each subset. /// /// To specify a subset of the objects in the source bucket to apply a replication rule /// to, add the Filter element as a child of the Rule element. You can filter objects /// based on an object key prefix, one or more object tags, or both. When you add the /// Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, /// Status, and Priority. /// /// If you are using an earlier version of the replication configuration, Amazon S3 handles /// replication of delete markers differently. For more information, see Backward /// Compatibility. /// /// For information about enabling versioning on a bucket, see Using /// Versioning. ///
Handling Replication of Encrypted Objects
/// By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side /// encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, /// add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, /// Status, EncryptionConfiguration, and ReplicaKmsKeyID. /// For information about replication configuration, see Replicating /// Objects Created with SSE Using KMS keys. /// /// For information on PutBucketReplication errors, see List /// of replication-related error codes
Permissions
/// To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration /// permissions for the bucket. /// /// By default, a resource owner, in this case the Amazon Web Services account that created /// the bucket, can perform this operation. The resource owner can also grant others permissions /// to perform the operation. For more information about permissions, see Specifying /// Permissions in a Policy and Managing /// Access Permissions to Your Amazon S3 Resources. /// /// To perform this operation, the user or role performing the action must have the iam:PassRole /// permission. ///
/// The following operations are related to PutBucketReplication: /// ///
[Cmdlet("Write", "S3BucketReplication", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the Amazon Simple Storage Service (S3) PutBucketReplication API operation.", Operation = new[] {"PutBucketReplication"}, SelectReturnType = typeof(Amazon.S3.Model.PutBucketReplicationResponse))] [AWSCmdletOutput("None or Amazon.S3.Model.PutBucketReplicationResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.S3.Model.PutBucketReplicationResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WriteS3BucketReplicationCmdlet : AmazonS3ClientCmdlet, IExecutor { #region Parameter BucketName /// /// /// The name of the bucket /// /// [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 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_Role /// /// /// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that /// Amazon S3 assumes when replicating objects. For more information, see How /// to Set Up Replication in the Amazon S3 User Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Configuration_Role { get; set; } #endregion #region Parameter Configuration_Rule /// /// /// Container for information about a particular replication rule. /// Replication configuration must have at least one rule and can contain up to 1,000 rules. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Configuration_Rules")] public Amazon.S3.Model.ReplicationRule[] Configuration_Rule { get; set; } #endregion #region Parameter Token /// /// /// A token to allow Object Lock to be enabled for an existing bucket. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Token { 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.PutBucketReplicationResponse). /// 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-S3BucketReplication (PutBucketReplication)")) { 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.ExpectedBucketOwner = this.ExpectedBucketOwner; context.Configuration_Role = this.Configuration_Role; if (this.Configuration_Rule != null) { context.Configuration_Rule = new List(this.Configuration_Rule); } context.Token = this.Token; // 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.PutBucketReplicationRequest(); if (cmdletContext.BucketName != null) { request.BucketName = cmdletContext.BucketName; } if (cmdletContext.ChecksumAlgorithm != null) { request.ChecksumAlgorithm = cmdletContext.ChecksumAlgorithm; } if (cmdletContext.ExpectedBucketOwner != null) { request.ExpectedBucketOwner = cmdletContext.ExpectedBucketOwner; } // populate Configuration var requestConfigurationIsNull = true; request.Configuration = new Amazon.S3.Model.ReplicationConfiguration(); System.String requestConfiguration_configuration_Role = null; if (cmdletContext.Configuration_Role != null) { requestConfiguration_configuration_Role = cmdletContext.Configuration_Role; } if (requestConfiguration_configuration_Role != null) { request.Configuration.Role = requestConfiguration_configuration_Role; requestConfigurationIsNull = false; } 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.Token != null) { request.Token = cmdletContext.Token; } 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.PutBucketReplicationResponse CallAWSServiceOperation(IAmazonS3 client, Amazon.S3.Model.PutBucketReplicationRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Storage Service (S3)", "PutBucketReplication"); try { #if DESKTOP return client.PutBucketReplication(request); #elif CORECLR return client.PutBucketReplicationAsync(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 ExpectedBucketOwner { get; set; } public System.String Configuration_Role { get; set; } public List Configuration_Rule { get; set; } public System.String Token { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }