Package software.amazon.awscdk.services.s3

Interface CfnBucket.InventoryConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.InventoryConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.InventoryConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the inventory configuration for an Amazon S3 bucket.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3.*;
 InventoryConfigurationProperty inventoryConfigurationProperty = InventoryConfigurationProperty.builder()
         .destination(DestinationProperty.builder()
                 .bucketArn("bucketArn")
                 .format("format")
                 // the properties below are optional
                 .bucketAccountId("bucketAccountId")
                 .prefix("prefix")
                 .build())
         .enabled(false)
         .id("id")
         .includedObjectVersions("includedObjectVersions")
         .scheduleFrequency("scheduleFrequency")
         // the properties below are optional
         .optionalFields(List.of("optionalFields"))
         .prefix("prefix")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucket.InventoryConfigurationProperty.Builder	A builder for CfnBucket.InventoryConfigurationProperty
static final class	CfnBucket.InventoryConfigurationProperty.Jsii$Proxy	An implementation for CfnBucket.InventoryConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnBucket.InventoryConfigurationProperty.Builder	builder()
Object	getDestination()	Contains information about where to publish the inventory results.
Object	getEnabled()	Specifies whether the inventory is enabled or disabled.
String	getId()	The ID used to identify the inventory configuration.
String	getIncludedObjectVersions()	Object versions to include in the inventory list.
default List<String>	getOptionalFields()	Contains the optional fields that are included in the inventory results.
default String	getPrefix()	Specifies the inventory filter prefix.
String	getScheduleFrequency()	Specifies the schedule for generating inventory results.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestination

@Stability(Stable)
@NotNull
Object getDestination()

Contains information about where to publish the inventory results.

See Also:

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

getEnabled

@Stability(Stable)
@NotNull
Object getEnabled()

Specifies whether the inventory is enabled or disabled.

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

See Also:

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

getId

@Stability(Stable)
@NotNull
String getId()

The ID used to identify the inventory configuration.

See Also:

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

getIncludedObjectVersions

@Stability(Stable)
@NotNull
String getIncludedObjectVersions()

Object versions to include in the inventory list.

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 Also:

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

getScheduleFrequency

@Stability(Stable)
@NotNull
String getScheduleFrequency()

Specifies the schedule for generating inventory results.

See Also:

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

getOptionalFields

@Stability(Stable)
@Nullable
default List<String> getOptionalFields()

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

See Also:

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

getPrefix

@Stability(Stable)
@Nullable
default String getPrefix()

Specifies the inventory filter prefix.

See Also:

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

builder

@Stability(Stable)
static CfnBucket.InventoryConfigurationProperty.Builder builder()

Returns:

a CfnBucket.InventoryConfigurationProperty.Builder of CfnBucket.InventoryConfigurationProperty