Create an AWS S3 Bucket

Octopus.AwsCreateS3 exported 2026-07-22 by Octopus Deploy belongs to ‘Aws’ category.

Create an Amazon S3 bucket with optional configuration for tags, public access, and object ownership.

Parameters

When this step is included in a project’s deployment process, the parameters below can be set.

S3 Bucket Name

Octopus.Action.Aws.S3.BucketName (required)

The name of the S3 bucket to be created. Must be between 3 and 63 characters. Only lower case letters, numbers, dots, and hyphens are allowed.

Example: my-new-bucket

AWS Region

Octopus.Action.Aws.Region (required)

The AWS region where the S3 bucket will be created.

Example: us-west-2

Use Worker Credentials

Octopus.Action.AwsAccount.UseInstanceRole

Execute using credentials configured on the worker rather than a specific AWS account.

Allowed values: True, False

Default: True

AWS Account

Octopus.Action.AwsAccount.Variable

The AWS account to use for authentication when not using worker credentials.

Assume IAM Role

Octopus.Action.Aws.AssumeRole

Whether to assume a different AWS IAM role for executing this step.

Allowed values: True, False

Default: False

Role ARN

Octopus.Action.Aws.AssumedRoleArn

The Amazon Resource Name (ARN) of the IAM role to assume.

Example: arn:aws:iam::123456789012:role/ExampleRole

Session Name

Octopus.Action.Aws.AssumedRoleSession

A name for the assumed role session. Leave blank to use an automatically generated session name.

Session Duration (seconds)

Octopus.Action.Aws.AssumeRoleSessionDurationSeconds

The duration in seconds for the assumed role session. Leave blank to use the default session duration on the role being assumed.

Example: 3600

External ID

Octopus.Action.Aws.AssumeRoleExternalId

An external ID to provide additional security when assuming the role.

Tags

Octopus.Action.Aws.CloudFormation.Tags

Tags to apply to the S3 bucket as a JSON array of key-value pairs. Tag value and key have basic restrictions applied.

Example: [{"key":"Environment","value":"Production"}]

CloudFormation Stack Name

Octopus.Action.Aws.CloudFormationStackName

Optionally enter the name of the CloudFormation stack used by this deployment. If left blank, Octopus will generate a unique name. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Enable Public Access

Octopus.Action.Aws.S3.PublicAccess

Enable public access control on the S3 bucket. This setting is required when setting non-private Canned ACLs on objects.

Allowed values: True, False

Default: False

Object Ownership

Octopus.Action.Aws.S3.ObjectWriterOwnership

If enabled, the account creating the object will be the owner. If disabled, the bucket owner will be the object owner.

Allowed values: True, False

Default: False

Step configuration using OCL

Example in Octopus Configuration Language (OCL):

step "create-s3-bucket" {
    name = "Create S3 Bucket"

    action {
        action_type = "Octopus.AwsCreateS3"
        properties = {
            Octopus.Action.Aws.AssumeRole = "False"
            Octopus.Action.Aws.Region = "us-east-1"
            Octopus.Action.Aws.S3.BucketName = "my-new-bucket"
            Octopus.Action.AwsAccount.UseInstanceRole = "False"
            Octopus.Action.AwsAccount.Variable = "aws-account"
            Octopus.Action.RunOnServer = "false"
        }
    }
}

Page updated on Wednesday, July 22, 2026