Container for the parameters to the PutLifecycleConfiguration operation.
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle
configuration. Keep in mind that this will overwrite an existing lifecycle configuration,
so if you want to retain any configuration details, they must be included in the new
lifecycle configuration. For information about lifecycle configuration, see Managing
your storage lifecycle.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object
key name prefix, one or more object tags, object size, or any combination of these.
Accordingly, this section describes the latest API. The previous version of the API
supported filtering based only on an object key name prefix, which is supported for
backward compatibility. For the related API description, see PutBucketLifecycle.
- Rules
- Permissions
- HTTP Host header syntax
You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable.
Bucket lifecycle configuration supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility for general purpose buckets. For the related API description, see PutBucketLifecycle.
Lifecyle configurations for directory buckets only support expiring objects and cancelling multipart uploads. Expiring of versioned objects,transitions and tag filters are not supported.
A lifecycle rule consists of the following:
A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, object size, or any combination of these.
A status indicating whether the rule is in effect.
One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.
For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.
General purpose bucket permissions - By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must have the
s3:PutLifecycleConfigurationpermission.You can also explicitly deny permissions. An explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObjects3:DeleteObjectVersions3:PutLifecycleConfigurationFor more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.
Directory bucket permissions - You must have the
s3express:PutLifecycleConfigurationpermission in an IAM identity-based policy to use this operation. Cross-account access to this API operation isn't supported. The resource owner can optionally grant access permissions to others by creating a role or user for them as long as they are within the same account as the owner and resource.For more information about directory bucket policies and permissions, see Authorizing Regional endpoint APIs with IAM in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format
https://s3express-control.region-code.amazonaws.com/bucket-name. Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is
s3express-control.region.amazonaws.com.The following operations are related to
PutBucketLifecycleConfiguration:
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.S3.Model.PutLifecycleConfigurationRequest
Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z
Syntax
public class PutLifecycleConfigurationRequest : AmazonWebServiceRequest IAmazonWebServiceRequest
The PutLifecycleConfigurationRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
PutLifecycleConfigurationRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
BucketName | System.String |
Gets and sets the property BucketName. The name of the bucket for which to set the configuration. |
|
|
ChecksumAlgorithm | Amazon.S3.ChecksumAlgorithm |
Gets and sets the property ChecksumAlgorithm.
Indicates the algorithm used to create the checksum for the request when you use the
SDK. This header will not provide any additional functionality if you don't use the
SDK. When you send this header, there must be a corresponding
If you provide an individual checksum, Amazon S3 ignores any provided |
|
|
Configuration | Amazon.S3.Model.LifecycleConfiguration |
Gets and sets the property Configuration. Container for lifecycle rules. You can add as many as 1,000 rules. |
|
|
ExpectedBucketOwner | System.String |
Gets and sets the property ExpectedBucketOwner.
The account ID of the expected bucket owner. If the account ID that you provide does
not match the actual owner of the bucket, the request fails with the HTTP status code
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations. |
|
|
TransitionDefaultMinimumObjectSize | Amazon.S3.TransitionDefaultMinimumObjectSize |
Gets and sets the property TransitionDefaultMinimumObjectSize. Indicates which default minimum object size behavior is applied to the lifecycle configuration. This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
To customize the minimum object size for any transition you can add a filter that
specifies a custom |
Examples
This example shows how to Get, Put and Delete bucket Lifecycle Configurations.
A Lifecycle Configuration allows an owner to configure when specific objects
should be deleted. Objects to be deleted are specified with a prefix.
The configuration being used has rules that delete objects with a specific
prefix and objects in a specific subdirectory.
LifecycleConfiguration samples
// Create a client
AmazonS3Client client = new AmazonS3Client();
// Put sample lifecycle configuration (overwrite an existing configuration)
LifecycleConfiguration newConfiguration = new LifecycleConfiguration
{
Rules = new List<LifecycleRule>
{
// Rule to delete keys with prefix "Test-" after 5 days
new LifecycleRule
{
Filter = new LifecycleFilter
{
LifecycleFilterPredicate = new LifecyclePrefixPredicate
{
Prefix = "Test-"
}
},
Expiration = new LifecycleRuleExpiration { Days = 5 }
},
// Rule to delete keys in subdirectory "Logs" after 2 days
new LifecycleRule
{
Filter = new LifecycleFilter
{
LifecycleFilterPredicate = new LifecyclePrefixPredicate
{
Prefix = "Logs/",
}
},
Expiration = new LifecycleRuleExpiration { Days = 2 },
Id = "log-file-removal"
}
}
};
PutLifecycleConfigurationRequest putRequest = new PutLifecycleConfigurationRequest
{
BucketName = "amzn-s3-demo-bucket",
Configuration = newConfiguration
};
await client.PutLifecycleConfigurationAsync(putRequest);
// Retrieve current configuration
GetLifecycleConfigurationRequest getRequest = new GetLifecycleConfigurationRequest
{
BucketName = "amzn-s3-demo-bucket"
};
LifecycleConfiguration configuration = (await client.GetLifecycleConfigurationAsync(getRequest)).Configuration;
Console.WriteLine("Configuration contains {0} rules", configuration.Rules?.Count);
if(configuration.Rules != null)
{
foreach (LifecycleRule rule in configuration.Rules)
{
Console.WriteLine("Rule");
if (rule.Filter.LifecycleFilterPredicate is LifecyclePrefixPredicate prefixFilter)
Console.WriteLine(" Prefix = " + prefixFilter.Prefix);
Console.WriteLine(" Expiration (days) = " + rule.Expiration.Days);
Console.WriteLine(" Id = " + rule.Id);
Console.WriteLine(" Status = " + rule.Status);
}
}
// Put a new configuration and overwrite the existing configuration
configuration.Rules.RemoveAt(0); // remove first rule
await client.PutLifecycleConfigurationAsync(putRequest);
// Delete current configuration
DeleteLifecycleConfigurationRequest deleteRequest = new DeleteLifecycleConfigurationRequest
{
BucketName = "amzn-s3-demo-bucket"
};
await client.DeleteLifecycleConfigurationAsync(deleteRequest);
// Retrieve current configuration and verify that it is null
configuration = (await client.GetLifecycleConfigurationAsync(getRequest)).Configuration;
Debug.Assert(configuration == null);
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer