> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# appmixer.aws.s3.CreateBucket

- Component: `appmixer.aws.s3.CreateBucket`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.aws.s3 2.2.2](https://connectors.appmixer.com/connector/appmixer.aws.s3/2.2.2.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.aws.s3/2.2.2/component/appmixer.aws.s3.CreateBucket>

Create bucket on AWS S3.

## Properties

| Field | Type | Description |
| --- | --- | --- |
| Region (`region`) | text | Your AWS instance region. If not select, us-east-1 will be used as default. |

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Bucket Name. (`name`) | text | The name of the bucket to create. It must contain a lowercase letter, number or dash(-). |
| Access Control. (`acl`) | select | The canned ACL to apply to the bucket. |
| Enable Versioning. (`versionEnabled`) | toggle | Specifies whether you want to keep multiple versions of an object in the same bucket. |
| Enable Lock. (`lockEnabled`) | toggle | Specifies whether you want S3 Object Lock to be enabled for the new bucket. |

## Output ports

### Port `bucket`

| Field | Type | Description |
| --- | --- | --- |
| Bucket Name (`Name`) | string | - |
| Bucket Location (`Location`) | string | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.aws.s3.CreateBucket",
  "author": "Jimoh Damilola <jimoh@client.io>",
  "description": "Create bucket on AWS S3.",
  "private": false,
  "auth": {
    "service": "appmixer:aws:s3"
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "acl": {
            "type": "string"
          },
          "versionEnabled": {
            "type": "boolean"
          },
          "lockEnabled": {
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "versionEnabled"
        ]
      },
      "inspector": {
        "inputs": {
          "name": {
            "type": "text",
            "label": "Bucket Name.",
            "index": 1,
            "tooltip": "The name of the bucket to create. It must contain a lowercase letter, number or dash(-)."
          },
          "acl": {
            "type": "select",
            "label": "Access Control.",
            "index": 2,
            "tooltip": "The canned ACL to apply to the bucket.",
            "options": [
              {
                "clearItem": true,
                "content": "Clear"
              },
              {
                "value": "private",
                "content": "private"
              },
              {
                "value": "public-read",
                "content": "public-read"
              },
              {
                "value": "public-read-write",
                "content": "public-read-write"
              },
              {
                "value": "authenticated-read",
                "content": "authenticated-read"
              }
            ]
          },
          "versionEnabled": {
            "type": "toggle",
            "label": "Enable Versioning.",
            "defaultValue": true,
            "tooltip": "Specifies whether you want to keep multiple versions of an object in the same bucket.",
            "index": 3
          },
          "lockEnabled": {
            "type": "toggle",
            "label": "Enable Lock.",
            "defaultValue": false,
            "tooltip": "Specifies whether you want S3 Object Lock to be enabled for the new bucket.",
            "index": 4
          }
        }
      }
    }
  ],
  "properties": {
    "schema": {
      "properties": {
        "region": {
          "type": "string"
        }
      }
    },
    "inspector": {
      "inputs": {
        "region": {
          "type": "text",
          "label": "Region",
          "index": 1,
          "tooltip": "Your AWS instance region. If not select, us-east-1 will be used as default.",
          "source": {
            "url": "/component/appmixer/aws/s3/ListRegions?outPort=out"
          }
        }
      }
    }
  },
  "outPorts": [
    {
      "name": "bucket",
      "options": [
        {
          "label": "Bucket Name",
          "value": "Name",
          "schema": {
            "type": "string",
            "example": "my-app-data-bucket"
          }
        },
        {
          "label": "Bucket Location",
          "value": "Location",
          "schema": {
            "type": "string",
            "example": "http://my-app-data-bucket.s3.amazonaws.com/"
          }
        }
      ]
    }
  ],
  "icon": "(data URI omitted)"
}
```
