Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. s3
  5. Inventory
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

aws.s3.Inventory

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

Provides a S3 bucket inventory configuration resource.

This resource cannot be used with S3 directory buckets.

Example Usage

Add inventory configuration

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

const test = new aws.s3.BucketV2("test", {bucket: "my-tf-test-bucket"});
const inventory = new aws.s3.BucketV2("inventory", {bucket: "my-tf-inventory-bucket"});
const testInventory = new aws.s3.Inventory("test", {
    bucket: test.id,
    name: "EntireBucketDaily",
    includedObjectVersions: "All",
    schedule: {
        frequency: "Daily",
    },
    destination: {
        bucket: {
            format: "ORC",
            bucketArn: inventory.arn,
        },
    },
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.s3.BucketV2("test", bucket="my-tf-test-bucket")
inventory = aws.s3.BucketV2("inventory", bucket="my-tf-inventory-bucket")
test_inventory = aws.s3.Inventory("test",
    bucket=test.id,
    name="EntireBucketDaily",
    included_object_versions="All",
    schedule={
        "frequency": "Daily",
    },
    destination={
        "bucket": {
            "format": "ORC",
            "bucket_arn": inventory.arn,
        },
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := s3.NewBucketV2(ctx, "test", &s3.BucketV2Args{
			Bucket: pulumi.String("my-tf-test-bucket"),
		})
		if err != nil {
			return err
		}
		inventory, err := s3.NewBucketV2(ctx, "inventory", &s3.BucketV2Args{
			Bucket: pulumi.String("my-tf-inventory-bucket"),
		})
		if err != nil {
			return err
		}
		_, err = s3.NewInventory(ctx, "test", &s3.InventoryArgs{
			Bucket:                 test.ID(),
			Name:                   pulumi.String("EntireBucketDaily"),
			IncludedObjectVersions: pulumi.String("All"),
			Schedule: &s3.InventoryScheduleArgs{
				Frequency: pulumi.String("Daily"),
			},
			Destination: &s3.InventoryDestinationArgs{
				Bucket: &s3.InventoryDestinationBucketArgs{
					Format:    pulumi.String("ORC"),
					BucketArn: inventory.Arn,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.S3.BucketV2("test", new()
    {
        Bucket = "my-tf-test-bucket",
    });

    var inventory = new Aws.S3.BucketV2("inventory", new()
    {
        Bucket = "my-tf-inventory-bucket",
    });

    var testInventory = new Aws.S3.Inventory("test", new()
    {
        Bucket = test.Id,
        Name = "EntireBucketDaily",
        IncludedObjectVersions = "All",
        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,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.BucketV2;
import com.pulumi.aws.s3.BucketV2Args;
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.List;
import java.util.ArrayList;
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 BucketV2("test", BucketV2Args.builder()
            .bucket("my-tf-test-bucket")
            .build());

        var inventory = new BucketV2("inventory", BucketV2Args.builder()
            .bucket("my-tf-inventory-bucket")
            .build());

        var testInventory = new Inventory("testInventory", InventoryArgs.builder()
            .bucket(test.id())
            .name("EntireBucketDaily")
            .includedObjectVersions("All")
            .schedule(InventoryScheduleArgs.builder()
                .frequency("Daily")
                .build())
            .destination(InventoryDestinationArgs.builder()
                .bucket(InventoryDestinationBucketArgs.builder()
                    .format("ORC")
                    .bucketArn(inventory.arn())
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  test:
    type: aws:s3:BucketV2
    properties:
      bucket: my-tf-test-bucket
  inventory:
    type: aws:s3:BucketV2
    properties:
      bucket: my-tf-inventory-bucket
  testInventory:
    type: aws:s3:Inventory
    name: test
    properties:
      bucket: ${test.id}
      name: EntireBucketDaily
      includedObjectVersions: All
      schedule:
        frequency: Daily
      destination:
        bucket:
          format: ORC
          bucketArn: ${inventory.arn}
Copy

Add inventory configuration with S3 object prefix

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

const test = new aws.s3.BucketV2("test", {bucket: "my-tf-test-bucket"});
const inventory = new aws.s3.BucketV2("inventory", {bucket: "my-tf-inventory-bucket"});
const test_prefix = new aws.s3.Inventory("test-prefix", {
    bucket: test.id,
    name: "DocumentsWeekly",
    includedObjectVersions: "All",
    schedule: {
        frequency: "Daily",
    },
    filter: {
        prefix: "documents/",
    },
    destination: {
        bucket: {
            format: "ORC",
            bucketArn: inventory.arn,
            prefix: "inventory",
        },
    },
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.s3.BucketV2("test", bucket="my-tf-test-bucket")
inventory = aws.s3.BucketV2("inventory", bucket="my-tf-inventory-bucket")
test_prefix = aws.s3.Inventory("test-prefix",
    bucket=test.id,
    name="DocumentsWeekly",
    included_object_versions="All",
    schedule={
        "frequency": "Daily",
    },
    filter={
        "prefix": "documents/",
    },
    destination={
        "bucket": {
            "format": "ORC",
            "bucket_arn": inventory.arn,
            "prefix": "inventory",
        },
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := s3.NewBucketV2(ctx, "test", &s3.BucketV2Args{
			Bucket: pulumi.String("my-tf-test-bucket"),
		})
		if err != nil {
			return err
		}
		inventory, err := s3.NewBucketV2(ctx, "inventory", &s3.BucketV2Args{
			Bucket: pulumi.String("my-tf-inventory-bucket"),
		})
		if err != nil {
			return err
		}
		_, err = s3.NewInventory(ctx, "test-prefix", &s3.InventoryArgs{
			Bucket:                 test.ID(),
			Name:                   pulumi.String("DocumentsWeekly"),
			IncludedObjectVersions: pulumi.String("All"),
			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"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.S3.BucketV2("test", new()
    {
        Bucket = "my-tf-test-bucket",
    });

    var inventory = new Aws.S3.BucketV2("inventory", new()
    {
        Bucket = "my-tf-inventory-bucket",
    });

    var test_prefix = new Aws.S3.Inventory("test-prefix", new()
    {
        Bucket = test.Id,
        Name = "DocumentsWeekly",
        IncludedObjectVersions = "All",
        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",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.BucketV2;
import com.pulumi.aws.s3.BucketV2Args;
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.List;
import java.util.ArrayList;
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 BucketV2("test", BucketV2Args.builder()
            .bucket("my-tf-test-bucket")
            .build());

        var inventory = new BucketV2("inventory", BucketV2Args.builder()
            .bucket("my-tf-inventory-bucket")
            .build());

        var test_prefix = new Inventory("test-prefix", InventoryArgs.builder()
            .bucket(test.id())
            .name("DocumentsWeekly")
            .includedObjectVersions("All")
            .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())
            .build());

    }
}
Copy
resources:
  test:
    type: aws:s3:BucketV2
    properties:
      bucket: my-tf-test-bucket
  inventory:
    type: aws:s3:BucketV2
    properties:
      bucket: my-tf-inventory-bucket
  test-prefix:
    type: aws:s3:Inventory
    properties:
      bucket: ${test.id}
      name: DocumentsWeekly
      includedObjectVersions: All
      schedule:
        frequency: Daily
      filter:
        prefix: documents/
      destination:
        bucket:
          format: ORC
          bucketArn: ${inventory.arn}
          prefix: inventory
Copy

Create Inventory Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Inventory(name: string, args: InventoryArgs, opts?: CustomResourceOptions);
@overload
def Inventory(resource_name: str,
              args: InventoryArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Inventory(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              bucket: Optional[str] = None,
              destination: Optional[InventoryDestinationArgs] = None,
              included_object_versions: Optional[str] = None,
              schedule: Optional[InventoryScheduleArgs] = None,
              enabled: Optional[bool] = None,
              filter: Optional[InventoryFilterArgs] = None,
              name: Optional[str] = None,
              optional_fields: Optional[Sequence[str]] = None)
func NewInventory(ctx *Context, name string, args InventoryArgs, opts ...ResourceOption) (*Inventory, error)
public Inventory(string name, InventoryArgs args, CustomResourceOptions? opts = null)
public Inventory(String name, InventoryArgs args)
public Inventory(String name, InventoryArgs args, CustomResourceOptions options)

type: aws:s3:Inventory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. InventoryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. InventoryArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. InventoryArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. InventoryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. InventoryArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var inventoryResource = new Aws.S3.Inventory("inventoryResource", new()
{
    Bucket = "string",
    Destination = new Aws.S3.Inputs.InventoryDestinationArgs
    {
        Bucket = new Aws.S3.Inputs.InventoryDestinationBucketArgs
        {
            BucketArn = "string",
            Format = "string",
            AccountId = "string",
            Encryption = new Aws.S3.Inputs.InventoryDestinationBucketEncryptionArgs
            {
                SseKms = new Aws.S3.Inputs.InventoryDestinationBucketEncryptionSseKmsArgs
                {
                    KeyId = "string",
                },
                SseS3 = null,
            },
            Prefix = "string",
        },
    },
    IncludedObjectVersions = "string",
    Schedule = new Aws.S3.Inputs.InventoryScheduleArgs
    {
        Frequency = "string",
    },
    Enabled = false,
    Filter = new Aws.S3.Inputs.InventoryFilterArgs
    {
        Prefix = "string",
    },
    Name = "string",
    OptionalFields = new[]
    {
        "string",
    },
});
Copy
example, err := s3.NewInventory(ctx, "inventoryResource", &s3.InventoryArgs{
	Bucket: pulumi.String("string"),
	Destination: &s3.InventoryDestinationArgs{
		Bucket: &s3.InventoryDestinationBucketArgs{
			BucketArn: pulumi.String("string"),
			Format:    pulumi.String("string"),
			AccountId: pulumi.String("string"),
			Encryption: &s3.InventoryDestinationBucketEncryptionArgs{
				SseKms: &s3.InventoryDestinationBucketEncryptionSseKmsArgs{
					KeyId: pulumi.String("string"),
				},
				SseS3: &s3.InventoryDestinationBucketEncryptionSseS3Args{},
			},
			Prefix: pulumi.String("string"),
		},
	},
	IncludedObjectVersions: pulumi.String("string"),
	Schedule: &s3.InventoryScheduleArgs{
		Frequency: pulumi.String("string"),
	},
	Enabled: pulumi.Bool(false),
	Filter: &s3.InventoryFilterArgs{
		Prefix: pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	OptionalFields: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var inventoryResource = new Inventory("inventoryResource", InventoryArgs.builder()
    .bucket("string")
    .destination(InventoryDestinationArgs.builder()
        .bucket(InventoryDestinationBucketArgs.builder()
            .bucketArn("string")
            .format("string")
            .accountId("string")
            .encryption(InventoryDestinationBucketEncryptionArgs.builder()
                .sseKms(InventoryDestinationBucketEncryptionSseKmsArgs.builder()
                    .keyId("string")
                    .build())
                .sseS3()
                .build())
            .prefix("string")
            .build())
        .build())
    .includedObjectVersions("string")
    .schedule(InventoryScheduleArgs.builder()
        .frequency("string")
        .build())
    .enabled(false)
    .filter(InventoryFilterArgs.builder()
        .prefix("string")
        .build())
    .name("string")
    .optionalFields("string")
    .build());
Copy
inventory_resource = aws.s3.Inventory("inventoryResource",
    bucket="string",
    destination={
        "bucket": {
            "bucket_arn": "string",
            "format": "string",
            "account_id": "string",
            "encryption": {
                "sse_kms": {
                    "key_id": "string",
                },
                "sse_s3": {},
            },
            "prefix": "string",
        },
    },
    included_object_versions="string",
    schedule={
        "frequency": "string",
    },
    enabled=False,
    filter={
        "prefix": "string",
    },
    name="string",
    optional_fields=["string"])
Copy
const inventoryResource = new aws.s3.Inventory("inventoryResource", {
    bucket: "string",
    destination: {
        bucket: {
            bucketArn: "string",
            format: "string",
            accountId: "string",
            encryption: {
                sseKms: {
                    keyId: "string",
                },
                sseS3: {},
            },
            prefix: "string",
        },
    },
    includedObjectVersions: "string",
    schedule: {
        frequency: "string",
    },
    enabled: false,
    filter: {
        prefix: "string",
    },
    name: "string",
    optionalFields: ["string"],
});
Copy
type: aws:s3:Inventory
properties:
    bucket: string
    destination:
        bucket:
            accountId: string
            bucketArn: string
            encryption:
                sseKms:
                    keyId: string
                sseS3: {}
            format: string
            prefix: string
    enabled: false
    filter:
        prefix: string
    includedObjectVersions: string
    name: string
    optionalFields:
        - string
    schedule:
        frequency: string
Copy

Inventory Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Inventory resource accepts the following input properties:

Bucket
This property is required.
Changes to this property will trigger replacement.
string
Name of the source bucket that inventory lists the objects for.
Destination This property is required. InventoryDestination
Contains information about where to publish the inventory results (documented below).
IncludedObjectVersions This property is required. string
Object versions to include in the inventory list. Valid values: All, Current.
Schedule This property is required. InventorySchedule
Specifies the schedule for generating inventory results (documented below).
Enabled bool
Specifies whether the inventory is enabled or disabled.
Filter InventoryFilter
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria (documented below).
Name Changes to this property will trigger replacement. string
Unique identifier of the inventory configuration for the bucket.
OptionalFields List<string>
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more details.
Bucket
This property is required.
Changes to this property will trigger replacement.
string
Name of the source bucket that inventory lists the objects for.
Destination This property is required. InventoryDestinationArgs
Contains information about where to publish the inventory results (documented below).
IncludedObjectVersions This property is required. string
Object versions to include in the inventory list. Valid values: All, Current.
Schedule This property is required. InventoryScheduleArgs
Specifies the schedule for generating inventory results (documented below).
Enabled bool
Specifies whether the inventory is enabled or disabled.
Filter InventoryFilterArgs
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria (documented below).
Name Changes to this property will trigger replacement. string
Unique identifier of the inventory configuration for the bucket.
OptionalFields []string
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more details.
bucket
This property is required.
Changes to this property will trigger replacement.
String
Name of the source bucket that inventory lists the objects for.
destination This property is required. InventoryDestination
Contains information about where to publish the inventory results (documented below).
includedObjectVersions This property is required. String
Object versions to include in the inventory list. Valid values: All, Current.
schedule This property is required. InventorySchedule
Specifies the schedule for generating inventory results (documented below).
enabled Boolean
Specifies whether the inventory is enabled or disabled.
filter InventoryFilter
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria (documented below).
name Changes to this property will trigger replacement. String
Unique identifier of the inventory configuration for the bucket.
optionalFields List<String>
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more details.
bucket
This property is required.
Changes to this property will trigger replacement.
string
Name of the source bucket that inventory lists the objects for.
destination This property is required. InventoryDestination
Contains information about where to publish the inventory results (documented below).
includedObjectVersions This property is required. string
Object versions to include in the inventory list. Valid values: All, Current.
schedule This property is required. InventorySchedule
Specifies the schedule for generating inventory results (documented below).
enabled boolean
Specifies whether the inventory is enabled or disabled.
filter InventoryFilter
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria (documented below).
name Changes to this property will trigger replacement. string
Unique identifier of the inventory configuration for the bucket.
optionalFields string[]
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more details.
bucket
This property is required.
Changes to this property will trigger replacement.
str
Name of the source bucket that inventory lists the objects for.
destination This property is required. InventoryDestinationArgs
Contains information about where to publish the inventory results (documented below).
included_object_versions This property is required. str
Object versions to include in the inventory list. Valid values: All, Current.
schedule This property is required. InventoryScheduleArgs
Specifies the schedule for generating inventory results (documented below).
enabled bool
Specifies whether the inventory is enabled or disabled.
filter InventoryFilterArgs
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria (documented below).
name Changes to this property will trigger replacement. str
Unique identifier of the inventory configuration for the bucket.
optional_fields Sequence[str]
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more details.
bucket
This property is required.
Changes to this property will trigger replacement.
String
Name of the source bucket that inventory lists the objects for.
destination This property is required. Property Map
Contains information about where to publish the inventory results (documented below).
includedObjectVersions This property is required. String
Object versions to include in the inventory list. Valid values: All, Current.
schedule This property is required. Property Map
Specifies the schedule for generating inventory results (documented below).
enabled Boolean
Specifies whether the inventory is enabled or disabled.
filter Property Map
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria (documented below).
name Changes to this property will trigger replacement. String
Unique identifier of the inventory configuration for the bucket.
optionalFields List<String>
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more details.

Outputs

All input properties are implicitly available as output properties. Additionally, the Inventory resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Inventory Resource

Get an existing Inventory resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: InventoryState, opts?: CustomResourceOptions): Inventory
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket: Optional[str] = None,
        destination: Optional[InventoryDestinationArgs] = None,
        enabled: Optional[bool] = None,
        filter: Optional[InventoryFilterArgs] = None,
        included_object_versions: Optional[str] = None,
        name: Optional[str] = None,
        optional_fields: Optional[Sequence[str]] = None,
        schedule: Optional[InventoryScheduleArgs] = None) -> Inventory
func GetInventory(ctx *Context, name string, id IDInput, state *InventoryState, opts ...ResourceOption) (*Inventory, error)
public static Inventory Get(string name, Input<string> id, InventoryState? state, CustomResourceOptions? opts = null)
public static Inventory get(String name, Output<String> id, InventoryState state, CustomResourceOptions options)
resources:  _:    type: aws:s3:Inventory    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Bucket Changes to this property will trigger replacement. string
Name of the source bucket that inventory lists the objects for.
Destination InventoryDestination
Contains information about where to publish the inventory results (documented below).
Enabled bool
Specifies whether the inventory is enabled or disabled.
Filter InventoryFilter
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria (documented below).
IncludedObjectVersions string
Object versions to include in the inventory list. Valid values: All, Current.
Name Changes to this property will trigger replacement. string
Unique identifier of the inventory configuration for the bucket.
OptionalFields List<string>
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more details.
Schedule InventorySchedule
Specifies the schedule for generating inventory results (documented below).
Bucket Changes to this property will trigger replacement. string
Name of the source bucket that inventory lists the objects for.
Destination InventoryDestinationArgs
Contains information about where to publish the inventory results (documented below).
Enabled bool
Specifies whether the inventory is enabled or disabled.
Filter InventoryFilterArgs
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria (documented below).
IncludedObjectVersions string
Object versions to include in the inventory list. Valid values: All, Current.
Name Changes to this property will trigger replacement. string
Unique identifier of the inventory configuration for the bucket.
OptionalFields []string
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more details.
Schedule InventoryScheduleArgs
Specifies the schedule for generating inventory results (documented below).
bucket Changes to this property will trigger replacement. String
Name of the source bucket that inventory lists the objects for.
destination InventoryDestination
Contains information about where to publish the inventory results (documented below).
enabled Boolean
Specifies whether the inventory is enabled or disabled.
filter InventoryFilter
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria (documented below).
includedObjectVersions String
Object versions to include in the inventory list. Valid values: All, Current.
name Changes to this property will trigger replacement. String
Unique identifier of the inventory configuration for the bucket.
optionalFields List<String>
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more details.
schedule InventorySchedule
Specifies the schedule for generating inventory results (documented below).
bucket Changes to this property will trigger replacement. string
Name of the source bucket that inventory lists the objects for.
destination InventoryDestination
Contains information about where to publish the inventory results (documented below).
enabled boolean
Specifies whether the inventory is enabled or disabled.
filter InventoryFilter
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria (documented below).
includedObjectVersions string
Object versions to include in the inventory list. Valid values: All, Current.
name Changes to this property will trigger replacement. string
Unique identifier of the inventory configuration for the bucket.
optionalFields string[]
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more details.
schedule InventorySchedule
Specifies the schedule for generating inventory results (documented below).
bucket Changes to this property will trigger replacement. str
Name of the source bucket that inventory lists the objects for.
destination InventoryDestinationArgs
Contains information about where to publish the inventory results (documented below).
enabled bool
Specifies whether the inventory is enabled or disabled.
filter InventoryFilterArgs
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria (documented below).
included_object_versions str
Object versions to include in the inventory list. Valid values: All, Current.
name Changes to this property will trigger replacement. str
Unique identifier of the inventory configuration for the bucket.
optional_fields Sequence[str]
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more details.
schedule InventoryScheduleArgs
Specifies the schedule for generating inventory results (documented below).
bucket Changes to this property will trigger replacement. String
Name of the source bucket that inventory lists the objects for.
destination Property Map
Contains information about where to publish the inventory results (documented below).
enabled Boolean
Specifies whether the inventory is enabled or disabled.
filter Property Map
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria (documented below).
includedObjectVersions String
Object versions to include in the inventory list. Valid values: All, Current.
name Changes to this property will trigger replacement. String
Unique identifier of the inventory configuration for the bucket.
optionalFields List<String>
List of optional fields that are included in the inventory results. Please refer to the S3 documentation for more details.
schedule Property Map
Specifies the schedule for generating inventory results (documented below).

Supporting Types

InventoryDestination
, InventoryDestinationArgs

Bucket This property is required. InventoryDestinationBucket
S3 bucket configuration where inventory results are published (documented below).
Bucket This property is required. InventoryDestinationBucket
S3 bucket configuration where inventory results are published (documented below).
bucket This property is required. InventoryDestinationBucket
S3 bucket configuration where inventory results are published (documented below).
bucket This property is required. InventoryDestinationBucket
S3 bucket configuration where inventory results are published (documented below).
bucket This property is required. InventoryDestinationBucket
S3 bucket configuration where inventory results are published (documented below).
bucket This property is required. Property Map
S3 bucket configuration where inventory results are published (documented below).

InventoryDestinationBucket
, InventoryDestinationBucketArgs

BucketArn This property is required. string
Amazon S3 bucket ARN of the destination.
Format This property is required. string
Specifies the output format of the inventory results. Can be CSV, ORC or Parquet.
AccountId string
ID of the account that owns the destination bucket. Recommended to be set to prevent problems if the destination bucket ownership changes.
Encryption InventoryDestinationBucketEncryption
Contains the type of server-side encryption to use to encrypt the inventory (documented below).
Prefix string
Prefix that is prepended to all inventory results.
BucketArn This property is required. string
Amazon S3 bucket ARN of the destination.
Format This property is required. string
Specifies the output format of the inventory results. Can be CSV, ORC or Parquet.
AccountId string
ID of the account that owns the destination bucket. Recommended to be set to prevent problems if the destination bucket ownership changes.
Encryption InventoryDestinationBucketEncryption
Contains the type of server-side encryption to use to encrypt the inventory (documented below).
Prefix string
Prefix that is prepended to all inventory results.
bucketArn This property is required. String
Amazon S3 bucket ARN of the destination.
format This property is required. String
Specifies the output format of the inventory results. Can be CSV, ORC or Parquet.
accountId String
ID of the account that owns the destination bucket. Recommended to be set to prevent problems if the destination bucket ownership changes.
encryption InventoryDestinationBucketEncryption
Contains the type of server-side encryption to use to encrypt the inventory (documented below).
prefix String
Prefix that is prepended to all inventory results.
bucketArn This property is required. string
Amazon S3 bucket ARN of the destination.
format This property is required. string
Specifies the output format of the inventory results. Can be CSV, ORC or Parquet.
accountId string
ID of the account that owns the destination bucket. Recommended to be set to prevent problems if the destination bucket ownership changes.
encryption InventoryDestinationBucketEncryption
Contains the type of server-side encryption to use to encrypt the inventory (documented below).
prefix string
Prefix that is prepended to all inventory results.
bucket_arn This property is required. str
Amazon S3 bucket ARN of the destination.
format This property is required. str
Specifies the output format of the inventory results. Can be CSV, ORC or Parquet.
account_id str
ID of the account that owns the destination bucket. Recommended to be set to prevent problems if the destination bucket ownership changes.
encryption InventoryDestinationBucketEncryption
Contains the type of server-side encryption to use to encrypt the inventory (documented below).
prefix str
Prefix that is prepended to all inventory results.
bucketArn This property is required. String
Amazon S3 bucket ARN of the destination.
format This property is required. String
Specifies the output format of the inventory results. Can be CSV, ORC or Parquet.
accountId String
ID of the account that owns the destination bucket. Recommended to be set to prevent problems if the destination bucket ownership changes.
encryption Property Map
Contains the type of server-side encryption to use to encrypt the inventory (documented below).
prefix String
Prefix that is prepended to all inventory results.

InventoryDestinationBucketEncryption
, InventoryDestinationBucketEncryptionArgs

SseKms InventoryDestinationBucketEncryptionSseKms
Specifies to use server-side encryption with AWS KMS-managed keys to encrypt the inventory file (documented below).
SseS3 InventoryDestinationBucketEncryptionSseS3
Specifies to use server-side encryption with Amazon S3-managed keys (SSE-S3) to encrypt the inventory file.
SseKms InventoryDestinationBucketEncryptionSseKms
Specifies to use server-side encryption with AWS KMS-managed keys to encrypt the inventory file (documented below).
SseS3 InventoryDestinationBucketEncryptionSseS3
Specifies to use server-side encryption with Amazon S3-managed keys (SSE-S3) to encrypt the inventory file.
sseKms InventoryDestinationBucketEncryptionSseKms
Specifies to use server-side encryption with AWS KMS-managed keys to encrypt the inventory file (documented below).
sseS3 InventoryDestinationBucketEncryptionSseS3
Specifies to use server-side encryption with Amazon S3-managed keys (SSE-S3) to encrypt the inventory file.
sseKms InventoryDestinationBucketEncryptionSseKms
Specifies to use server-side encryption with AWS KMS-managed keys to encrypt the inventory file (documented below).
sseS3 InventoryDestinationBucketEncryptionSseS3
Specifies to use server-side encryption with Amazon S3-managed keys (SSE-S3) to encrypt the inventory file.
sse_kms InventoryDestinationBucketEncryptionSseKms
Specifies to use server-side encryption with AWS KMS-managed keys to encrypt the inventory file (documented below).
sse_s3 InventoryDestinationBucketEncryptionSseS3
Specifies to use server-side encryption with Amazon S3-managed keys (SSE-S3) to encrypt the inventory file.
sseKms Property Map
Specifies to use server-side encryption with AWS KMS-managed keys to encrypt the inventory file (documented below).
sseS3 Property Map
Specifies to use server-side encryption with Amazon S3-managed keys (SSE-S3) to encrypt the inventory file.

InventoryDestinationBucketEncryptionSseKms
, InventoryDestinationBucketEncryptionSseKmsArgs

KeyId This property is required. string
ARN of the KMS customer master key (CMK) used to encrypt the inventory file.
KeyId This property is required. string
ARN of the KMS customer master key (CMK) used to encrypt the inventory file.
keyId This property is required. String
ARN of the KMS customer master key (CMK) used to encrypt the inventory file.
keyId This property is required. string
ARN of the KMS customer master key (CMK) used to encrypt the inventory file.
key_id This property is required. str
ARN of the KMS customer master key (CMK) used to encrypt the inventory file.
keyId This property is required. String
ARN of the KMS customer master key (CMK) used to encrypt the inventory file.

InventoryFilter
, InventoryFilterArgs

Prefix string
Prefix that an object must have to be included in the inventory results.
Prefix string
Prefix that an object must have to be included in the inventory results.
prefix String
Prefix that an object must have to be included in the inventory results.
prefix string
Prefix that an object must have to be included in the inventory results.
prefix str
Prefix that an object must have to be included in the inventory results.
prefix String
Prefix that an object must have to be included in the inventory results.

InventorySchedule
, InventoryScheduleArgs

Frequency This property is required. string
Specifies how frequently inventory results are produced. Valid values: Daily, Weekly.
Frequency This property is required. string
Specifies how frequently inventory results are produced. Valid values: Daily, Weekly.
frequency This property is required. String
Specifies how frequently inventory results are produced. Valid values: Daily, Weekly.
frequency This property is required. string
Specifies how frequently inventory results are produced. Valid values: Daily, Weekly.
frequency This property is required. str
Specifies how frequently inventory results are produced. Valid values: Daily, Weekly.
frequency This property is required. String
Specifies how frequently inventory results are produced. Valid values: Daily, Weekly.

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
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws