/*******************************************************************************
* 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
{
///
/// Creates an access point and associates it with the specified bucket. For more information,
/// see Managing
/// Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.
///
///
/// S3 on Outposts only supports VPC-style access points.
///
/// For more information, see
/// Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points
/// 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.
///
/// The following actions are related to CreateAccessPoint
:
///
///
[Cmdlet("New", "S3CAccessPoint", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the Amazon S3 Control CreateAccessPoint API operation.", Operation = new[] {"CreateAccessPoint"}, SelectReturnType = typeof(Amazon.S3Control.Model.CreateAccessPointResponse))]
[AWSCmdletOutput("System.String or Amazon.S3Control.Model.CreateAccessPointResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.S3Control.Model.CreateAccessPointResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewS3CAccessPointCmdlet : AmazonS3ControlClientCmdlet, IExecutor
{
#region Parameter AccountId
///
///
/// The Amazon Web Services account ID for the account that owns the specified access
/// point.
///
///
#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 PublicAccessBlockConfiguration_BlockPublicAcl
///
///
/// Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets
/// in this account. Setting this element to TRUE
causes the following behavior:PutBucketAcl
and PutObjectAcl
calls fail if the specified
/// ACL is public.- PUT Object calls fail if the request includes a public ACL.
- PUT Bucket calls fail if the request includes a public ACL.
Enabling this setting doesn't affect existing policies or ACLs.This property is not supported for Amazon S3 on Outposts.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("PublicAccessBlockConfiguration_BlockPublicAcls")]
public System.Boolean? PublicAccessBlockConfiguration_BlockPublicAcl { get; set; }
#endregion
#region Parameter PublicAccessBlockConfiguration_BlockPublicPolicy
///
///
/// Specifies whether Amazon S3 should block public bucket policies for buckets in this
/// account. Setting this element to TRUE
causes Amazon S3 to reject calls
/// to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.This property is not supported for Amazon S3 on Outposts.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? PublicAccessBlockConfiguration_BlockPublicPolicy { get; set; }
#endregion
#region Parameter Bucket
///
///
/// The name of the bucket that you want to associate this access point with.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(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 Bucket { get; set; }
#endregion
#region Parameter BucketAccountId
///
///
/// The Amazon Web Services account ID associated with the S3 bucket associated with this
/// access point.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String BucketAccountId { get; set; }
#endregion
#region Parameter PublicAccessBlockConfiguration_IgnorePublicAcl
///
///
/// Specifies whether Amazon S3 should ignore public ACLs for buckets in this account.
/// Setting this element to TRUE
causes Amazon S3 to ignore all public ACLs
/// on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't
/// prevent new public ACLs from being set.This property is not supported for Amazon S3 on Outposts.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("PublicAccessBlockConfiguration_IgnorePublicAcls")]
public System.Boolean? PublicAccessBlockConfiguration_IgnorePublicAcl { get; set; }
#endregion
#region Parameter Name
///
///
/// The name you want to assign to this access point.
///
///
#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 Name { get; set; }
#endregion
#region Parameter PublicAccessBlockConfiguration_RestrictPublicBucket
///
///
/// Specifies whether Amazon S3 should restrict public bucket policies for buckets in
/// this account. Setting this element to TRUE
restricts access to buckets
/// with public policies to only Amazon Web Service principals and authorized users within
/// this account.Enabling this setting doesn't affect previously stored bucket policies, except that
/// public and cross-account access within any public bucket policy, including non-public
/// delegation to specific accounts, is blocked.This property is not supported for Amazon S3 on Outposts.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("PublicAccessBlockConfiguration_RestrictPublicBuckets")]
public System.Boolean? PublicAccessBlockConfiguration_RestrictPublicBucket { get; set; }
#endregion
#region Parameter VpcConfiguration_VpcId
///
///
/// If this field is specified, this access point will only allow connections from the
/// specified VPC ID.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String VpcConfiguration_VpcId { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'AccessPointArn'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.CreateAccessPointResponse).
/// Specifying the name of a property of type Amazon.S3Control.Model.CreateAccessPointResponse 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; } = "AccessPointArn";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the Bucket parameter.
/// The -PassThru parameter is deprecated, use -Select '^Bucket' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Bucket' 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.Bucket), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-S3CAccessPoint (CreateAccessPoint)"))
{
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.Bucket;
}
#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
context.BucketAccountId = this.BucketAccountId;
context.Name = this.Name;
#if MODULAR
if (this.Name == null && ParameterWasBound(nameof(this.Name)))
{
WriteWarning("You are passing $null as a value for parameter Name 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.PublicAccessBlockConfiguration_BlockPublicAcl = this.PublicAccessBlockConfiguration_BlockPublicAcl;
context.PublicAccessBlockConfiguration_BlockPublicPolicy = this.PublicAccessBlockConfiguration_BlockPublicPolicy;
context.PublicAccessBlockConfiguration_IgnorePublicAcl = this.PublicAccessBlockConfiguration_IgnorePublicAcl;
context.PublicAccessBlockConfiguration_RestrictPublicBucket = this.PublicAccessBlockConfiguration_RestrictPublicBucket;
context.VpcConfiguration_VpcId = this.VpcConfiguration_VpcId;
// 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.CreateAccessPointRequest();
if (cmdletContext.AccountId != null)
{
request.AccountId = cmdletContext.AccountId;
}
if (cmdletContext.Bucket != null)
{
request.Bucket = cmdletContext.Bucket;
}
if (cmdletContext.BucketAccountId != null)
{
request.BucketAccountId = cmdletContext.BucketAccountId;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
// populate PublicAccessBlockConfiguration
var requestPublicAccessBlockConfigurationIsNull = true;
request.PublicAccessBlockConfiguration = new Amazon.S3Control.Model.PublicAccessBlockConfiguration();
System.Boolean? requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_BlockPublicAcl = null;
if (cmdletContext.PublicAccessBlockConfiguration_BlockPublicAcl != null)
{
requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_BlockPublicAcl = cmdletContext.PublicAccessBlockConfiguration_BlockPublicAcl.Value;
}
if (requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_BlockPublicAcl != null)
{
request.PublicAccessBlockConfiguration.BlockPublicAcls = requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_BlockPublicAcl.Value;
requestPublicAccessBlockConfigurationIsNull = false;
}
System.Boolean? requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_BlockPublicPolicy = null;
if (cmdletContext.PublicAccessBlockConfiguration_BlockPublicPolicy != null)
{
requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_BlockPublicPolicy = cmdletContext.PublicAccessBlockConfiguration_BlockPublicPolicy.Value;
}
if (requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_BlockPublicPolicy != null)
{
request.PublicAccessBlockConfiguration.BlockPublicPolicy = requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_BlockPublicPolicy.Value;
requestPublicAccessBlockConfigurationIsNull = false;
}
System.Boolean? requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_IgnorePublicAcl = null;
if (cmdletContext.PublicAccessBlockConfiguration_IgnorePublicAcl != null)
{
requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_IgnorePublicAcl = cmdletContext.PublicAccessBlockConfiguration_IgnorePublicAcl.Value;
}
if (requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_IgnorePublicAcl != null)
{
request.PublicAccessBlockConfiguration.IgnorePublicAcls = requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_IgnorePublicAcl.Value;
requestPublicAccessBlockConfigurationIsNull = false;
}
System.Boolean? requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_RestrictPublicBucket = null;
if (cmdletContext.PublicAccessBlockConfiguration_RestrictPublicBucket != null)
{
requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_RestrictPublicBucket = cmdletContext.PublicAccessBlockConfiguration_RestrictPublicBucket.Value;
}
if (requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_RestrictPublicBucket != null)
{
request.PublicAccessBlockConfiguration.RestrictPublicBuckets = requestPublicAccessBlockConfiguration_publicAccessBlockConfiguration_RestrictPublicBucket.Value;
requestPublicAccessBlockConfigurationIsNull = false;
}
// determine if request.PublicAccessBlockConfiguration should be set to null
if (requestPublicAccessBlockConfigurationIsNull)
{
request.PublicAccessBlockConfiguration = null;
}
// populate VpcConfiguration
var requestVpcConfigurationIsNull = true;
request.VpcConfiguration = new Amazon.S3Control.Model.VpcConfiguration();
System.String requestVpcConfiguration_vpcConfiguration_VpcId = null;
if (cmdletContext.VpcConfiguration_VpcId != null)
{
requestVpcConfiguration_vpcConfiguration_VpcId = cmdletContext.VpcConfiguration_VpcId;
}
if (requestVpcConfiguration_vpcConfiguration_VpcId != null)
{
request.VpcConfiguration.VpcId = requestVpcConfiguration_vpcConfiguration_VpcId;
requestVpcConfigurationIsNull = false;
}
// determine if request.VpcConfiguration should be set to null
if (requestVpcConfigurationIsNull)
{
request.VpcConfiguration = 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.CreateAccessPointResponse CallAWSServiceOperation(IAmazonS3Control client, Amazon.S3Control.Model.CreateAccessPointRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon S3 Control", "CreateAccessPoint");
try
{
#if DESKTOP
return client.CreateAccessPoint(request);
#elif CORECLR
return client.CreateAccessPointAsync(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.String BucketAccountId { get; set; }
public System.String Name { get; set; }
public System.Boolean? PublicAccessBlockConfiguration_BlockPublicAcl { get; set; }
public System.Boolean? PublicAccessBlockConfiguration_BlockPublicPolicy { get; set; }
public System.Boolean? PublicAccessBlockConfiguration_IgnorePublicAcl { get; set; }
public System.Boolean? PublicAccessBlockConfiguration_RestrictPublicBucket { get; set; }
public System.String VpcConfiguration_VpcId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.AccessPointArn;
}
}
}