FacetAttributeDefinition - Amazon Cloud Directory

Amazon Cloud Directory will no longer be open to new customers starting on November 7, 2025. For alternatives to Cloud Directory, explore Amazon DynamoDB and Amazon Neptune. If you need help choosing the right alternative for your use case, or for any other questions, contact AWS Support.

FacetAttributeDefinition

A facet attribute definition. See Attribute References for more information.

Contents

Type

The type of the attribute.

Type: String

Valid Values: STRING | BINARY | BOOLEAN | NUMBER | DATETIME | VARIANT

Required: Yes

DefaultValue

The default value of the attribute (if configured).

Type: TypedAttributeValue object

Required: No

IsImmutable

Whether the attribute is mutable or not.

Type: Boolean

Required: No

Rules

Validation rules attached to the attribute definition.

Type: String to Rule object map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: ^[a-zA-Z0-9._-]*$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: