Package software.amazon.awscdk.services.s3express

Interface CfnDirectoryBucket.InventoryConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDirectoryBucket.InventoryConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDirectoryBucket

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

Specifies an inventory configuration for an Amazon S3 Express bucket.

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.s3express.*;
 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-s3express-directorybucket-inventoryconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDirectoryBucket.InventoryConfigurationProperty.Builder	builder()
Object	getDestination()	Specifies information about where to publish inventory reports for an Amazon S3 Express bucket.
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()	The prefix that is prepended to all inventory results.
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()

Specifies information about where to publish inventory reports for an Amazon S3 Express bucket.

Returns union: either IResolvable or CfnDirectoryBucket.DestinationProperty

See Also:

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

getEnabled

@Stability(Stable)
@NotNull
Object getEnabled()

Specifies whether the inventory is enabled or disabled.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-inventoryconfiguration.html#cfn-s3express-directorybucket-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-s3express-directorybucket-inventoryconfiguration.html#cfn-s3express-directorybucket-inventoryconfiguration-id

getIncludedObjectVersions

@Stability(Stable)
@NotNull
String getIncludedObjectVersions()

Object versions to include in the inventory list.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-inventoryconfiguration.html#cfn-s3express-directorybucket-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-s3express-directorybucket-inventoryconfiguration.html#cfn-s3express-directorybucket-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-s3express-directorybucket-inventoryconfiguration.html#cfn-s3express-directorybucket-inventoryconfiguration-optionalfields

getPrefix

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

The prefix that is prepended to all inventory results.

See Also:

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

builder

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

Returns:

a CfnDirectoryBucket.InventoryConfigurationProperty.Builder of CfnDirectoryBucket.InventoryConfigurationProperty