Package software.amazon.awscdk.cfnpropertymixins.services.s3express

Interface CfnDirectoryBucketPropsMixin.InventoryConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDirectoryBucketPropsMixin.InventoryConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDirectoryBucketPropsMixin

@Stability(Stable)
public static interface CfnDirectoryBucketPropsMixin.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.cfnpropertymixins.services.s3express.*;
 InventoryConfigurationProperty inventoryConfigurationProperty = InventoryConfigurationProperty.builder()
         .destination(DestinationProperty.builder()
                 .bucketAccountId("bucketAccountId")
                 .bucketArn("bucketArn")
                 .format("format")
                 .prefix("prefix")
                 .build())
         .enabled(false)
         .id("id")
         .includedObjectVersions("includedObjectVersions")
         .optionalFields(List.of("optionalFields"))
         .prefix("prefix")
         .scheduleFrequency("scheduleFrequency")
         .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	CfnDirectoryBucketPropsMixin.InventoryConfigurationProperty.Builder	A builder for CfnDirectoryBucketPropsMixin.InventoryConfigurationProperty
static final class	CfnDirectoryBucketPropsMixin.InventoryConfigurationProperty.Jsii$Proxy	An implementation for CfnDirectoryBucketPropsMixin.InventoryConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDirectoryBucketPropsMixin.InventoryConfigurationProperty.Builder	builder()
default Object	getDestination()	Specifies information about where to publish inventory reports for an Amazon S3 Express bucket.
default Object	getEnabled()	Specifies whether the inventory is enabled or disabled.
default String	getId()	The ID used to identify the inventory configuration.
default 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.
default String	getScheduleFrequency()	Specifies the schedule for generating inventory results.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestination

@Stability(Stable)
@Nullable
default Object getDestination()

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

Returns union: either IResolvable or CfnDirectoryBucketPropsMixin.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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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

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

getScheduleFrequency

@Stability(Stable)
@Nullable
default 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

builder

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

Returns:

a CfnDirectoryBucketPropsMixin.InventoryConfigurationProperty.Builder of CfnDirectoryBucketPropsMixin.InventoryConfigurationProperty