Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. ObsBucketInventory
opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.ObsBucketInventory

Explore with Pulumi AI

opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

Up-to-date reference of API arguments for OBS bucket inventory you can get at documentation portal

Configures OBS bucket inventory resource within OpenTelekomCloud.

Example Usage

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

const bucket = new opentelekomcloud.ObsBucket("bucket", {bucket: "my-tf-test-bucket"});
const inventory = new opentelekomcloud.ObsBucketInventory("inventory", {
    bucket: bucket.bucket,
    configurationId: "test-id",
    isEnabled: true,
    frequency: "Weekly",
    destination: {
        bucket: bucket.bucket,
        format: "CSV",
        prefix: "test-",
    },
    filterPrefix: "test-filter-prefix",
    includedObjectVersions: "Current",
    optionalFields: [
        "Size",
        "LastModifiedDate",
        "ReplicationStatus",
    ],
});
Copy
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

bucket = opentelekomcloud.ObsBucket("bucket", bucket="my-tf-test-bucket")
inventory = opentelekomcloud.ObsBucketInventory("inventory",
    bucket=bucket.bucket,
    configuration_id="test-id",
    is_enabled=True,
    frequency="Weekly",
    destination={
        "bucket": bucket.bucket,
        "format": "CSV",
        "prefix": "test-",
    },
    filter_prefix="test-filter-prefix",
    included_object_versions="Current",
    optional_fields=[
        "Size",
        "LastModifiedDate",
        "ReplicationStatus",
    ])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		bucket, err := opentelekomcloud.NewObsBucket(ctx, "bucket", &opentelekomcloud.ObsBucketArgs{
			Bucket: pulumi.String("my-tf-test-bucket"),
		})
		if err != nil {
			return err
		}
		_, err = opentelekomcloud.NewObsBucketInventory(ctx, "inventory", &opentelekomcloud.ObsBucketInventoryArgs{
			Bucket:          bucket.Bucket,
			ConfigurationId: pulumi.String("test-id"),
			IsEnabled:       pulumi.Bool(true),
			Frequency:       pulumi.String("Weekly"),
			Destination: &opentelekomcloud.ObsBucketInventoryDestinationArgs{
				Bucket: bucket.Bucket,
				Format: pulumi.String("CSV"),
				Prefix: pulumi.String("test-"),
			},
			FilterPrefix:           pulumi.String("test-filter-prefix"),
			IncludedObjectVersions: pulumi.String("Current"),
			OptionalFields: pulumi.StringArray{
				pulumi.String("Size"),
				pulumi.String("LastModifiedDate"),
				pulumi.String("ReplicationStatus"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;

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

    var inventory = new Opentelekomcloud.ObsBucketInventory("inventory", new()
    {
        Bucket = bucket.Bucket,
        ConfigurationId = "test-id",
        IsEnabled = true,
        Frequency = "Weekly",
        Destination = new Opentelekomcloud.Inputs.ObsBucketInventoryDestinationArgs
        {
            Bucket = bucket.Bucket,
            Format = "CSV",
            Prefix = "test-",
        },
        FilterPrefix = "test-filter-prefix",
        IncludedObjectVersions = "Current",
        OptionalFields = new[]
        {
            "Size",
            "LastModifiedDate",
            "ReplicationStatus",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.ObsBucket;
import com.pulumi.opentelekomcloud.ObsBucketArgs;
import com.pulumi.opentelekomcloud.ObsBucketInventory;
import com.pulumi.opentelekomcloud.ObsBucketInventoryArgs;
import com.pulumi.opentelekomcloud.inputs.ObsBucketInventoryDestinationArgs;
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 bucket = new ObsBucket("bucket", ObsBucketArgs.builder()
            .bucket("my-tf-test-bucket")
            .build());

        var inventory = new ObsBucketInventory("inventory", ObsBucketInventoryArgs.builder()
            .bucket(bucket.bucket())
            .configurationId("test-id")
            .isEnabled(true)
            .frequency("Weekly")
            .destination(ObsBucketInventoryDestinationArgs.builder()
                .bucket(bucket.bucket())
                .format("CSV")
                .prefix("test-")
                .build())
            .filterPrefix("test-filter-prefix")
            .includedObjectVersions("Current")
            .optionalFields(            
                "Size",
                "LastModifiedDate",
                "ReplicationStatus")
            .build());

    }
}
Copy
resources:
  bucket:
    type: opentelekomcloud:ObsBucket
    properties:
      bucket: my-tf-test-bucket
  inventory:
    type: opentelekomcloud:ObsBucketInventory
    properties:
      bucket: ${bucket.bucket}
      configurationId: test-id
      isEnabled: true
      frequency: Weekly
      destination:
        bucket: ${bucket.bucket}
        format: CSV
        prefix: test-
      filterPrefix: test-filter-prefix
      includedObjectVersions: Current
      optionalFields:
        - Size
        - LastModifiedDate
        - ReplicationStatus
Copy

Create ObsBucketInventory Resource

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

Constructor syntax

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

@overload
def ObsBucketInventory(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       bucket: Optional[str] = None,
                       configuration_id: Optional[str] = None,
                       destination: Optional[ObsBucketInventoryDestinationArgs] = None,
                       frequency: Optional[str] = None,
                       included_object_versions: Optional[str] = None,
                       is_enabled: Optional[bool] = None,
                       filter_prefix: Optional[str] = None,
                       obs_bucket_inventory_id: Optional[str] = None,
                       optional_fields: Optional[Sequence[str]] = None)
func NewObsBucketInventory(ctx *Context, name string, args ObsBucketInventoryArgs, opts ...ResourceOption) (*ObsBucketInventory, error)
public ObsBucketInventory(string name, ObsBucketInventoryArgs args, CustomResourceOptions? opts = null)
public ObsBucketInventory(String name, ObsBucketInventoryArgs args)
public ObsBucketInventory(String name, ObsBucketInventoryArgs args, CustomResourceOptions options)

type: opentelekomcloud:ObsBucketInventory
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. ObsBucketInventoryArgs
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. ObsBucketInventoryArgs
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. ObsBucketInventoryArgs
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. ObsBucketInventoryArgs
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. ObsBucketInventoryArgs
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 obsBucketInventoryResource = new Opentelekomcloud.ObsBucketInventory("obsBucketInventoryResource", new()
{
    Bucket = "string",
    ConfigurationId = "string",
    Destination = new Opentelekomcloud.Inputs.ObsBucketInventoryDestinationArgs
    {
        Bucket = "string",
        Format = "string",
        Prefix = "string",
    },
    Frequency = "string",
    IncludedObjectVersions = "string",
    IsEnabled = false,
    FilterPrefix = "string",
    ObsBucketInventoryId = "string",
    OptionalFields = new[]
    {
        "string",
    },
});
Copy
example, err := opentelekomcloud.NewObsBucketInventory(ctx, "obsBucketInventoryResource", &opentelekomcloud.ObsBucketInventoryArgs{
Bucket: pulumi.String("string"),
ConfigurationId: pulumi.String("string"),
Destination: &.ObsBucketInventoryDestinationArgs{
Bucket: pulumi.String("string"),
Format: pulumi.String("string"),
Prefix: pulumi.String("string"),
},
Frequency: pulumi.String("string"),
IncludedObjectVersions: pulumi.String("string"),
IsEnabled: pulumi.Bool(false),
FilterPrefix: pulumi.String("string"),
ObsBucketInventoryId: pulumi.String("string"),
OptionalFields: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var obsBucketInventoryResource = new ObsBucketInventory("obsBucketInventoryResource", ObsBucketInventoryArgs.builder()
    .bucket("string")
    .configurationId("string")
    .destination(ObsBucketInventoryDestinationArgs.builder()
        .bucket("string")
        .format("string")
        .prefix("string")
        .build())
    .frequency("string")
    .includedObjectVersions("string")
    .isEnabled(false)
    .filterPrefix("string")
    .obsBucketInventoryId("string")
    .optionalFields("string")
    .build());
Copy
obs_bucket_inventory_resource = opentelekomcloud.ObsBucketInventory("obsBucketInventoryResource",
    bucket="string",
    configuration_id="string",
    destination={
        "bucket": "string",
        "format": "string",
        "prefix": "string",
    },
    frequency="string",
    included_object_versions="string",
    is_enabled=False,
    filter_prefix="string",
    obs_bucket_inventory_id="string",
    optional_fields=["string"])
Copy
const obsBucketInventoryResource = new opentelekomcloud.ObsBucketInventory("obsBucketInventoryResource", {
    bucket: "string",
    configurationId: "string",
    destination: {
        bucket: "string",
        format: "string",
        prefix: "string",
    },
    frequency: "string",
    includedObjectVersions: "string",
    isEnabled: false,
    filterPrefix: "string",
    obsBucketInventoryId: "string",
    optionalFields: ["string"],
});
Copy
type: opentelekomcloud:ObsBucketInventory
properties:
    bucket: string
    configurationId: string
    destination:
        bucket: string
        format: string
        prefix: string
    filterPrefix: string
    frequency: string
    includedObjectVersions: string
    isEnabled: false
    obsBucketInventoryId: string
    optionalFields:
        - string
Copy

ObsBucketInventory 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 ObsBucketInventory resource accepts the following input properties:

Bucket This property is required. string
Name of the bucket for saving inventories.
ConfigurationId This property is required. string
ID of the inventory configuration. Valid characters: letters, digits, hyphens (-), periods (.) and underscores (_).
Destination This property is required. ObsBucketInventoryDestination
Destination bucket settings of an inventory. The structure is documented below.
Frequency This property is required. string
Intervals when inventories are generated. An inventory is generated within one hour after it is configured for the first time. Then it is generated at the specified intervals. Possible values:

  • Daily
  • Weekly
IncludedObjectVersions This property is required. string
Indicates whether versions of objects are included in an inventory. Possible values:

  • All
  • Current
IsEnabled This property is required. bool
Indicates whether the rule is enabled. If this parameter is set to true, the inventory is generated.
FilterPrefix string
Filtering by name prefix. Only objects with the specified name prefix are included in the inventory.
ObsBucketInventoryId string
OptionalFields List<string>
Extra metadata fields that can be added to an inventory. If this parameter is configured, fields specified in this parameter are contained in the inventory. Possible values:

  • Size
  • LastModifiedDate
  • ETag
  • StorageClass
  • IsMultipartUploaded
  • ReplicationStatus
  • EncryptionStatus
Bucket This property is required. string
Name of the bucket for saving inventories.
ConfigurationId This property is required. string
ID of the inventory configuration. Valid characters: letters, digits, hyphens (-), periods (.) and underscores (_).
Destination This property is required. ObsBucketInventoryDestinationArgs
Destination bucket settings of an inventory. The structure is documented below.
Frequency This property is required. string
Intervals when inventories are generated. An inventory is generated within one hour after it is configured for the first time. Then it is generated at the specified intervals. Possible values:

  • Daily
  • Weekly
IncludedObjectVersions This property is required. string
Indicates whether versions of objects are included in an inventory. Possible values:

  • All
  • Current
IsEnabled This property is required. bool
Indicates whether the rule is enabled. If this parameter is set to true, the inventory is generated.
FilterPrefix string
Filtering by name prefix. Only objects with the specified name prefix are included in the inventory.
ObsBucketInventoryId string
OptionalFields []string
Extra metadata fields that can be added to an inventory. If this parameter is configured, fields specified in this parameter are contained in the inventory. Possible values:

  • Size
  • LastModifiedDate
  • ETag
  • StorageClass
  • IsMultipartUploaded
  • ReplicationStatus
  • EncryptionStatus
bucket This property is required. String
Name of the bucket for saving inventories.
configurationId This property is required. String
ID of the inventory configuration. Valid characters: letters, digits, hyphens (-), periods (.) and underscores (_).
destination This property is required. ObsBucketInventoryDestination
Destination bucket settings of an inventory. The structure is documented below.
frequency This property is required. String
Intervals when inventories are generated. An inventory is generated within one hour after it is configured for the first time. Then it is generated at the specified intervals. Possible values:

  • Daily
  • Weekly
includedObjectVersions This property is required. String
Indicates whether versions of objects are included in an inventory. Possible values:

  • All
  • Current
isEnabled This property is required. Boolean
Indicates whether the rule is enabled. If this parameter is set to true, the inventory is generated.
filterPrefix String
Filtering by name prefix. Only objects with the specified name prefix are included in the inventory.
obsBucketInventoryId String
optionalFields List<String>
Extra metadata fields that can be added to an inventory. If this parameter is configured, fields specified in this parameter are contained in the inventory. Possible values:

  • Size
  • LastModifiedDate
  • ETag
  • StorageClass
  • IsMultipartUploaded
  • ReplicationStatus
  • EncryptionStatus
bucket This property is required. string
Name of the bucket for saving inventories.
configurationId This property is required. string
ID of the inventory configuration. Valid characters: letters, digits, hyphens (-), periods (.) and underscores (_).
destination This property is required. ObsBucketInventoryDestination
Destination bucket settings of an inventory. The structure is documented below.
frequency This property is required. string
Intervals when inventories are generated. An inventory is generated within one hour after it is configured for the first time. Then it is generated at the specified intervals. Possible values:

  • Daily
  • Weekly
includedObjectVersions This property is required. string
Indicates whether versions of objects are included in an inventory. Possible values:

  • All
  • Current
isEnabled This property is required. boolean
Indicates whether the rule is enabled. If this parameter is set to true, the inventory is generated.
filterPrefix string
Filtering by name prefix. Only objects with the specified name prefix are included in the inventory.
obsBucketInventoryId string
optionalFields string[]
Extra metadata fields that can be added to an inventory. If this parameter is configured, fields specified in this parameter are contained in the inventory. Possible values:

  • Size
  • LastModifiedDate
  • ETag
  • StorageClass
  • IsMultipartUploaded
  • ReplicationStatus
  • EncryptionStatus
bucket This property is required. str
Name of the bucket for saving inventories.
configuration_id This property is required. str
ID of the inventory configuration. Valid characters: letters, digits, hyphens (-), periods (.) and underscores (_).
destination This property is required. ObsBucketInventoryDestinationArgs
Destination bucket settings of an inventory. The structure is documented below.
frequency This property is required. str
Intervals when inventories are generated. An inventory is generated within one hour after it is configured for the first time. Then it is generated at the specified intervals. Possible values:

  • Daily
  • Weekly
included_object_versions This property is required. str
Indicates whether versions of objects are included in an inventory. Possible values:

  • All
  • Current
is_enabled This property is required. bool
Indicates whether the rule is enabled. If this parameter is set to true, the inventory is generated.
filter_prefix str
Filtering by name prefix. Only objects with the specified name prefix are included in the inventory.
obs_bucket_inventory_id str
optional_fields Sequence[str]
Extra metadata fields that can be added to an inventory. If this parameter is configured, fields specified in this parameter are contained in the inventory. Possible values:

  • Size
  • LastModifiedDate
  • ETag
  • StorageClass
  • IsMultipartUploaded
  • ReplicationStatus
  • EncryptionStatus
bucket This property is required. String
Name of the bucket for saving inventories.
configurationId This property is required. String
ID of the inventory configuration. Valid characters: letters, digits, hyphens (-), periods (.) and underscores (_).
destination This property is required. Property Map
Destination bucket settings of an inventory. The structure is documented below.
frequency This property is required. String
Intervals when inventories are generated. An inventory is generated within one hour after it is configured for the first time. Then it is generated at the specified intervals. Possible values:

  • Daily
  • Weekly
includedObjectVersions This property is required. String
Indicates whether versions of objects are included in an inventory. Possible values:

  • All
  • Current
isEnabled This property is required. Boolean
Indicates whether the rule is enabled. If this parameter is set to true, the inventory is generated.
filterPrefix String
Filtering by name prefix. Only objects with the specified name prefix are included in the inventory.
obsBucketInventoryId String
optionalFields List<String>
Extra metadata fields that can be added to an inventory. If this parameter is configured, fields specified in this parameter are contained in the inventory. Possible values:

  • Size
  • LastModifiedDate
  • ETag
  • StorageClass
  • IsMultipartUploaded
  • ReplicationStatus
  • EncryptionStatus

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Region string
Specifies the bucket region.
Id string
The provider-assigned unique ID for this managed resource.
Region string
Specifies the bucket region.
id String
The provider-assigned unique ID for this managed resource.
region String
Specifies the bucket region.
id string
The provider-assigned unique ID for this managed resource.
region string
Specifies the bucket region.
id str
The provider-assigned unique ID for this managed resource.
region str
Specifies the bucket region.
id String
The provider-assigned unique ID for this managed resource.
region String
Specifies the bucket region.

Look up Existing ObsBucketInventory Resource

Get an existing ObsBucketInventory 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?: ObsBucketInventoryState, opts?: CustomResourceOptions): ObsBucketInventory
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket: Optional[str] = None,
        configuration_id: Optional[str] = None,
        destination: Optional[ObsBucketInventoryDestinationArgs] = None,
        filter_prefix: Optional[str] = None,
        frequency: Optional[str] = None,
        included_object_versions: Optional[str] = None,
        is_enabled: Optional[bool] = None,
        obs_bucket_inventory_id: Optional[str] = None,
        optional_fields: Optional[Sequence[str]] = None,
        region: Optional[str] = None) -> ObsBucketInventory
func GetObsBucketInventory(ctx *Context, name string, id IDInput, state *ObsBucketInventoryState, opts ...ResourceOption) (*ObsBucketInventory, error)
public static ObsBucketInventory Get(string name, Input<string> id, ObsBucketInventoryState? state, CustomResourceOptions? opts = null)
public static ObsBucketInventory get(String name, Output<String> id, ObsBucketInventoryState state, CustomResourceOptions options)
resources:  _:    type: opentelekomcloud:ObsBucketInventory    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 string
Name of the bucket for saving inventories.
ConfigurationId string
ID of the inventory configuration. Valid characters: letters, digits, hyphens (-), periods (.) and underscores (_).
Destination ObsBucketInventoryDestination
Destination bucket settings of an inventory. The structure is documented below.
FilterPrefix string
Filtering by name prefix. Only objects with the specified name prefix are included in the inventory.
Frequency string
Intervals when inventories are generated. An inventory is generated within one hour after it is configured for the first time. Then it is generated at the specified intervals. Possible values:

  • Daily
  • Weekly
IncludedObjectVersions string
Indicates whether versions of objects are included in an inventory. Possible values:

  • All
  • Current
IsEnabled bool
Indicates whether the rule is enabled. If this parameter is set to true, the inventory is generated.
ObsBucketInventoryId string
OptionalFields List<string>
Extra metadata fields that can be added to an inventory. If this parameter is configured, fields specified in this parameter are contained in the inventory. Possible values:

  • Size
  • LastModifiedDate
  • ETag
  • StorageClass
  • IsMultipartUploaded
  • ReplicationStatus
  • EncryptionStatus
Region string
Specifies the bucket region.
Bucket string
Name of the bucket for saving inventories.
ConfigurationId string
ID of the inventory configuration. Valid characters: letters, digits, hyphens (-), periods (.) and underscores (_).
Destination ObsBucketInventoryDestinationArgs
Destination bucket settings of an inventory. The structure is documented below.
FilterPrefix string
Filtering by name prefix. Only objects with the specified name prefix are included in the inventory.
Frequency string
Intervals when inventories are generated. An inventory is generated within one hour after it is configured for the first time. Then it is generated at the specified intervals. Possible values:

  • Daily
  • Weekly
IncludedObjectVersions string
Indicates whether versions of objects are included in an inventory. Possible values:

  • All
  • Current
IsEnabled bool
Indicates whether the rule is enabled. If this parameter is set to true, the inventory is generated.
ObsBucketInventoryId string
OptionalFields []string
Extra metadata fields that can be added to an inventory. If this parameter is configured, fields specified in this parameter are contained in the inventory. Possible values:

  • Size
  • LastModifiedDate
  • ETag
  • StorageClass
  • IsMultipartUploaded
  • ReplicationStatus
  • EncryptionStatus
Region string
Specifies the bucket region.
bucket String
Name of the bucket for saving inventories.
configurationId String
ID of the inventory configuration. Valid characters: letters, digits, hyphens (-), periods (.) and underscores (_).
destination ObsBucketInventoryDestination
Destination bucket settings of an inventory. The structure is documented below.
filterPrefix String
Filtering by name prefix. Only objects with the specified name prefix are included in the inventory.
frequency String
Intervals when inventories are generated. An inventory is generated within one hour after it is configured for the first time. Then it is generated at the specified intervals. Possible values:

  • Daily
  • Weekly
includedObjectVersions String
Indicates whether versions of objects are included in an inventory. Possible values:

  • All
  • Current
isEnabled Boolean
Indicates whether the rule is enabled. If this parameter is set to true, the inventory is generated.
obsBucketInventoryId String
optionalFields List<String>
Extra metadata fields that can be added to an inventory. If this parameter is configured, fields specified in this parameter are contained in the inventory. Possible values:

  • Size
  • LastModifiedDate
  • ETag
  • StorageClass
  • IsMultipartUploaded
  • ReplicationStatus
  • EncryptionStatus
region String
Specifies the bucket region.
bucket string
Name of the bucket for saving inventories.
configurationId string
ID of the inventory configuration. Valid characters: letters, digits, hyphens (-), periods (.) and underscores (_).
destination ObsBucketInventoryDestination
Destination bucket settings of an inventory. The structure is documented below.
filterPrefix string
Filtering by name prefix. Only objects with the specified name prefix are included in the inventory.
frequency string
Intervals when inventories are generated. An inventory is generated within one hour after it is configured for the first time. Then it is generated at the specified intervals. Possible values:

  • Daily
  • Weekly
includedObjectVersions string
Indicates whether versions of objects are included in an inventory. Possible values:

  • All
  • Current
isEnabled boolean
Indicates whether the rule is enabled. If this parameter is set to true, the inventory is generated.
obsBucketInventoryId string
optionalFields string[]
Extra metadata fields that can be added to an inventory. If this parameter is configured, fields specified in this parameter are contained in the inventory. Possible values:

  • Size
  • LastModifiedDate
  • ETag
  • StorageClass
  • IsMultipartUploaded
  • ReplicationStatus
  • EncryptionStatus
region string
Specifies the bucket region.
bucket str
Name of the bucket for saving inventories.
configuration_id str
ID of the inventory configuration. Valid characters: letters, digits, hyphens (-), periods (.) and underscores (_).
destination ObsBucketInventoryDestinationArgs
Destination bucket settings of an inventory. The structure is documented below.
filter_prefix str
Filtering by name prefix. Only objects with the specified name prefix are included in the inventory.
frequency str
Intervals when inventories are generated. An inventory is generated within one hour after it is configured for the first time. Then it is generated at the specified intervals. Possible values:

  • Daily
  • Weekly
included_object_versions str
Indicates whether versions of objects are included in an inventory. Possible values:

  • All
  • Current
is_enabled bool
Indicates whether the rule is enabled. If this parameter is set to true, the inventory is generated.
obs_bucket_inventory_id str
optional_fields Sequence[str]
Extra metadata fields that can be added to an inventory. If this parameter is configured, fields specified in this parameter are contained in the inventory. Possible values:

  • Size
  • LastModifiedDate
  • ETag
  • StorageClass
  • IsMultipartUploaded
  • ReplicationStatus
  • EncryptionStatus
region str
Specifies the bucket region.
bucket String
Name of the bucket for saving inventories.
configurationId String
ID of the inventory configuration. Valid characters: letters, digits, hyphens (-), periods (.) and underscores (_).
destination Property Map
Destination bucket settings of an inventory. The structure is documented below.
filterPrefix String
Filtering by name prefix. Only objects with the specified name prefix are included in the inventory.
frequency String
Intervals when inventories are generated. An inventory is generated within one hour after it is configured for the first time. Then it is generated at the specified intervals. Possible values:

  • Daily
  • Weekly
includedObjectVersions String
Indicates whether versions of objects are included in an inventory. Possible values:

  • All
  • Current
isEnabled Boolean
Indicates whether the rule is enabled. If this parameter is set to true, the inventory is generated.
obsBucketInventoryId String
optionalFields List<String>
Extra metadata fields that can be added to an inventory. If this parameter is configured, fields specified in this parameter are contained in the inventory. Possible values:

  • Size
  • LastModifiedDate
  • ETag
  • StorageClass
  • IsMultipartUploaded
  • ReplicationStatus
  • EncryptionStatus
region String
Specifies the bucket region.

Supporting Types

ObsBucketInventoryDestination
, ObsBucketInventoryDestinationArgs

Bucket This property is required. string
Name of the bucket for saving inventories.
Format This property is required. string
Inventory format. Only the CSV format is supported.
Prefix string
The name prefix of inventory files. If no prefix is configured, the names of inventory files will start with the BucketInventory by default.
Bucket This property is required. string
Name of the bucket for saving inventories.
Format This property is required. string
Inventory format. Only the CSV format is supported.
Prefix string
The name prefix of inventory files. If no prefix is configured, the names of inventory files will start with the BucketInventory by default.
bucket This property is required. String
Name of the bucket for saving inventories.
format This property is required. String
Inventory format. Only the CSV format is supported.
prefix String
The name prefix of inventory files. If no prefix is configured, the names of inventory files will start with the BucketInventory by default.
bucket This property is required. string
Name of the bucket for saving inventories.
format This property is required. string
Inventory format. Only the CSV format is supported.
prefix string
The name prefix of inventory files. If no prefix is configured, the names of inventory files will start with the BucketInventory by default.
bucket This property is required. str
Name of the bucket for saving inventories.
format This property is required. str
Inventory format. Only the CSV format is supported.
prefix str
The name prefix of inventory files. If no prefix is configured, the names of inventory files will start with the BucketInventory by default.
bucket This property is required. String
Name of the bucket for saving inventories.
format This property is required. String
Inventory format. Only the CSV format is supported.
prefix String
The name prefix of inventory files. If no prefix is configured, the names of inventory files will start with the BucketInventory by default.

Import

Inventories can be imported using related bucket and their configuration_id separated by the slashes, e.g.

bash

$ pulumi import opentelekomcloud:index/obsBucketInventory:ObsBucketInventory inv <bucket>/<configuration_id>
Copy

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

Package Details

Repository
opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
License
Notes
This Pulumi package is based on the opentelekomcloud Terraform Provider.
opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud