« blib/lib/Paws/S3Control/CreateAccessPointResult.pm
↑ Summary
blib/lib/Paws/S3Control/CreateBucketConfiguration.pm »
| 1 | |||
| 2 | package Paws::S3Control::CreateBucket; | ||
| 3 | use Moose; | ||
| 4 | has ACL => (is => 'ro', isa => 'Str', header_name => 'x-amz-acl', traits => ['ParamInHeader']); | ||
| 5 | has Bucket => (is => 'ro', isa => 'Str', uri_name => 'name', traits => ['ParamInURI'], required => 1); | ||
| 6 | has CreateBucketConfiguration => (is => 'ro', isa => 'Paws::S3Control::CreateBucketConfiguration', traits => ['ParamInBody']); | ||
| 7 | has GrantFullControl => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-full-control', traits => ['ParamInHeader']); | ||
| 8 | has GrantRead => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-read', traits => ['ParamInHeader']); | ||
| 9 | has GrantReadACP => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-read-acp', traits => ['ParamInHeader']); | ||
| 10 | has GrantWrite => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-write', traits => ['ParamInHeader']); | ||
| 11 | has GrantWriteACP => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-write-acp', traits => ['ParamInHeader']); | ||
| 12 | has ObjectLockEnabledForBucket => (is => 'ro', isa => 'Bool', header_name => 'x-amz-bucket-object-lock-enabled', traits => ['ParamInHeader']); | ||
| 13 | has OutpostId => (is => 'ro', isa => 'Str', header_name => 'x-amz-outpost-id', traits => ['ParamInHeader']); | ||
| 14 | |||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateBucket'); | ||
| 19 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v20180820/bucket/{name}'); | ||
| 20 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3Control::CreateBucketResult'); | ||
| 22 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 23 | |||
| 24 | |||
| 25 | 1; | ||
| 26 | |||
| 27 | ### main pod documentation begin ### | ||
| 28 | |||
| 29 | =head1 NAME | ||
| 30 | |||
| 31 | Paws::S3Control::CreateBucket - Arguments for method CreateBucket on L<Paws::S3Control> | ||
| 32 | |||
| 33 | =head1 DESCRIPTION | ||
| 34 | |||
| 35 | This class represents the parameters used for calling the method CreateBucket on the | ||
| 36 | L<AWS S3 Control|Paws::S3Control> service. Use the attributes of this class | ||
| 37 | as arguments to method CreateBucket. | ||
| 38 | |||
| 39 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBucket. | ||
| 40 | |||
| 41 | =head1 SYNOPSIS | ||
| 42 | |||
| 43 | my $s3-control = Paws->service('S3Control'); | ||
| 44 | my $CreateBucketResult = $s3 -control->CreateBucket( | ||
| 45 | Bucket => 'MyBucketName', | ||
| 46 | ACL => 'private', # OPTIONAL | ||
| 47 | CreateBucketConfiguration => { | ||
| 48 | LocationConstraint => 'EU' | ||
| 49 | , # values: EU, eu-west-1, us-west-1, us-west-2, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1, cn-north-1, eu-central-1; OPTIONAL | ||
| 50 | }, # OPTIONAL | ||
| 51 | GrantFullControl => 'MyGrantFullControl', # OPTIONAL | ||
| 52 | GrantRead => 'MyGrantRead', # OPTIONAL | ||
| 53 | GrantReadACP => 'MyGrantReadACP', # OPTIONAL | ||
| 54 | GrantWrite => 'MyGrantWrite', # OPTIONAL | ||
| 55 | GrantWriteACP => 'MyGrantWriteACP', # OPTIONAL | ||
| 56 | ObjectLockEnabledForBucket => 1, # OPTIONAL | ||
| 57 | OutpostId => 'MyNonEmptyMaxLength64String', # OPTIONAL | ||
| 58 | ); | ||
| 59 | |||
| 60 | # Results: | ||
| 61 | my $BucketArn = $CreateBucketResult->BucketArn; | ||
| 62 | my $Location = $CreateBucketResult->Location; | ||
| 63 | |||
| 64 | # Returns a L<Paws::S3Control::CreateBucketResult> object. | ||
| 65 | |||
| 66 | 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. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3-control/CreateBucket> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 ACL => Str | ||
| 73 | |||
| 74 | The canned ACL to apply to the bucket. | ||
| 75 | |||
| 76 | This is not supported by Amazon S3 on Outposts buckets. | ||
| 77 | |||
| 78 | Valid values are: C<"private">, C<"public-read">, C<"public-read-write">, C<"authenticated-read"> | ||
| 79 | |||
| 80 | =head2 B<REQUIRED> Bucket => Str | ||
| 81 | |||
| 82 | The name of the bucket. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 CreateBucketConfiguration => L<Paws::S3Control::CreateBucketConfiguration> | ||
| 87 | |||
| 88 | The configuration information for the bucket. | ||
| 89 | |||
| 90 | This is not supported by Amazon S3 on Outposts buckets. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 GrantFullControl => Str | ||
| 95 | |||
| 96 | Allows grantee the read, write, read ACP, and write ACP permissions on | ||
| 97 | the bucket. | ||
| 98 | |||
| 99 | This is not supported by Amazon S3 on Outposts buckets. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 GrantRead => Str | ||
| 104 | |||
| 105 | Allows grantee to list the objects in the bucket. | ||
| 106 | |||
| 107 | This is not supported by Amazon S3 on Outposts buckets. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 GrantReadACP => Str | ||
| 112 | |||
| 113 | Allows grantee to read the bucket ACL. | ||
| 114 | |||
| 115 | This is not supported by Amazon S3 on Outposts buckets. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 GrantWrite => Str | ||
| 120 | |||
| 121 | Allows grantee to create, overwrite, and delete any object in the | ||
| 122 | bucket. | ||
| 123 | |||
| 124 | This is not supported by Amazon S3 on Outposts buckets. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 GrantWriteACP => Str | ||
| 129 | |||
| 130 | Allows grantee to write the ACL for the applicable bucket. | ||
| 131 | |||
| 132 | This is not supported by Amazon S3 on Outposts buckets. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 ObjectLockEnabledForBucket => Bool | ||
| 137 | |||
| 138 | Specifies whether you want S3 Object Lock to be enabled for the new | ||
| 139 | bucket. | ||
| 140 | |||
| 141 | This is not supported by Amazon S3 on Outposts buckets. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 OutpostId => Str | ||
| 146 | |||
| 147 | The ID of the Outposts where the bucket is being created. | ||
| 148 | |||
| 149 | This is required by Amazon S3 on Outposts buckets. | ||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head1 SEE ALSO | ||
| 155 | |||
| 156 | This class forms part of L<Paws>, documenting arguments for method CreateBucket in L<Paws::S3Control> | ||
| 157 | |||
| 158 | =head1 BUGS and CONTRIBUTIONS | ||
| 159 | |||
| 160 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 161 | |||
| 162 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 163 | |||
| 164 | =cut | ||
| 165 |