Package software.amazon.awscdk.cfnpropertymixins.services.s3

Interface CfnBucketPropsMixin.AnnotationTableConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucketPropsMixin.AnnotationTableConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBucketPropsMixin

@Stability(Stable)
public static interface CfnBucketPropsMixin.AnnotationTableConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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.

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.s3.*;
 AnnotationTableConfigurationProperty annotationTableConfigurationProperty = AnnotationTableConfigurationProperty.builder()
         .configurationState("configurationState")
         .encryptionConfiguration(MetadataTableEncryptionConfigurationProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .sseAlgorithm("sseAlgorithm")
                 .build())
         .role("role")
         .tableArn("tableArn")
         .tableName("tableName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBucketPropsMixin.AnnotationTableConfigurationProperty.Builder	builder()
default String	getConfigurationState()	Specifies whether the annotation table configuration is enabled or disabled.
default Object	getEncryptionConfiguration()	The encryption settings for an S3 Metadata journal table or inventory table configuration.
default String	getRole()	The ARN of the IAM role that grants Amazon S3 Metadata permission to read annotations from your bucket.
default String	getTableArn()	The Amazon Resource Name (ARN) for the annotation table.
default String	getTableName()	The name of the annotation table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigurationState

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

Specifies whether the annotation table configuration is enabled or disabled.

See Also:

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

getEncryptionConfiguration

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

The encryption settings for an S3 Metadata journal table or inventory table configuration.

Returns union: either IResolvable or CfnBucketPropsMixin.MetadataTableEncryptionConfigurationProperty

See Also:

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

getRole

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

The ARN of the IAM role that grants Amazon S3 Metadata permission to read annotations from your bucket.

See Also:

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

getTableArn

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

The Amazon Resource Name (ARN) for the annotation table.

See Also:

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

getTableName

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

The name of the annotation table.

See Also:

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

builder

@Stability(Stable)
static CfnBucketPropsMixin.AnnotationTableConfigurationProperty.Builder builder()

Returns:

a CfnBucketPropsMixin.AnnotationTableConfigurationProperty.Builder of CfnBucketPropsMixin.AnnotationTableConfigurationProperty