Package software.amazon.awscdk.services.s3

Interface CfnBucket.MetadataConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.MetadataConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBucket

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

Creates a V2 Amazon S3 Metadata configuration of a general purpose bucket.

For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide .

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.*;
 MetadataConfigurationProperty metadataConfigurationProperty = MetadataConfigurationProperty.builder()
         .journalTableConfiguration(JournalTableConfigurationProperty.builder()
                 .recordExpiration(RecordExpirationProperty.builder()
                         .expiration("expiration")
                         // the properties below are optional
                         .days(123)
                         .build())
                 // the properties below are optional
                 .encryptionConfiguration(MetadataTableEncryptionConfigurationProperty.builder()
                         .sseAlgorithm("sseAlgorithm")
                         // the properties below are optional
                         .kmsKeyArn("kmsKeyArn")
                         .build())
                 .tableArn("tableArn")
                 .tableName("tableName")
                 .build())
         // the properties below are optional
         .annotationTableConfiguration(AnnotationTableConfigurationProperty.builder()
                 .configurationState("configurationState")
                 // the properties below are optional
                 .encryptionConfiguration(MetadataTableEncryptionConfigurationProperty.builder()
                         .sseAlgorithm("sseAlgorithm")
                         // the properties below are optional
                         .kmsKeyArn("kmsKeyArn")
                         .build())
                 .role("role")
                 .tableArn("tableArn")
                 .tableName("tableName")
                 .build())
         .destination(MetadataDestinationProperty.builder()
                 .tableBucketType("tableBucketType")
                 // the properties below are optional
                 .tableBucketArn("tableBucketArn")
                 .tableNamespace("tableNamespace")
                 .build())
         .inventoryTableConfiguration(InventoryTableConfigurationProperty.builder()
                 .configurationState("configurationState")
                 // the properties below are optional
                 .encryptionConfiguration(MetadataTableEncryptionConfigurationProperty.builder()
                         .sseAlgorithm("sseAlgorithm")
                         // the properties below are optional
                         .kmsKeyArn("kmsKeyArn")
                         .build())
                 .tableArn("tableArn")
                 .tableName("tableName")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBucket.MetadataConfigurationProperty.Builder	builder()
default Object	getAnnotationTableConfiguration()	The annotation table configuration for an S3 Metadata configuration.
default Object	getDestination()	The destination information for the S3 Metadata configuration.
default Object	getInventoryTableConfiguration()	The inventory table configuration for a metadata configuration.
Object	getJournalTableConfiguration()	The journal table configuration for a metadata configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getJournalTableConfiguration

@Stability(Stable)
@NotNull
Object getJournalTableConfiguration()

The journal table configuration for a metadata configuration.

Returns union: either IResolvable or CfnBucket.JournalTableConfigurationProperty

See Also:

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

getAnnotationTableConfiguration

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

The annotation table configuration for an S3 Metadata configuration.

The annotation table tracks all annotations on objects in your bucket so that you can query annotation data at scale. If you've disabled your annotation table configuration and now want to re-enable it, you must first manually delete the old annotation table from your AWS managed table bucket. Otherwise, the newly re-enabled annotation table configuration will enter a failed state because the annotation table already exists in the table bucket.

Returns union: either IResolvable or CfnBucket.AnnotationTableConfigurationProperty

See Also:

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

getDestination

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

The destination information for the S3 Metadata configuration.

Returns union: either IResolvable or CfnBucket.MetadataDestinationProperty

See Also:

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

getInventoryTableConfiguration

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

The inventory table configuration for a metadata configuration.

Returns union: either IResolvable or CfnBucket.InventoryTableConfigurationProperty

See Also:

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

builder

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

Returns:

a CfnBucket.MetadataConfigurationProperty.Builder of CfnBucket.MetadataConfigurationProperty