Delete

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

Delete a file in a S3 bucket.

Examples

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: ❌

Access Key Id in order to connect to AWS.

If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

bucket

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

The S3 bucket name.

bypassGovernanceRetention

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

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

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.

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: ❌

AWS 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: ❌

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

deleteMarker

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

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

requestCharged

• Type: string
• Dynamic: ❓
• Required: ❌

Returns the value of the RequestCharged property for this object.

versionId

• Type: string
• Dynamic: ❓
• Required: ❌

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