Class PutObjectRetentionRequest
Container for the parameters to the PutObjectRetention operation. Places an Object Retention configuration on an object.
public class PutObjectRetentionRequest : AmazonWebServiceRequest- Inheritance
-
PutObjectRetentionRequest
Constructors
PutObjectRetentionRequest()
public PutObjectRetentionRequest()Properties
BucketName
The bucket name that contains the object you want to apply this Object Retention configuration to.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
public string BucketName { get; set; }Property Value
BypassGovernanceRetention
Gets and sets the property BypassGovernanceRetention.
public bool BypassGovernanceRetention { get; set; }Property Value
ContentMD5
Gets and sets the property ContentMD5.
The MD5 signature for the configuration included in your request.
public string ContentMD5 { get; set; }Property Value
ExpectedBucketOwner
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
public string ExpectedBucketOwner { get; set; }Property Value
Key
Gets and sets the property Key.
The key name for the object that you want to apply this Object Retention configuration to.
public string Key { get; set; }Property Value
Remarks
This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." is interpreted as use parent directory. For further information view the documentation for the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri
RequestPayer
Gets and sets the property RequestPayer.
public RequestPayer RequestPayer { get; set; }Property Value
Retention
Gets and sets the property Retention.
The container element for the Object Retention configuration.
public ObjectLockRetention Retention { get; set; }Property Value
VersionId
Gets and sets the property VersionId.
The version ID for the object that you want to apply this Object Retention configuration to.
public string VersionId { get; set; }