BucketObjectLockConfigurationV2 class
Provides an S3 bucket Object Lock configuration resource. For more information about Object Locking, go to Using S3 Object Lock in the Amazon S3 User Guide.
> This resource can be used enable Object Lock for new and existing buckets.
> This resource cannot be used with S3 directory buckets.
Example Usage
Object Lock configuration for new or existing buckets
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.s3.Bucket("example", {bucket: "mybucket"});
const exampleBucketVersioning = new aws.s3.BucketVersioning("example", {
versioningConfiguration: {
status: "Enabled",
},
bucket: example.id,
});
const exampleBucketObjectLockConfiguration = new aws.s3.BucketObjectLockConfiguration("example", {
rule: {
defaultRetention: {
mode: "COMPLIANCE",
days: 5,
},
},
bucket: example.id,
});
import pulumi
import pulumi_aws as aws
example = aws.s3.Bucket("example", bucket="mybucket")
example_bucket_versioning = aws.s3.BucketVersioning("example",
versioning_configuration={
"status": "Enabled",
},
bucket=example.id)
example_bucket_object_lock_configuration = aws.s3.BucketObjectLockConfiguration("example",
rule={
"default_retention": {
"mode": "COMPLIANCE",
"days": 5,
},
},
bucket=example.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.S3.Bucket("example", new()
{
BucketName = "mybucket",
});
var exampleBucketVersioning = new Aws.S3.BucketVersioning("example", new()
{
VersioningConfiguration = new Aws.S3.Inputs.BucketVersioningVersioningConfigurationArgs
{
Status = "Enabled",
},
Bucket = example.Id,
});
var exampleBucketObjectLockConfiguration = new Aws.S3.BucketObjectLockConfiguration("example", new()
{
Rule = new Aws.S3.Inputs.BucketObjectLockConfigurationRuleArgs
{
DefaultRetention = new Aws.S3.Inputs.BucketObjectLockConfigurationRuleDefaultRetentionArgs
{
Mode = "COMPLIANCE",
Days = 5,
},
},
Bucket = example.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := s3.NewBucket(ctx, "example", &s3.BucketArgs{
Bucket: pulumi.String("mybucket"),
})
if err != nil {
return err
}
_, err = s3.NewBucketVersioning(ctx, "example", &s3.BucketVersioningArgs{
VersioningConfiguration: &s3.BucketVersioningVersioningConfigurationArgs{
Status: pulumi.String("Enabled"),
},
Bucket: example.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
_, err = s3.NewBucketObjectLockConfiguration(ctx, "example", &s3.BucketObjectLockConfigurationArgs{
Rule: &s3.BucketObjectLockConfigurationRuleArgs{
DefaultRetention: &s3.BucketObjectLockConfigurationRuleDefaultRetentionArgs{
Mode: pulumi.String("COMPLIANCE"),
Days: pulumi.Int(5),
},
},
Bucket: example.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3_bucket" "example" {
bucket = "mybucket"
}
resource "aws_s3_bucketversioning" "example" {
versioning_configuration = {
status = "Enabled"
}
bucket = aws_s3_bucket.example.id
}
resource "aws_s3_bucketobjectlockconfiguration" "example" {
rule = {
default_retention = {
mode = "COMPLIANCE"
days = 5
}
}
bucket = aws_s3_bucket.example.id
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.Bucket;
import com.pulumi.aws.s3.BucketArgs;
import com.pulumi.aws.s3.BucketVersioning;
import com.pulumi.aws.s3.BucketVersioningArgs;
import com.pulumi.aws.s3.inputs.BucketVersioningVersioningConfigurationArgs;
import com.pulumi.aws.s3.BucketObjectLockConfiguration;
import com.pulumi.aws.s3.BucketObjectLockConfigurationArgs;
import com.pulumi.aws.s3.inputs.BucketObjectLockConfigurationRuleArgs;
import com.pulumi.aws.s3.inputs.BucketObjectLockConfigurationRuleDefaultRetentionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Bucket("example", BucketArgs.builder()
.bucket("mybucket")
.build());
var exampleBucketVersioning = new BucketVersioning("exampleBucketVersioning", BucketVersioningArgs.builder()
.versioningConfiguration(BucketVersioningVersioningConfigurationArgs.builder()
.status("Enabled")
.build())
.bucket(example.id())
.build());
var exampleBucketObjectLockConfiguration = new BucketObjectLockConfiguration("exampleBucketObjectLockConfiguration", BucketObjectLockConfigurationArgs.builder()
.rule(BucketObjectLockConfigurationRuleArgs.builder()
.defaultRetention(BucketObjectLockConfigurationRuleDefaultRetentionArgs.builder()
.mode("COMPLIANCE")
.days(5)
.build())
.build())
.bucket(example.id())
.build());
}
}
resources:
example:
type: aws:s3:Bucket
properties:
bucket: mybucket
exampleBucketVersioning:
type: aws:s3:BucketVersioning
name: example
properties:
versioningConfiguration:
status: Enabled
bucket: ${example.id}
exampleBucketObjectLockConfiguration:
type: aws:s3:BucketObjectLockConfiguration
name: example
properties:
rule:
defaultRetention:
mode: COMPLIANCE
days: 5
bucket: ${example.id}
Import
If the owner (account ID) of the source bucket differs from the account used to configure the AWS Provider, import using the bucket and expectedBucketOwner, separated by a comma (,). For example:
Using pulumi import, import an S3 bucket Object Lock Configuration using one of two forms. If the owner (account ID) of the source bucket is the same account used to configure the AWS Provider, import using the bucket. For example:
$ pulumi import aws:s3/bucketObjectLockConfigurationV2:BucketObjectLockConfigurationV2 example bucket-name
If the owner (account ID) of the source bucket differs from the account used to configure the AWS Provider, import using the bucket and expectedBucketOwner, separated by a comma (,). For example:
$ pulumi import aws:s3/bucketObjectLockConfigurationV2:BucketObjectLockConfigurationV2 example bucket-name,123456789012
Constructors
- BucketObjectLockConfigurationV2(String name, {BucketObjectLockConfigurationV2Args? args, CustomResourceOptions? options})
-
Creates a new BucketObjectLockConfigurationV2.
nameThe Pulumi resource name.argsArguments used to configure this BucketObjectLockConfigurationV2. The set of arguments for BucketObjectLockConfigurationV2.optionsResource options controlling this resource's behavior. - BucketObjectLockConfigurationV2.reference(String urn)
- Creates a typed reference to an existing BucketObjectLockConfigurationV2 resource.
Properties
-
bucket
↔ Output<
String> -
Name of the bucket.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
expectedBucketOwner
↔ Output<
String?> -
Account ID of the expected bucket owner.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
objectLockEnabled
↔ Output<
String?> -
Whether this bucket has an Object Lock configuration enabled. Defaults to
Enabled. Valid values:Enabled.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
rule
↔ Output<
BucketObjectLockConfigurationV2Rule?> -
Configuration block for specifying the Object Lock rule for the specified object. See below.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
token
↔ Output<
String?> -
Token to allow Object Lock to be enabled for an existing bucket. To enable Object Lock for an existing bucket, you must first enable versioning on the bucket and then enable Object Lock. For more details on versioning, see the
aws.s3.BucketVersioningresource.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {BucketObjectLockConfigurationV2State? state, CustomResourceOptions? options}) → BucketObjectLockConfigurationV2 -
Gets an existing BucketObjectLockConfigurationV2 resource's state with the given
nameandid.