Class CfnBucket.InventoryConfigurationProperty

Specifies the inventory configuration for an Amazon S3 bucket.

Inheritance

System.Object

CfnBucket.InventoryConfigurationProperty

Implements

CfnBucket.IInventoryConfigurationProperty

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class InventoryConfigurationProperty : Object, CfnBucket.IInventoryConfigurationProperty

Syntax (vb)

Public Class InventoryConfigurationProperty
    Inherits Object
    Implements CfnBucket.IInventoryConfigurationProperty

Remarks

For more information, see GET Bucket inventory in the Amazon S3 API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3;

var inventoryConfigurationProperty = new InventoryConfigurationProperty {
    Destination = new DestinationProperty {
        BucketArn = "bucketArn",
        Format = "format",

        // the properties below are optional
        BucketAccountId = "bucketAccountId",
        Prefix = "prefix"
    },
    Enabled = false,
    Id = "id",
    IncludedObjectVersions = "includedObjectVersions",
    ScheduleFrequency = "scheduleFrequency",

    // the properties below are optional
    OptionalFields = new [] { "optionalFields" },
    Prefix = "prefix"
};

Synopsis

Constructors

InventoryConfigurationProperty()

Properties

Destination	Contains information about where to publish the inventory results.
Enabled	Specifies whether the inventory is enabled or disabled.
Id	The ID used to identify the inventory configuration.
IncludedObjectVersions	Object versions to include in the inventory list.
OptionalFields	Contains the optional fields that are included in the inventory results.
Prefix	Specifies the inventory filter prefix.
ScheduleFrequency	Specifies the schedule for generating inventory results.

Constructors

InventoryConfigurationProperty()

public InventoryConfigurationProperty()

Properties

Destination

Contains information about where to publish the inventory results.

public object Destination { get; set; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-destination

Enabled

Specifies whether the inventory is enabled or disabled.

public object Enabled { get; set; }

Property Value

System.Object

Remarks

If set to True , an inventory list is generated. If set to False , no inventory list is generated.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-enabled

Id

The ID used to identify the inventory configuration.

public string Id { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-id

IncludedObjectVersions

Object versions to include in the inventory list.

public string IncludedObjectVersions { get; set; }

Property Value

System.String

Remarks

If set to All , the list includes all the object versions, which adds the version-related fields VersionId , IsLatest , and DeleteMarker to the list. If set to Current , the list does not contain these version-related fields.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-includedobjectversions

OptionalFields

Contains the optional fields that are included in the inventory results.

public string[] OptionalFields { get; set; }

Property Value

System.String[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-optionalfields

Prefix

Specifies the inventory filter prefix.

public string Prefix { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-prefix

ScheduleFrequency

Specifies the schedule for generating inventory results.

public string ScheduleFrequency { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-schedulefrequency

Implements

CfnBucket.IInventoryConfigurationProperty