Ada lebih banyak contoh AWS SDK yang tersedia di repo Contoh [SDK AWS Doc](https://github.com/awsdocs/aws-doc-sdk-examples). GitHub
Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Gunakan `PutObjectLockConfiguration` dengan AWS SDK atau CLI
Contoh kode berikut menunjukkan cara menggunakan`PutObjectLockConfiguration`.
Contoh tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Anda dapat melihat tindakan ini dalam konteks dalam contoh kode berikut:
+ [Kunci objek Amazon S3](s3_example_s3_Scenario_ObjectLock_section.md)
------
#### [ .NET ]
**SDK untuk .NET**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3/scenarios/S3ObjectLockScenario#code-examples).
Atur konfigurasi kunci objek dari ember.
```
///
/// Enable object lock on an existing bucket.
///
/// The name of the bucket to modify.
/// True if successful.
public async Task EnableObjectLockOnBucket(string bucketName)
{
try
{
// First, enable Versioning on the bucket.
await _amazonS3.PutBucketVersioningAsync(new PutBucketVersioningRequest()
{
BucketName = bucketName,
VersioningConfig = new S3BucketVersioningConfig()
{
EnableMfaDelete = false,
Status = VersionStatus.Enabled
}
});
var request = new PutObjectLockConfigurationRequest()
{
BucketName = bucketName,
ObjectLockConfiguration = new ObjectLockConfiguration()
{
ObjectLockEnabled = new ObjectLockEnabled("Enabled"),
},
};
var response = await _amazonS3.PutObjectLockConfigurationAsync(request);
Console.WriteLine($"\tAdded an object lock policy to bucket {bucketName}.");
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error modifying object lock: '{ex.Message}'");
return false;
}
}
```
Setel periode retensi default bucket.
```
///
/// Set or modify a retention period on an S3 bucket.
///
/// The bucket to modify.
/// The retention mode.
/// The date for retention until.
/// True if successful.
public async Task ModifyBucketDefaultRetention(string bucketName, bool enableObjectLock, ObjectLockRetentionMode retention, DateTime retainUntilDate)
{
var enabledString = enableObjectLock ? "Enabled" : "Disabled";
var timeDifference = retainUntilDate.Subtract(DateTime.Now);
try
{
// First, enable Versioning on the bucket.
await _amazonS3.PutBucketVersioningAsync(new PutBucketVersioningRequest()
{
BucketName = bucketName,
VersioningConfig = new S3BucketVersioningConfig()
{
EnableMfaDelete = false,
Status = VersionStatus.Enabled
}
});
var request = new PutObjectLockConfigurationRequest()
{
BucketName = bucketName,
ObjectLockConfiguration = new ObjectLockConfiguration()
{
ObjectLockEnabled = new ObjectLockEnabled(enabledString),
Rule = new ObjectLockRule()
{
DefaultRetention = new DefaultRetention()
{
Mode = retention,
Days = timeDifference.Days // Can be specified in days or years but not both.
}
}
}
};
var response = await _amazonS3.PutObjectLockConfigurationAsync(request);
Console.WriteLine($"\tAdded a default retention to bucket {bucketName}.");
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"\tError modifying object lock: '{ex.Message}'");
return false;
}
}
```
+ Untuk detail API, lihat [PutObjectLockConfiguration](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/PutObjectLockConfiguration)di *Referensi AWS SDK untuk .NET API*.
------
#### [ CLI ]
**AWS CLI**
**Untuk mengatur konfigurasi kunci objek pada ember**
`put-object-lock-configuration`Contoh berikut menetapkan kunci objek 50 hari pada bucket yang ditentukan.
```
aws s3api put-object-lock-configuration \
--bucket amzn-s3-demo-bucket-with-object-lock \
--object-lock-configuration '{ "ObjectLockEnabled": "Enabled", "Rule": { "DefaultRetention": { "Mode": "COMPLIANCE", "Days": 50 }}}'
```
Perintah ini tidak menghasilkan output.
+ Untuk detail API, lihat [PutObjectLockConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-object-lock-configuration.html)di *Referensi AWS CLI Perintah*.
------
#### [ Go ]
**SDK untuk Go V2**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/workflows/s3_object_lock#code-examples).
Atur konfigurasi kunci objek dari ember.
```
import (
"bytes"
"context"
"errors"
"fmt"
"log"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// S3Actions wraps S3 service actions.
type S3Actions struct {
S3Client *s3.Client
S3Manager *manager.Uploader
}
// EnableObjectLockOnBucket enables object locking on an existing bucket.
func (actor S3Actions) EnableObjectLockOnBucket(ctx context.Context, bucket string) error {
// Versioning must be enabled on the bucket before object locking is enabled.
verInput := &s3.PutBucketVersioningInput{
Bucket: aws.String(bucket),
VersioningConfiguration: &types.VersioningConfiguration{
MFADelete: types.MFADeleteDisabled,
Status: types.BucketVersioningStatusEnabled,
},
}
_, err := actor.S3Client.PutBucketVersioning(ctx, verInput)
if err != nil {
var noBucket *types.NoSuchBucket
if errors.As(err, &noBucket) {
log.Printf("Bucket %s does not exist.\n", bucket)
err = noBucket
}
return err
}
input := &s3.PutObjectLockConfigurationInput{
Bucket: aws.String(bucket),
ObjectLockConfiguration: &types.ObjectLockConfiguration{
ObjectLockEnabled: types.ObjectLockEnabledEnabled,
},
}
_, err = actor.S3Client.PutObjectLockConfiguration(ctx, input)
if err != nil {
var noBucket *types.NoSuchBucket
if errors.As(err, &noBucket) {
log.Printf("Bucket %s does not exist.\n", bucket)
err = noBucket
}
}
return err
}
```
Setel periode retensi default bucket.
```
import (
"bytes"
"context"
"errors"
"fmt"
"log"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// S3Actions wraps S3 service actions.
type S3Actions struct {
S3Client *s3.Client
S3Manager *manager.Uploader
}
// ModifyDefaultBucketRetention modifies the default retention period of an existing bucket.
func (actor S3Actions) ModifyDefaultBucketRetention(
ctx context.Context, bucket string, lockMode types.ObjectLockEnabled, retentionPeriod int32, retentionMode types.ObjectLockRetentionMode) error {
input := &s3.PutObjectLockConfigurationInput{
Bucket: aws.String(bucket),
ObjectLockConfiguration: &types.ObjectLockConfiguration{
ObjectLockEnabled: lockMode,
Rule: &types.ObjectLockRule{
DefaultRetention: &types.DefaultRetention{
Days: aws.Int32(retentionPeriod),
Mode: retentionMode,
},
},
},
}
_, err := actor.S3Client.PutObjectLockConfiguration(ctx, input)
if err != nil {
var noBucket *types.NoSuchBucket
if errors.As(err, &noBucket) {
log.Printf("Bucket %s does not exist.\n", bucket)
err = noBucket
}
}
return err
}
```
+ Untuk detail API, lihat [PutObjectLockConfiguration](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.PutObjectLockConfiguration)di *Referensi AWS SDK untuk Go API*.
------
#### [ Java ]
**SDK untuk Java 2.x**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples).
Atur konfigurasi kunci objek dari ember.
```
// Enable object lock on an existing bucket.
public void enableObjectLockOnBucket(String bucketName) {
try {
VersioningConfiguration versioningConfiguration = VersioningConfiguration.builder()
.status(BucketVersioningStatus.ENABLED)
.build();
PutBucketVersioningRequest putBucketVersioningRequest = PutBucketVersioningRequest.builder()
.bucket(bucketName)
.versioningConfiguration(versioningConfiguration)
.build();
// Enable versioning on the bucket.
getClient().putBucketVersioning(putBucketVersioningRequest);
PutObjectLockConfigurationRequest request = PutObjectLockConfigurationRequest.builder()
.bucket(bucketName)
.objectLockConfiguration(ObjectLockConfiguration.builder()
.objectLockEnabled(ObjectLockEnabled.ENABLED)
.build())
.build();
getClient().putObjectLockConfiguration(request);
System.out.println("Successfully enabled object lock on "+bucketName);
} catch (S3Exception ex) {
System.out.println("Error modifying object lock: '" + ex.getMessage() + "'");
}
}
```
Setel periode retensi default bucket.
```
// Set or modify a retention period on an S3 bucket.
public void modifyBucketDefaultRetention(String bucketName) {
VersioningConfiguration versioningConfiguration = VersioningConfiguration.builder()
.mfaDelete(MFADelete.DISABLED)
.status(BucketVersioningStatus.ENABLED)
.build();
PutBucketVersioningRequest versioningRequest = PutBucketVersioningRequest.builder()
.bucket(bucketName)
.versioningConfiguration(versioningConfiguration)
.build();
getClient().putBucketVersioning(versioningRequest);
DefaultRetention rention = DefaultRetention.builder()
.days(1)
.mode(ObjectLockRetentionMode.GOVERNANCE)
.build();
ObjectLockRule lockRule = ObjectLockRule.builder()
.defaultRetention(rention)
.build();
ObjectLockConfiguration objectLockConfiguration = ObjectLockConfiguration.builder()
.objectLockEnabled(ObjectLockEnabled.ENABLED)
.rule(lockRule)
.build();
PutObjectLockConfigurationRequest putObjectLockConfigurationRequest = PutObjectLockConfigurationRequest.builder()
.bucket(bucketName)
.objectLockConfiguration(objectLockConfiguration)
.build();
getClient().putObjectLockConfiguration(putObjectLockConfigurationRequest) ;
System.out.println("Added a default retention to bucket "+bucketName +".");
}
```
+ Untuk detail API, lihat [PutObjectLockConfiguration](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/PutObjectLockConfiguration)di *Referensi AWS SDK for Java 2.x API*.
------
#### [ JavaScript ]
**SDK untuk JavaScript (v3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples).
Atur konfigurasi kunci objek dari ember.
```
import {
PutObjectLockConfigurationCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Enable S3 Object Lock for an Amazon S3 bucket.
* After you enable Object Lock on a bucket, you can't
* disable Object Lock or suspend versioning for that bucket.
* @param {{ bucketName: string, enabled: boolean }}
*/
export const main = async ({ bucketName }) => {
const client = new S3Client({});
const command = new PutObjectLockConfigurationCommand({
Bucket: bucketName,
// The Object Lock configuration that you want to apply to the specified bucket.
ObjectLockConfiguration: {
ObjectLockEnabled: "Enabled",
},
});
try {
await client.send(command);
console.log(`Object Lock for "${bucketName}" enabled.`);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while modifying the object lock configuration for the bucket "${bucketName}". The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while modifying the object lock configuration for the bucket "${bucketName}". ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
bucketName: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
Setel periode retensi default bucket.
```
import {
PutObjectLockConfigurationCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Change the default retention settings for an object in an Amazon S3 bucket.
* @param {{ bucketName: string, retentionDays: string }}
*/
export const main = async ({ bucketName, retentionDays }) => {
const client = new S3Client({});
try {
await client.send(
new PutObjectLockConfigurationCommand({
Bucket: bucketName,
// The Object Lock configuration that you want to apply to the specified bucket.
ObjectLockConfiguration: {
ObjectLockEnabled: "Enabled",
Rule: {
// The default Object Lock retention mode and period that you want to apply
// to new objects placed in the specified bucket. Bucket settings require
// both a mode and a period. The period can be either Days or Years but
// you must select one.
DefaultRetention: {
// In governance mode, users can't overwrite or delete an object version
// or alter its lock settings unless they have special permissions. With
// governance mode, you protect objects against being deleted by most users,
// but you can still grant some users permission to alter the retention settings
// or delete the objects if necessary.
Mode: "GOVERNANCE",
Days: Number.parseInt(retentionDays),
},
},
},
}),
);
console.log(
`Set default retention mode to "GOVERNANCE" with a retention period of ${retentionDays} day(s).`,
);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while setting the default object retention for a bucket. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while setting the default object retention for a bucket. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
bucketName: {
type: "string",
required: true,
},
retentionDays: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
+ Untuk detail API, lihat [PutObjectLockConfiguration](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/PutObjectLockConfigurationCommand)di *Referensi AWS SDK untuk JavaScript API*.
------
#### [ Python ]
**SDK untuk Python (Boto3)**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/scenarios/object-locking#code-examples).
Letakkan konfigurasi kunci objek.
```
s3_client.put_object_lock_configuration(
Bucket=bucket,
ObjectLockConfiguration={"ObjectLockEnabled": "Disabled", "Rule": {}},
)
```
+ Untuk detail API, lihat [PutObjectLockConfiguration](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/PutObjectLockConfiguration)di *AWS SDK for Python (Boto3) Referensi* API.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara mengatur dan menjalankannya di [Repositori Contoh Kode AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples).
```
TRY.
" Example: Enable object lock with default retention
" iv_enabled = 'Enabled'
lo_s3->putobjectlockconfiguration(
iv_bucket = iv_bucket_name
io_objectlockconfiguration = NEW /aws1/cl_s3_objectlockconf(
iv_objectlockenabled = iv_enabled ) ).
MESSAGE 'Object lock configuration set.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ Untuk detail API, lihat [PutObjectLockConfiguration](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)di *AWS SDK untuk referensi SAP ABAP* API.
------