Inventory class
Provides a S3 bucket inventory configuration resource.
Example Usage
Add inventory configuration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.s3.Bucket("test", {bucket: "my-tf-test-bucket"});
const inventory = new aws.s3.Bucket("inventory", {bucket: "my-tf-inventory-bucket"});
const testInventory = new aws.s3.Inventory("test", {
schedule: {
frequency: "Daily",
},
destination: {
bucket: {
format: "ORC",
bucketArn: inventory.arn,
},
},
bucket: test.id,
name: "EntireBucketDaily",
includedObjectVersions: "All",
});
import pulumi
import pulumi_aws as aws
test = aws.s3.Bucket("test", bucket="my-tf-test-bucket")
inventory = aws.s3.Bucket("inventory", bucket="my-tf-inventory-bucket")
test_inventory = aws.s3.Inventory("test",
schedule={
"frequency": "Daily",
},
destination={
"bucket": {
"format": "ORC",
"bucket_arn": inventory.arn,
},
},
bucket=test.id,
name="EntireBucketDaily",
included_object_versions="All")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.S3.Bucket("test", new()
{
BucketName = "my-tf-test-bucket",
});
var inventory = new Aws.S3.Bucket("inventory", new()
{
BucketName = "my-tf-inventory-bucket",
});
var testInventory = new Aws.S3.Inventory("test", new()
{
Schedule = new Aws.S3.Inputs.InventoryScheduleArgs
{
Frequency = "Daily",
},
Destination = new Aws.S3.Inputs.InventoryDestinationArgs
{
Bucket = new Aws.S3.Inputs.InventoryDestinationBucketArgs
{
Format = "ORC",
BucketArn = inventory.Arn,
},
},
Bucket = test.Id,
Name = "EntireBucketDaily",
IncludedObjectVersions = "All",
});
});
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 {
test, err := s3.NewBucket(ctx, "test", &s3.BucketArgs{
Bucket: pulumi.String("my-tf-test-bucket"),
})
if err != nil {
return err
}
inventory, err := s3.NewBucket(ctx, "inventory", &s3.BucketArgs{
Bucket: pulumi.String("my-tf-inventory-bucket"),
})
if err != nil {
return err
}
_, err = s3.NewInventory(ctx, "test", &s3.InventoryArgs{
Schedule: &s3.InventoryScheduleArgs{
Frequency: pulumi.String("Daily"),
},
Destination: &s3.InventoryDestinationArgs{
Bucket: &s3.InventoryDestinationBucketArgs{
Format: pulumi.String("ORC"),
BucketArn: inventory.Arn,
},
},
Bucket: test.ID().ToIDOutput().ToStringOutput(),
Name: pulumi.String("EntireBucketDaily"),
IncludedObjectVersions: pulumi.String("All"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3_bucket" "test" {
bucket = "my-tf-test-bucket"
}
resource "aws_s3_bucket" "inventory" {
bucket = "my-tf-inventory-bucket"
}
resource "aws_s3_inventory" "test" {
schedule = {
frequency = "Daily"
}
destination = {
bucket = {
format = "ORC"
bucket_arn = aws_s3_bucket.inventory.arn
}
}
bucket = aws_s3_bucket.test.id
name = "EntireBucketDaily"
included_object_versions = "All"
}
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.Inventory;
import com.pulumi.aws.s3.InventoryArgs;
import com.pulumi.aws.s3.inputs.InventoryScheduleArgs;
import com.pulumi.aws.s3.inputs.InventoryDestinationArgs;
import com.pulumi.aws.s3.inputs.InventoryDestinationBucketArgs;
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 test = new Bucket("test", BucketArgs.builder()
.bucket("my-tf-test-bucket")
.build());
var inventory = new Bucket("inventory", BucketArgs.builder()
.bucket("my-tf-inventory-bucket")
.build());
var testInventory = new Inventory("testInventory", InventoryArgs.builder()
.schedule(InventoryScheduleArgs.builder()
.frequency("Daily")
.build())
.destination(InventoryDestinationArgs.builder()
.bucket(InventoryDestinationBucketArgs.builder()
.format("ORC")
.bucketArn(inventory.arn())
.build())
.build())
.bucket(test.id())
.name("EntireBucketDaily")
.includedObjectVersions("All")
.build());
}
}
resources:
test:
type: aws:s3:Bucket
properties:
bucket: my-tf-test-bucket
inventory:
type: aws:s3:Bucket
properties:
bucket: my-tf-inventory-bucket
testInventory:
type: aws:s3:Inventory
name: test
properties:
schedule:
frequency: Daily
destination:
bucket:
format: ORC
bucketArn: ${inventory.arn}
bucket: ${test.id}
name: EntireBucketDaily
includedObjectVersions: All
Add inventory configuration with S3 object prefix
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.s3.Bucket("test", {bucket: "my-tf-test-bucket"});
const inventory = new aws.s3.Bucket("inventory", {bucket: "my-tf-inventory-bucket"});
const test_prefix = new aws.s3.Inventory("test-prefix", {
schedule: {
frequency: "Daily",
},
filter: {
prefix: "documents/",
},
destination: {
bucket: {
format: "ORC",
bucketArn: inventory.arn,
prefix: "inventory",
},
},
bucket: test.id,
name: "DocumentsWeekly",
includedObjectVersions: "All",
});
import pulumi
import pulumi_aws as aws
test = aws.s3.Bucket("test", bucket="my-tf-test-bucket")
inventory = aws.s3.Bucket("inventory", bucket="my-tf-inventory-bucket")
test_prefix = aws.s3.Inventory("test-prefix",
schedule={
"frequency": "Daily",
},
filter={
"prefix": "documents/",
},
destination={
"bucket": {
"format": "ORC",
"bucket_arn": inventory.arn,
"prefix": "inventory",
},
},
bucket=test.id,
name="DocumentsWeekly",
included_object_versions="All")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.S3.Bucket("test", new()
{
BucketName = "my-tf-test-bucket",
});
var inventory = new Aws.S3.Bucket("inventory", new()
{
BucketName = "my-tf-inventory-bucket",
});
var test_prefix = new Aws.S3.Inventory("test-prefix", new()
{
Schedule = new Aws.S3.Inputs.InventoryScheduleArgs
{
Frequency = "Daily",
},
Filter = new Aws.S3.Inputs.InventoryFilterArgs
{
Prefix = "documents/",
},
Destination = new Aws.S3.Inputs.InventoryDestinationArgs
{
Bucket = new Aws.S3.Inputs.InventoryDestinationBucketArgs
{
Format = "ORC",
BucketArn = inventory.Arn,
Prefix = "inventory",
},
},
Bucket = test.Id,
Name = "DocumentsWeekly",
IncludedObjectVersions = "All",
});
});
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 {
test, err := s3.NewBucket(ctx, "test", &s3.BucketArgs{
Bucket: pulumi.String("my-tf-test-bucket"),
})
if err != nil {
return err
}
inventory, err := s3.NewBucket(ctx, "inventory", &s3.BucketArgs{
Bucket: pulumi.String("my-tf-inventory-bucket"),
})
if err != nil {
return err
}
_, err = s3.NewInventory(ctx, "test-prefix", &s3.InventoryArgs{
Schedule: &s3.InventoryScheduleArgs{
Frequency: pulumi.String("Daily"),
},
Filter: &s3.InventoryFilterArgs{
Prefix: pulumi.String("documents/"),
},
Destination: &s3.InventoryDestinationArgs{
Bucket: &s3.InventoryDestinationBucketArgs{
Format: pulumi.String("ORC"),
BucketArn: inventory.Arn,
Prefix: pulumi.String("inventory"),
},
},
Bucket: test.ID().ToIDOutput().ToStringOutput(),
Name: pulumi.String("DocumentsWeekly"),
IncludedObjectVersions: pulumi.String("All"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3_bucket" "test" {
bucket = "my-tf-test-bucket"
}
resource "aws_s3_bucket" "inventory" {
bucket = "my-tf-inventory-bucket"
}
resource "aws_s3_inventory" "test-prefix" {
schedule = {
frequency = "Daily"
}
filter = {
prefix = "documents/"
}
destination = {
bucket = {
format = "ORC"
bucket_arn = aws_s3_bucket.inventory.arn
prefix = "inventory"
}
}
bucket = aws_s3_bucket.test.id
name = "DocumentsWeekly"
included_object_versions = "All"
}
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.Inventory;
import com.pulumi.aws.s3.InventoryArgs;
import com.pulumi.aws.s3.inputs.InventoryScheduleArgs;
import com.pulumi.aws.s3.inputs.InventoryFilterArgs;
import com.pulumi.aws.s3.inputs.InventoryDestinationArgs;
import com.pulumi.aws.s3.inputs.InventoryDestinationBucketArgs;
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 test = new Bucket("test", BucketArgs.builder()
.bucket("my-tf-test-bucket")
.build());
var inventory = new Bucket("inventory", BucketArgs.builder()
.bucket("my-tf-inventory-bucket")
.build());
var test_prefix = new Inventory("test-prefix", InventoryArgs.builder()
.schedule(InventoryScheduleArgs.builder()
.frequency("Daily")
.build())
.filter(InventoryFilterArgs.builder()
.prefix("documents/")
.build())
.destination(InventoryDestinationArgs.builder()
.bucket(InventoryDestinationBucketArgs.builder()
.format("ORC")
.bucketArn(inventory.arn())
.prefix("inventory")
.build())
.build())
.bucket(test.id())
.name("DocumentsWeekly")
.includedObjectVersions("All")
.build());
}
}
resources:
test:
type: aws:s3:Bucket
properties:
bucket: my-tf-test-bucket
inventory:
type: aws:s3:Bucket
properties:
bucket: my-tf-inventory-bucket
test-prefix:
type: aws:s3:Inventory
properties:
schedule:
frequency: Daily
filter:
prefix: documents/
destination:
bucket:
format: ORC
bucketArn: ${inventory.arn}
prefix: inventory
bucket: ${test.id}
name: DocumentsWeekly
includedObjectVersions: All
Import
Using pulumi import, import S3 bucket inventory configurations using bucket:inventory. For example:
$ pulumi import aws:s3/inventory:Inventory my-bucket-entire-bucket my-bucket:EntireBucket
Constructors
- Inventory(String name, {InventoryArgs? args, CustomResourceOptions? options})
-
Creates a new Inventory.
nameThe Pulumi resource name.argsArguments used to configure this Inventory. The set of arguments for Inventory.optionsResource options controlling this resource's behavior. - Inventory.reference(String urn)
- Creates a typed reference to an existing Inventory resource.
Properties
-
bucket
↔ Output<
String> -
Name of the source bucket that inventory lists the objects for. Both general purpose and directory buckets are supported.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
destination
↔ Output<
InventoryDestination> -
Where to publish the inventory results. See
destinationBlock below.latefinal -
enabled
↔ Output<
bool?> -
Whether to enable the inventory.
latefinal
-
filter
↔ Output<
InventoryFilter?> -
Inventory filter. The inventory only includes objects that meet the filter's criteria. See
filterBlock below.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
includedObjectVersions
↔ Output<
String> -
Object versions to include in the inventory list. Valid values:
All,Current.latefinal - 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
-
name
↔ Output<
String> -
Unique identifier of the inventory configuration for the bucket.
latefinal
-
optionalFields
↔ Output<
List< String> ?> -
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more 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
-
schedule
↔ Output<
InventorySchedule> -
Schedule for generating inventory results. See
scheduleBlock below.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