create #

Creates a S3 bucket

Query Syntax #

HTTP #

URL: http://kuzzle:7512/bucket/create/<bucketName>/<bucketRegion>
Method: POST
Body:

      {
        "options":{ <OptionsList> },
        "cors":{ <CORS> }
        "disableDotsInName": false
      }

Other protocols #

{
  "controller": "s3",
  "action": "create",
  "bucketName": "<bucketname>",
  "bucketRegion": "<bucketRegion>",
  "body": {
      "options": { <OptionsList> },
      "cors":{ <CORS> }
      "disableDotsInName": false 
  }
}

Arguments #

bucketName: the name of the bucket, bucket will need to follow the AWS Bucket Name Guidelines.
bucketRegion: the region where you want to create the bucket, see AWS Documentation for available regions.
options (optional): Specify options like a custom ACL, otherwise it will default to :

      {
        ACL: 'public-read'
      }

cors (optional): Specify a custom CORS policy to add to your bucket, otherwise it will default to :

      {
        AllowedHeaders: ['*'],
        AllowedMethods: ['GET', 'POST', 'PUT'],
        AllowedOrigins: ['*'],
      }

disableDotsInName (optional): changes the name checks on the bucketName variable to check for dots, which would prevent S3 Transfer Acceleration from working.

Response #

Returns an object with the following properties:

{
      "status": 200,
      "error": null,
      "action": "create",
      "controller": "s3/bucket",
      "result": {
        "bucketName: "<bucketname>",
        "bucketRegion":"<bucketregion>",
        "options": { <OptionsList> },
        "cors": { <CORS> }
      }
}

Edit this page on Github