1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2026-05-22 10:05:29 +02:00
Files
OpenIntegrations/docs/en/md/S3/Buckets-managment/Put-bucket-encryption.mdx
T

83 lines
2.7 KiB
Plaintext
Raw Normal View History

2024-11-14 17:27:44 +03:00
---
sidebar_position: 4
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Put bucket encryption
Sets bucket encryption by XML configuration
`Function PutBucketEncryption(Val Name, Val BasicData, Val XmlConfig, Val Directory = True, Val Headers = Undefined) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Name | --name | String | ✔ | Bucket name |
2024-11-15 11:12:10 +03:00
| BasicData | --basic | Structure of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
2024-11-14 17:27:44 +03:00
| XmlConfig | --conf | String | ✔ | XML string or file of encryption configuration |
| Directory | --dir | Boolean | ✖ | True > Directory Bucket, False > General Purpose Bucket |
| Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |
2024-11-15 22:13:43 +03:00
Returns: Structure of KeyAndValue - serialized JSON response from storage
2024-11-14 17:27:44 +03:00
<br/>
:::tip
Method at AWS documentation: [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "storage-155.s3hoster.by";
AccessKey = "BRN5RKJE67...";
SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
Region = "BTC";
BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);
2024-11-15 13:24:46 +03:00
Name = "opi-newbucket2";
2024-11-14 17:27:44 +03:00
XmlConfig = "<ServerSideEncryptionConfiguration xmlns=""http://s3.amazonaws.com/doc/2006-03-01/"">
| <Rule>
| <ApplyServerSideEncryptionByDefault>
| <SSEAlgorithm>AES256</SSEAlgorithm>
| </ApplyServerSideEncryptionByDefault>
| </Rule>
|</ServerSideEncryptionConfiguration>";
Result = OPI_S3.PutBucketEncryption(Name, BasicData, XmlConfig, False);
```
2024-11-17 16:09:58 +03:00
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
# JSON data can also be passed as a path to a .json file
oint s3 PutBucketEncryption \
--name "opi-newbucket2" \
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}" \
--conf "C:\Users\Administrator\AppData\Local\Temp\4tgsfjxvn2d.xml" \
--dir false
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
:: JSON data can also be passed as a path to a .json file
oint s3 PutBucketEncryption ^
--name "opi-newbucket2" ^
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}" ^
--conf "C:\Users\Administrator\AppData\Local\Temp\4tgsfjxvn2d.xml" ^
--dir false
```
</TabItem>
</Tabs>
2024-11-14 17:27:44 +03:00