« blib/lib/Paws/S3Control/BucketLevel.pm
↑ Summary
blib/lib/Paws/S3Control/CreateAccessPointForObjectLambda.pm »
| 1 | |||
| 2 | package Paws::S3Control::CreateAccessPoint; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str', header_name => 'x-amz-account-id', traits => ['ParamInHeader'], required => 1); | ||
| 5 | has Bucket => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', uri_name => 'name', traits => ['ParamInURI'], required => 1); | ||
| 7 | has PublicAccessBlockConfiguration => (is => 'ro', isa => 'Paws::S3Control::PublicAccessBlockConfiguration'); | ||
| 8 | has VpcConfiguration => (is => 'ro', isa => 'Paws::S3Control::VpcConfiguration'); | ||
| 9 | |||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateAccessPoint'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v20180820/accesspoint/{name}'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3Control::CreateAccessPointResult'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | class_has _top_level_element => (isa => 'Str', is => 'ro', default => 'CreateAccessPointRequest'); | ||
| 19 | class_has _top_level_namespace => (isa => 'Str', is => 'ro', default => 'http://awss3control.amazonaws.com/doc/2018-08-20/'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::S3Control::CreateAccessPoint - Arguments for method CreateAccessPoint on L<Paws::S3Control> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateAccessPoint on the | ||
| 31 | L<AWS S3 Control|Paws::S3Control> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateAccessPoint. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAccessPoint. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $s3-control = Paws->service('S3Control'); | ||
| 39 | my $CreateAccessPointResult = $s3 -control->CreateAccessPoint( | ||
| 40 | AccountId => 'MyAccountId', | ||
| 41 | Bucket => 'MyBucketName', | ||
| 42 | Name => 'MyAccessPointName', | ||
| 43 | PublicAccessBlockConfiguration => { | ||
| 44 | BlockPublicAcls => 1, # OPTIONAL | ||
| 45 | BlockPublicPolicy => 1, # OPTIONAL | ||
| 46 | IgnorePublicAcls => 1, # OPTIONAL | ||
| 47 | RestrictPublicBuckets => 1, # OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | VpcConfiguration => { | ||
| 50 | VpcId => 'MyVpcId', # min: 1, max: 1024 | ||
| 51 | |||
| 52 | }, # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $AccessPointArn = $CreateAccessPointResult->AccessPointArn; | ||
| 57 | |||
| 58 | # Returns a L<Paws::S3Control::CreateAccessPointResult> object. | ||
| 59 | |||
| 60 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 61 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3-control/CreateAccessPoint> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> AccountId => Str | ||
| 67 | |||
| 68 | The AWS account ID for the owner of the bucket for which you want to | ||
| 69 | create an access point. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> Bucket => Str | ||
| 74 | |||
| 75 | The name of the bucket that you want to associate this access point | ||
| 76 | with. | ||
| 77 | |||
| 78 | For using this parameter with Amazon S3 on Outposts with the REST API, | ||
| 79 | you must specify the name and the x-amz-outpost-id as well. | ||
| 80 | |||
| 81 | For using this parameter with S3 on Outposts with the AWS SDK and CLI, | ||
| 82 | you must specify the ARN of the bucket accessed in the format | ||
| 83 | C<arn:aws:s3-outposts:E<lt>RegionE<gt>:E<lt>account-idE<gt>:outpost/E<lt>outpost-idE<gt>/bucket/E<lt>my-bucket-nameE<gt>>. | ||
| 84 | For example, to access the bucket C<reports> through outpost | ||
| 85 | C<my-outpost> owned by account C<123456789012> in Region C<us-west-2>, | ||
| 86 | use the URL encoding of | ||
| 87 | C<arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports>. | ||
| 88 | The value must be URL encoded. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> Name => Str | ||
| 93 | |||
| 94 | The name you want to assign to this access point. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 PublicAccessBlockConfiguration => L<Paws::S3Control::PublicAccessBlockConfiguration> | ||
| 99 | |||
| 100 | The C<PublicAccessBlock> configuration that you want to apply to the | ||
| 101 | access point. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 VpcConfiguration => L<Paws::S3Control::VpcConfiguration> | ||
| 106 | |||
| 107 | If you include this field, Amazon S3 restricts access to this access | ||
| 108 | point to requests from the specified virtual private cloud (VPC). | ||
| 109 | |||
| 110 | This is required for creating an access point for Amazon S3 on Outposts | ||
| 111 | buckets. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head1 SEE ALSO | ||
| 117 | |||
| 118 | This class forms part of L<Paws>, documenting arguments for method CreateAccessPoint in L<Paws::S3Control> | ||
| 119 | |||
| 120 | =head1 BUGS and CONTRIBUTIONS | ||
| 121 | |||
| 122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 123 | |||
| 124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 125 | |||
| 126 | =cut | ||
| 127 |