You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudDirectory::Types::FacetAttributeDefinition

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing FacetAttributeDefinition as input to an Aws::Client method, you can use a vanilla Hash:

{
  type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME
  default_value: {
    string_value: "StringAttributeValue",
    binary_value: "data",
    boolean_value: false,
    number_value: "NumberAttributeValue",
    datetime_value: Time.now,
  },
  is_immutable: false,
  rules: {
    "RuleKey" => {
      type: "BINARY_LENGTH", # accepts BINARY_LENGTH, NUMBER_COMPARISON, STRING_FROM_SET, STRING_LENGTH
      parameters: {
        "RuleParameterKey" => "RuleParameterValue",
      },
    },
  },
}

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#default_valueTypes::TypedAttributeValue

The default value of the attribute (if configured).

Returns:

#is_immutableBoolean

Whether the attribute is mutable or not.

Returns:

  • (Boolean)

    Whether the attribute is mutable or not.

#rulesHash<String,Types::Rule>

Validation rules attached to the attribute definition.

Returns:

  • (Hash<String,Types::Rule>)

    Validation rules attached to the attribute definition.

#typeString

The type of the attribute.

Possible values:

  • STRING
  • BINARY
  • BOOLEAN
  • NUMBER
  • DATETIME

Returns:

  • (String)

    The type of the attribute.