- Created by Kirstin Seidel-Gebert, last modified on Apr 20, 2023
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 2 Next »
Stereotype Attributes
S3 Alias
| Attribute | Description | Allowed Values / Examples | |
|---|---|---|---|
| endpointOverride | Specify hostname and port (if necessary) of the S3 endpoint. | minio:9000 | |
| scheme | Specify the protocol to access the S3 endpoint specified with endpointOverride. | http | Use the HTTP protocol. |
| https | Use the HTTPS protocol (default). | ||
| region | Specify the Amazon region your S3 is hosted in (if necessary). | ||
| followRedirectsPolicy | Specify the redirect behavior of requests to the S3 endpoint. | DEFAULT ALWAYS | Always redirect. |
| NEVER | Never redirect. | ||
| disableExpectHeader | Specify whether the "Expect: 100-Continue" should not be added your request to the S3 endpoint. | true | Do not add an "Expect: 100-Continue" header to the request. |
| false | Add an "Expect: 100-Continue" header to the request. | ||
| Authentication | |||
| user | Specify the user that will be used to access the S3 endpoint. | aMinioUser | |
| password | Specify the password of user. | aMinioPassword | |
| SSL / TLS | |||
| certificateAuthorityPath | Specify the path to your certificate trust store. | ||
| certificateAuthorityFilePath | Specify the path to the certificate authority. | ||
| verifySSL | Specify whether to disable SSL checks. This is for testing purposes only and should not disabled in productive environments. | true | Perform SSL checks. |
| false | Disable SSL checks. | ||
| Proxy | |||
| proxyHost | Specify the URL of the proxy server. | See CURLOPT_PROXY. | |
| proxyPort | Specify the proxy port. | See CURLOPT_PROXY. | |
| proxyScheme | Specify the proxy protocol. | See CURLOPT_PROXY. | |
| http | Use the HTTP protocol. | ||
| https | Use the HTTPS protocol (default). | ||
| Proxy Authentication | |||
| proxyUser | Specify the proxy user. | See CURLOPT_PROXYUSERPWD. | |
| proxyPassword | Specify the proxy password. | See CURLOPT_PROXYUSERPWD. | |
| Proxy SSL / TLS | |||
| proxyCertificateFile | Specify a file name containing the proxy certificate. | | |
| proxyCertificateType | Specify the type of the certificate. | | |
| proxySSLKeyFile | Specify a file name containing the private key. | | |
| proxySSLKeyType | Specify the type of the key. | | |
| proxySSLKeyPassword | Specify the password for the private key. | | |
Parameters Bucket Handling
bucketStatus
If the bucket you want to get the status of is not existing, an exception is thrown.
| Name | Type | Direction | Description | Allowed Values / Examples |
|---|---|---|---|---|
| bucketName | String | in | Name of the bucket to get the status of. | |
| bucketStatus | BucketStatus | out | Object containing the status information as described further below. |
createBucket
| Name | Type | Direction | Description | Allowed Values / Examples | |
|---|---|---|---|---|---|
| bucketName | String | in | Name of the bucket to create. The name of the bucket should be prefixed with the PAS client. | If a bucket with the same name is already existing or if the bucket name does not match the S3 bucket naming rules, an exception is thrown. pas-doc-examples | |
deleteBucket
| Name | Type | Direction | Description | Allowed Values / Examples | |
|---|---|---|---|---|---|
| bucketName | String | in | Name of the bucket to delete. | There will be no exception if the bucket you want to delete is not existing. | |
| deleteRecursively | Boolean | in | With S3, as a rule, only empty buckets can be deleted. Specify here whether to delete the bucket and all of its contents in one go. | true | Delete the bucket and all its contents. |
| false | Bucket must be empty to be deleted (default). | ||||
listBuckets
| Name | Type | Direction | Description | Allowed Values / Examples | |
|---|---|---|---|---|---|
| bucketNames | Array of String | out | List of buckets that are available from the specified S3 endpoint. | ||
listObjects
| Name | Type | Direction | Description | Allowed Values / Examples | |
|---|---|---|---|---|---|
| bucketName | String | in | Name of the bucket to list the contents of. | If the bucket is not existing, an exception is thrown. | |
| objectNames | Array of String | out | List of objects that reside within the given bucket. | ||
Operations and Parameters Object Handling
copyObject
| Name | Type | Direction | Description | Allowed Values / Examples | |
|---|---|---|---|---|---|
| bucketName | String | in | Name of the bucket to copy an object from. | If the bucket is not existing, an exception is thrown. | |
| objectName | String | in | Name of the object to be copied. | If the object is not existing, an exception is thrown. | |
| targetBucketName | String | in | Name of the bucket to copy the selected object to. | If the bucket is not existing, an exception is thrown. Also, the target bucket must differ from the source bucket. | |
deleteObject Operations
delete ( bucketName : String, objectName : String )delete ( bucketName : String, objectName : String, version : String )
| Name | Type | Direction | Description | Allowed Values / Examples | |
|---|---|---|---|---|---|
| bucketName | String | in | Name of the bucket to delete an object from. | If the bucket is not existing, an exception is thrown. | |
| objectName | String | in | Name of the object to delete. | If the object is not existing, no exception will be thrown. | |
| version | String | in | For versioned buckets: Specify here the identifier of the object version to delete. If no version is specified for a versioned bucket, a new delete marker is created and the object is marked as deleted (see deleteMarkers). | If the version is not existing, an exception is thrown. | |
getObject Operations
getObject ( bucketName : String, objectName : String, filePath : String )getObject ( bucketName : String, objectName : String, filePath : String, version : String )getObject ( bucketName : String, objectName : String, objectData: Blob )getObject ( bucketName : String, objectName : String, version : String, objectData: Blob )
| Name | Type | Direction | Description | Allowed Values / Examples | |
|---|---|---|---|---|---|
| bucketName | String | in | Name of the bucket to get an object from. | If the bucket is not existing, an exception is thrown. | |
| objectName | String | in | Name of the object to get. | If the object is not existing, an exception is thrown. | |
| version | String | in | Version of the object to get. If no version is specified, the latest version is retrieved. | If the version is not existing, an exception is thrown. | |
| filePath | String | in | Path of the file on the local filesystem (in service context) to store the retrieved object to. | If the file path cannot be accessed, an exception is thrown. | |
| objectData | Blob | out | Blob containing the contents of the retrieved object data. | ||
listObjects
listObjects ( bucketName: String, objectNames: String[] )
Name
Type
Direction
Description
Allowed Values / Examples
bucketName
String
in
Name of the bucket to list the contents of.
If the bucket is not existing, an exception is thrown.
objectNames
Array of String
out
List of objects that reside within the given bucket.
objectStatus
| Name | Type | Direction | Description | Allowed Values / Examples | |
|---|---|---|---|---|---|
| bucketName | String | in | Name of the bucket the object resides in. | If the bucket is not existing, an exception is thrown. | |
| objectName | String | in | Name of the object to get the object status of. | If the object is not existing, an exception is thrown. | |
| objectStatus | ObjectStatus | out | Object containing the status information as described further below. | ||
putObject
If the bucket is not versioned, the object is updated without any further warning, otherwise a new version of the object is created.
putObject ( bucketName : String, objectName : String, filePath : String )putObject ( bucketName : String, objectName : String, objectData: Blob )
| Name | Type | Direction | Description | Allowed Values / Examples |
|---|---|---|---|---|
| bucketName | String | in | Name of the bucket to put the object to. This must be an existing bucket, otherwise an exception is thrown. | If the bucket is not existing, an exception is thrown. |
| objectName | String | in | Name of the object to store. | No exception will be thrown if the object you want to put is already existing. |
| filePath | String | in | Path to the file on the local filesystem (in service context) to get the object contents from. | You must specify either filePath, or objectData. If the file is not available, an exception will be thrown. |
| objectData | Blob | in | Object data to store as a Blob. | You must specify either objectData, or filePath. |
S3 Adapter Parameter Types
BucketStatus
| Attribute | Type | Description |
|---|---|---|
| name | String | Name of the bucket. |
| size | Integer | Size of the bucket in bytes. |
| containedObjects | Array of String | List of objects that reside within the bucket. |
| creationDate | DateTime | Creation timestamp of the bucket. |
ObjectStatus
| Attribute | Type | Description | Examples |
|---|---|---|---|
| name | String | Name of the object. | |
| size | Integer | Size of the object in bytes. | |
| type | String | Type of the object as identified by AWS. | png, txt |
| creationDate | DateTime | Creation timestamp of the object (last version if versioned). | |
| latestVersion | String | Number of the latest version. | |
| versions | Array of String | List of version numbers of the object. The order within the array reflects the order in which the versions have been created. So, versions[0] contains the version number of the first version of the object. | |
| deleteMarkers | Array of String | List of delete markers of the object. |
- No labels
Overview
Content Tools