PLUGINSPLUGIN-AWSTASKSS3IO.KESTRA.PLUGIN.AWS.S3.DELETE

​Delete

Delete Delete

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

Delete a file in a S3 bucket.

Examples

yaml
id: "delete"
type: "io.kestra.plugin.aws.s3.Delete"
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
region: "eu-central-1"
bucket: "my-bucket"
key: "path/to/file"

Properties

accessKeyId

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

The Access Key Id in order to connect to AWS

If no connection is defined, we will use default DefaultCredentialsProvider that will try to guess the value

bucket

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

The bucket name

bypassGovernanceRetention

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.

endpointOverride

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

The endpoint with which the SDK should communicate.

Should normally not be used except for local development.

key

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

The key to delete

mfa

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

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

region

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

The region with which the SDK should communicate.

requestPayer

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

Sets the value of the RequestPayer property for this object.

secretKeyId

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

The Secret Key Id in order to connect to AWS

If no connection is defined, we will use default DefaultCredentialsProvider that will try to guess the value

sessionToken

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

The he AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permission to access some resource.

If no connection is defined, we will use default DefaultCredentialsProvider that will try to guess the value

Outputs

deleteMarker

  • Type: boolean

Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.

requestCharged

  • Type: string

Returns the value of the RequestCharged property for this object.

versionId

  • Type: string

Returns the version ID of the delete marker created as a result of the DELETE operation.