Interface CfnBucket.IInventoryConfigurationProperty

Specifies the inventory configuration for an Amazon S3 bucket.

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.AWS.S3.dll

Syntax (csharp)

public interface IInventoryConfigurationProperty

Syntax (vb)

Public Interface IInventoryConfigurationProperty

Remarks

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

Link: 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;

InventoryConfigurationProperty 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

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.

Properties

Destination

Contains information about where to publish the inventory results.

object Destination { get; }

Property Value

System.Object

Remarks

Link: 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.

object Enabled { get; }

Property Value

System.Object

Remarks

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

Link: 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.

string Id { get; }

Property Value

System.String

Remarks

Link: 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.

string IncludedObjectVersions { get; }

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.

Link: 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.

virtual string[] OptionalFields { get; }

Property Value

System.String[]

Remarks

Valid values : Size | LastModifiedDate | StorageClass | ETag | IsMultipartUploaded | ReplicationStatus | EncryptionStatus | ObjectLockRetainUntilDate | ObjectLockMode | ObjectLockLegalHoldStatus | IntelligentTieringAccessTier | BucketKeyStatus

Link: 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.

virtual string Prefix { get; }

Property Value

System.String

Remarks

Link: 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.

string ScheduleFrequency { get; }

Property Value

System.String

Remarks

Allowed values : Daily | Weekly

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