BucketMetadataConfiguration class

Manages Amazon S3 Metadata for a bucket.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3.BucketMetadataConfiguration("example", {
    metadataConfiguration: {
        inventoryTableConfiguration: {
            configurationState: "ENABLED",
        },
        journalTableConfiguration: {
            recordExpiration: {
                days: 7,
                expiration: "ENABLED",
            },
        },
    },
    bucket: exampleAwsS3Bucket.bucket,
});
import pulumi
import pulumi_aws as aws

example = aws.s3.BucketMetadataConfiguration("example",
    metadata_configuration={
        "inventory_table_configuration": {
            "configuration_state": "ENABLED",
        },
        "journal_table_configuration": {
            "record_expiration": {
                "days": 7,
                "expiration": "ENABLED",
            },
        },
    },
    bucket=example_aws_s3_bucket["bucket"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.S3.BucketMetadataConfiguration("example", new()
    {
        MetadataConfiguration = new Aws.S3.Inputs.BucketMetadataConfigurationMetadataConfigurationArgs
        {
            InventoryTableConfiguration = new Aws.S3.Inputs.BucketMetadataConfigurationMetadataConfigurationInventoryTableConfigurationArgs
            {
                ConfigurationState = "ENABLED",
            },
            JournalTableConfiguration = new Aws.S3.Inputs.BucketMetadataConfigurationMetadataConfigurationJournalTableConfigurationArgs
            {
                RecordExpiration = new Aws.S3.Inputs.BucketMetadataConfigurationMetadataConfigurationJournalTableConfigurationRecordExpirationArgs
                {
                    Days = 7,
                    Expiration = "ENABLED",
                },
            },
        },
        Bucket = exampleAwsS3Bucket.Bucket,
    });

});
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 {
		_, err := s3.NewBucketMetadataConfiguration(ctx, "example", &s3.BucketMetadataConfigurationArgs{
			MetadataConfiguration: &s3.BucketMetadataConfigurationMetadataConfigurationArgs{
				InventoryTableConfiguration: &s3.BucketMetadataConfigurationMetadataConfigurationInventoryTableConfigurationArgs{
					ConfigurationState: pulumi.String("ENABLED"),
				},
				JournalTableConfiguration: &s3.BucketMetadataConfigurationMetadataConfigurationJournalTableConfigurationArgs{
					RecordExpiration: &s3.BucketMetadataConfigurationMetadataConfigurationJournalTableConfigurationRecordExpirationArgs{
						Days:       pulumi.Int(7),
						Expiration: pulumi.String("ENABLED"),
					},
				},
			},
			Bucket: pulumi.Any(exampleAwsS3Bucket.Bucket),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3_bucketmetadataconfiguration" "example" {
  metadata_configuration = {
    inventory_table_configuration = {
      configuration_state = "ENABLED"
    }
    journal_table_configuration = {
      record_expiration = {
        days       = 7
        expiration = "ENABLED"
      }
    }
  }
  bucket = exampleAwsS3Bucket.bucket
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.BucketMetadataConfiguration;
import com.pulumi.aws.s3.BucketMetadataConfigurationArgs;
import com.pulumi.aws.s3.inputs.BucketMetadataConfigurationMetadataConfigurationArgs;
import com.pulumi.aws.s3.inputs.BucketMetadataConfigurationMetadataConfigurationInventoryTableConfigurationArgs;
import com.pulumi.aws.s3.inputs.BucketMetadataConfigurationMetadataConfigurationJournalTableConfigurationArgs;
import com.pulumi.aws.s3.inputs.BucketMetadataConfigurationMetadataConfigurationJournalTableConfigurationRecordExpirationArgs;
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 BucketMetadataConfiguration("example", BucketMetadataConfigurationArgs.builder()
            .metadataConfiguration(BucketMetadataConfigurationMetadataConfigurationArgs.builder()
                .inventoryTableConfiguration(BucketMetadataConfigurationMetadataConfigurationInventoryTableConfigurationArgs.builder()
                    .configurationState("ENABLED")
                    .build())
                .journalTableConfiguration(BucketMetadataConfigurationMetadataConfigurationJournalTableConfigurationArgs.builder()
                    .recordExpiration(BucketMetadataConfigurationMetadataConfigurationJournalTableConfigurationRecordExpirationArgs.builder()
                        .days(7)
                        .expiration("ENABLED")
                        .build())
                    .build())
                .build())
            .bucket(exampleAwsS3Bucket.bucket())
            .build());

    }
}
resources:
  example:
    type: aws:s3:BucketMetadataConfiguration
    properties:
      metadataConfiguration:
        inventoryTableConfiguration:
          configurationState: ENABLED
        journalTableConfiguration:
          recordExpiration:
            days: 7
            expiration: ENABLED
      bucket: ${exampleAwsS3Bucket.bucket}

Import

Identity Schema

Required

  • bucket (String) S3 bucket name.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import to import S3 bucket metadata configuration using the bucket. For example:

$ pulumi import aws:s3/bucketMetadataConfiguration:BucketMetadataConfiguration example bucket-name

Constructors

BucketMetadataConfiguration(String name, {BucketMetadataConfigurationArgs? args, CustomResourceOptions? options})
Creates a new BucketMetadataConfiguration. name The Pulumi resource name. args Arguments used to configure this BucketMetadataConfiguration. The set of arguments for BucketMetadataConfiguration. options Resource options controlling this resource's behavior.
BucketMetadataConfiguration.reference(String urn)
Creates a typed reference to an existing BucketMetadataConfiguration resource.

Properties

bucket ↔ Output<String>
General purpose bucket that you want to create the metadata configuration for.
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
metadataConfiguration ↔ Output<BucketMetadataConfigurationMetadataConfiguration>
Metadata configuration. See metadataConfiguration Block for details.
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
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
timeouts ↔ Output<BucketMetadataConfigurationTimeouts?>
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, {BucketMetadataConfigurationState? state, CustomResourceOptions? options}) → BucketMetadataConfiguration
Gets an existing BucketMetadataConfiguration resource's state with the given name and id.