CreateBucket CreateBucket

yaml
type: "io.kestra.plugin.aws.s3.CreateBucket"

Create a bucket

Examples

Create a new bucket with some options

yaml
id: "create_bucket"
type: "io.kestra.plugin.aws.s3.CreateBucket"
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
region: "eu-central-1"
bucket: "my-bucket"

Properties

accessKeyId

  • Type: string
  • Dynamic: ✔️
  • Required:

Access Key Id in order to connect to AWS. If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

acl

  • Type: string
  • Dynamic: ✔️
  • Required:

The canned ACL to apply to the bucket.

bucket

  • Type: string
  • Dynamic: ✔️
  • Required:

The S3 bucket name to create.

compatibilityMode

  • Type: boolean
  • Dynamic:
  • Required:

endpointOverride

  • Type: string
  • Dynamic: ✔️
  • Required:

The endpoint with which the SDK should communicate. This property should normally not be used except for local development.

grantFullControl

  • Type: string
  • Dynamic: ✔️
  • Required:

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

grantRead

  • Type: string
  • Dynamic: ✔️
  • Required:

Allows grantee to list the objects in the bucket.

grantReadACP

  • Type: string
  • Dynamic: ✔️
  • Required:

Allows grantee to list the ACL for the applicable bucket.

grantWrite

  • Type: string
  • Dynamic: ✔️
  • Required:

Allows grantee to create, overwrite, and delete any object in the bucket.

grantWriteACP

  • Type: string
  • Dynamic: ✔️
  • Required:

Allows grantee to write the ACL for the applicable bucket.

objectLockEnabledForBucket

  • Type: boolean
  • Dynamic:
  • Required:

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

region

  • Type: string
  • Dynamic: ✔️
  • Required:

AWS region with which the SDK should communicate.

secretKeyId

  • Type: string
  • Dynamic: ✔️
  • Required:

Secret Key Id in order to connect to AWS. If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

sessionToken

  • Type: string
  • Dynamic: ✔️
  • Required:

AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permissions to access a given resource. If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

stsEndpointOverride

  • Type: string
  • Dynamic: ✔️
  • Required:

The AWS STS endpoint with which the SDKClient should communicate.

stsRoleArn

  • Type: string
  • Dynamic: ✔️
  • Required:

AWS STS Role. The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. Otherwise, the StaticCredentialsProvider will be used with the provided Access Key Id and Secret Key.

stsRoleExternalId

  • Type: string
  • Dynamic: ✔️
  • Required:

AWS STS External Id. A unique identifier that might be required when you assume a role in another account. This property is only used when an stsRoleArn is defined.

stsRoleSessionDuration

  • Type: string
  • Dynamic:
  • Required:
  • Default: 900.000000000
  • Format: duration

AWS STS Session duration. The duration of the role session (default: 15 minutes, i.e., PT15M). This property is only used when an stsRoleArn is defined.

stsRoleSessionName

  • Type: string
  • Dynamic: ✔️
  • Required:

AWS STS Session name. This property is only used when an stsRoleArn is defined.

Outputs

bucket

  • Type: string
  • Dynamic:
  • Required:

region

  • Type: string
  • Dynamic:
  • Required: