interface AnnotationTableConfigurationProperty

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.S3.CfnBucketPropsMixin.AnnotationTableConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awss3#CfnBucketPropsMixin_AnnotationTableConfigurationProperty
Java	software.amazon.awscdk.cfnpropertymixins.services.s3.CfnBucketPropsMixin.AnnotationTableConfigurationProperty
Python	aws_cdk.cfn_property_mixins.aws_s3.CfnBucketPropsMixin.AnnotationTableConfigurationProperty
TypeScript	@aws-cdk/cfn-property-mixins » aws_s3 » CfnBucketPropsMixin » AnnotationTableConfigurationProperty

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3 as s3 } from '@aws-cdk/cfn-property-mixins';
const annotationTableConfigurationProperty: s3.CfnBucketPropsMixin.AnnotationTableConfigurationProperty = {
  configurationState: 'configurationState',
  encryptionConfiguration: {
    kmsKeyArn: 'kmsKeyArn',
    sseAlgorithm: 'sseAlgorithm',
  },
  role: 'role',
  tableArn: 'tableArn',
  tableName: 'tableName',
};

Properties

Name	Type	Description
configurationState?	string	Specifies whether the annotation table configuration is enabled or disabled.
encryptionConfiguration?	IResolvable | MetadataTableEncryptionConfigurationProperty	The encryption settings for an S3 Metadata journal table or inventory table configuration.
role?	string	The ARN of the IAM role that grants Amazon S3 Metadata permission to read annotations from your bucket.
tableArn?	string	The Amazon Resource Name (ARN) for the annotation table.
tableName?	string	The name of the annotation table.

---

configurationState?

Type: string (optional)

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

---

encryptionConfiguration?

Type: IResolvable | MetadataTableEncryptionConfigurationProperty (optional)

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

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

---

role?

Type: string (optional)

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

---

tableArn?

Type: string (optional)

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

---

tableName?

Type: string (optional)

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