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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb

Overview

Note:

When making an API call, you may pass FacetAttributeDefinition data as a hash:

{
  type: "STRING", # required, accepts STRING, BINARY, BOOLEAN, NUMBER, DATETIME, VARIANT
  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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_valueTypes::TypedAttributeValue

The default value of the attribute (if configured).



4782
4783
4784
4785
4786
4787
4788
4789
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4782

class FacetAttributeDefinition < Struct.new(
  :type,
  :default_value,
  :is_immutable,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end

#is_immutableBoolean

Whether the attribute is mutable or not.

Returns:

  • (Boolean)


4782
4783
4784
4785
4786
4787
4788
4789
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4782

class FacetAttributeDefinition < Struct.new(
  :type,
  :default_value,
  :is_immutable,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end

#rulesHash<String,Types::Rule>

Validation rules attached to the attribute definition.

Returns:



4782
4783
4784
4785
4786
4787
4788
4789
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4782

class FacetAttributeDefinition < Struct.new(
  :type,
  :default_value,
  :is_immutable,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of the attribute.

Returns:

  • (String)


4782
4783
4784
4785
4786
4787
4788
4789
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4782

class FacetAttributeDefinition < Struct.new(
  :type,
  :default_value,
  :is_immutable,
  :rules)
  SENSITIVE = []
  include Aws::Structure
end