AWS Delete

AWS Delete
Certified
Delete a single S3 object

Deletes one object by key, optionally with MFA or bypassing governance retention. Returns version/delete marker metadata.

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

Examples

yaml
id: aws_s3_delete
namespace: company.team

tasks:
  - id: delete
    type: io.kestra.plugin.aws.s3.Delete
    accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
    secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
    region: "eu-central-1"
    bucket: "my-bucket"
    key: "path/to/file"

Properties

bucket *string

The S3 bucket name

key *string

Object key

Key of the object to delete.

accessKeyId string

Access Key Id in order to connect to AWS

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

bypassGovernanceRetention booleanstring

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

compatibilityMode booleanstring

Enable compatibility mode

Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.

endpointOverride string

The endpoint with which the SDK should communicate

This property allows you to use a different S3 compatible storage backend.

forcePathStyle booleanstring

Force path style access

Must only be used when compatibilityMode is enabled.

mfa string

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

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

region string

AWS region with which the SDK should communicate

requestPayer string

Sets the value of the RequestPayer property for this object.

secretKeyId string

Secret Key Id in order to connect to AWS

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

sessionToken string

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 credentials are defined, we will use the default credentials provider chain to fetch credentials.

stsEndpointOverride string

The AWS STS endpoint with which the SDKClient should communicate

stsRoleArn string

AWS STS Role

The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

stsRoleExternalId string

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 string

DefaultPT15M

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 string

AWS STS Session name

This property is only used when an stsRoleArn is defined.

Outputs

deleteMarker boolean