/******************************************************************************* * 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 operation gets an Amazon S3 on Outposts bucket's replication configuration. To /// get an S3 bucket's replication configuration, see GetBucketReplication /// in the Amazon S3 API Reference. /// /// Returns the replication configuration of an S3 on Outposts bucket. For more information /// about S3 on Outposts, see Using /// Amazon S3 on Outposts in the Amazon S3 User Guide. For information about /// S3 replication on Outposts configuration, see Replicating /// objects for S3 on Outposts in the Amazon S3 User Guide. /// /// It can take a while to propagate PUT or DELETE requests /// for a replication configuration to all S3 on Outposts systems. Therefore, the replication /// configuration that's returned by a GET request soon after a PUT /// or DELETE request might return a more recent result than what's on the /// Outpost. If an Outpost is offline, the delay in updating the replication configuration /// on that Outpost can be significant. /// /// This action requires permissions for the s3-outposts:GetReplicationConfiguration /// action. The Outposts bucket owner has this permission by default and can grant it /// to others. For more information about permissions, see Setting /// up IAM with S3 on Outposts and Managing /// access to S3 on Outposts bucket in the Amazon S3 User Guide. /// /// 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. /// /// If you include the Filter element in a replication configuration, you /// must also include the DeleteMarkerReplication, Status, and /// Priority elements. The response also returns those elements. /// /// For information about S3 on Outposts replication failure reasons, see Replication /// failure reasons in the Amazon S3 User Guide. /// /// The following operations are related to GetBucketReplication: /// /// [Cmdlet("Get", "S3CBucketReplication")] [OutputType("Amazon.S3Control.Model.ReplicationConfiguration")] [AWSCmdlet("Calls the Amazon S3 Control GetBucketReplication API operation.", Operation = new[] {"GetBucketReplication"}, SelectReturnType = typeof(Amazon.S3Control.Model.GetBucketReplicationResponse))] [AWSCmdletOutput("Amazon.S3Control.Model.ReplicationConfiguration or Amazon.S3Control.Model.GetBucketReplicationResponse", "This cmdlet returns an Amazon.S3Control.Model.ReplicationConfiguration object.", "The service call response (type Amazon.S3Control.Model.GetBucketReplicationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetS3CBucketReplicationCmdlet : AmazonS3ControlClientCmdlet, IExecutor { #region Parameter AccountId /// /// /// The Amazon Web Services account ID of the Outposts bucket. /// /// #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 AccountId { get; set; } #endregion #region Parameter Bucket /// /// /// Specifies the bucket to get the replication information for.For using this parameter with Amazon S3 on Outposts with the REST API, you must specify /// the name and the x-amz-outpost-id as well.For using this parameter with S3 on Outposts with the Amazon Web Services SDK and /// CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. /// For example, to access the bucket reports through Outpost my-outpost /// owned by account 123456789012 in Region us-west-2, use the /// URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. /// The value must be URL encoded. /// /// #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 Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationConfiguration'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.GetBucketReplicationResponse). /// Specifying the name of a property of type Amazon.S3Control.Model.GetBucketReplicationResponse will result in that property being returned. /// 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; } = "ReplicationConfiguration"; #endregion protected override void ProcessRecord() { this._AWSSignerType = "s3v4"; base.ProcessRecord(); var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } 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 // 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.GetBucketReplicationRequest(); if (cmdletContext.AccountId != null) { request.AccountId = cmdletContext.AccountId; } if (cmdletContext.Bucket != null) { request.Bucket = cmdletContext.Bucket; } 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.GetBucketReplicationResponse CallAWSServiceOperation(IAmazonS3Control client, Amazon.S3Control.Model.GetBucketReplicationRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon S3 Control", "GetBucketReplication"); try { #if DESKTOP return client.GetBucketReplication(request); #elif CORECLR return client.GetBucketReplicationAsync(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 System.Func Select { get; set; } = (response, cmdlet) => response.ReplicationConfiguration; } } }