Interface CfnBucket.AnnotationTableConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnBucket.AnnotationTableConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnBucket
@Stability(Stable)
public static interface CfnBucket.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.services.s3.*;
AnnotationTableConfigurationProperty annotationTableConfigurationProperty = 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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnBucket.AnnotationTableConfigurationPropertystatic final classAn implementation forCfnBucket.AnnotationTableConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Specifies whether the annotation table configuration is enabled or disabled.default ObjectThe encryption settings for an S3 Metadata journal table or inventory table configuration.default StringgetRole()The ARN of the IAM role that grants Amazon S3 Metadata permission to read annotations from your bucket.default StringThe Amazon Resource Name (ARN) for the annotation table.default StringThe name of the annotation table.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getConfigurationState
Specifies whether the annotation table configuration is enabled or disabled.- See Also:
-
getEncryptionConfiguration
The encryption settings for an S3 Metadata journal table or inventory table configuration.Returns union: either
IResolvableorCfnBucket.MetadataTableEncryptionConfigurationProperty- See Also:
-
getRole
The ARN of the IAM role that grants Amazon S3 Metadata permission to read annotations from your bucket.- See Also:
-
getTableArn
The Amazon Resource Name (ARN) for the annotation table.- See Also:
-
getTableName
The name of the annotation table.- See Also:
-
builder
-