Classic/VPC 환경에서 이용 가능합니다.
Ncloud Storage 객체에 보존(Retention) 설정을 적용합니다.
명령어
명령어 구문은 다음과 같습니다.
aws s3api put-object-retention --bucket <value> --key <value> --retention <value> [--options]
파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 파라미터 | 타입 | 필수 여부 | 설명 | 제약 사항 |
|---|---|---|---|---|
| --bucket <value> | string | Y | 객체가 저장된 대상 버킷 | - |
| --key <value> | string | Y | 보존을 설정할 객체 이름 | - |
| --retention <value> | structure | Y | 적용할 보존 설정 | JSON 구조
|
| --endpoint-url <value> | string | Y | 명령 호출의 기본 URL 지정 | kr 리전만 가능, 호출 도메인 정보는 Ncloud Storage 개요 참고 |
| --version-id <value> | string | N | 보존을 설정할 객체의 버전 ID 지정 | - |
| --bypass-governance-retention | --no-bypass-governance-retention | boolean | N | GOVERNANCE 모드 보존 우회 여부 | 별도 우회 권한 필요 |
| --content-md5 <value> | string | N | 요청 바디의 Base64 인코딩된 MD5 해시값 | 미 입력 시 자동 계산 |
| --checksum-algorithm <value> | string | N | 요청 바디 검증에 사용할 체크섬 알고리즘 | 선택한 가능한 옵션
|
| --cli-input-json | --cli-input-yaml | string | N | 제공한 json 또는 yaml 문자열에서 인수 입력 | json과 yaml을 함께 지정 불가 |
| --generate-cli-skeleton <value> | integer | N | API 명령을 실행하지 않고 이후에 input으로 사용할 수 있는 파라미터 템플릿 생성 | - |
| --debug | boolean | N | 디버그 로깅 사용 | - |
| --no-verify-ssl | boolean | N | SSL 인증서를 검증하는 기본 동작 재정의 | - |
| --no-paginate | boolean | N | 자동 pagination 비활성화, 결과에 대해 첫 번째 페이지 한 번만 호출됨 | - |
| --output <value> | string | N | 응답값의 포맷 지정 | 선택한 가능한 옵션
|
| --query <value> | string | N | 응답 데이터를 필터링하는 데 사용할 JMESPath 쿼리 | - |
| --profile <value> | string | N | 자격 증명 파일에서 특정 profile 사용 | - |
| --region <value> | string | N | 리전 지정 | kr만 지원 |
| --color <value> | string | N | output color 설정 | 선택한 가능한 옵션
|
| --no-sign-request | boolean | N | 자격 증명 로드 비활성화 | - |
| --ca-bundle <value> | string | N | SSL 인증서를 확인할 때 사용할 CA 인증서 지정 | - |
| --cli-read-timeout <value> | int | N | 최대 읽기 시간, 0으로 입력시 타임아웃이 아닌 차단 상태로 변경됨 | default는 60초로 설정 |
| --cli-connect-timeout <value> | int | N | 최대 연결 시간, 0으로 입력시 타임아웃이 아닌 차단 상태로 변경됨 | default는 60초로 설정 |
| --no-cli-pager | boolean | N | 응답값의 cli pager 비활성화 | - |
| --cli-auto-prompt | boolean | N | CLI 입력 파라미터 자동 프롬프트 설정 | - |
| --no-cli-auto-prompt | boolean | N | CLI 입력 파라미터 자동 프롬프트 비활성화 | - |
권한
Subaccount 사용자가 이 명령어를 사용하려면 Change/PutObjectRetention 액션 권한이 필요합니다.
예시
put-object-retention 명령어의 호출 예시를 설명합니다.
보존 설정 적용
호출 예시
put-object-retention 명령어를 호출하면 객체에 보존 모드와 만료일을 설정할 수 있습니다. 호출 예시는 다음과 같습니다.
aws s3api put-object-retention --bucket bucket-a --key object.csv --retention '{"Mode":"GOVERNANCE","RetainUntilDate":"2025-12-31T00:00:00"}' --endpoint-url=https://kr.ncloudstorage.com
연관 명령어
연관 명령어는 다음과 같습니다.