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

Class: Aws::CloudDirectory::Types::FacetAttribute

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

Overview

Note:

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

{
  name: "AttributeName", # required
  attribute_definition: {
    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",
        },
      },
    },
  },
  attribute_reference: {
    target_facet_name: "FacetName", # required
    target_attribute_name: "AttributeName", # required
  },
  required_behavior: "REQUIRED_ALWAYS", # accepts REQUIRED_ALWAYS, NOT_REQUIRED
}

An attribute that is associated with the Facet.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_definitionTypes::FacetAttributeDefinition

A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.

Returns:

#attribute_referenceTypes::FacetAttributeReference

An attribute reference that is associated with the attribute. See Attribute References for more information.

Returns:

#nameString

The name of the facet attribute.

Returns:

  • (String)

    The name of the facet attribute.

#required_behaviorString

The required behavior of the FacetAttribute.

Possible values:

  • REQUIRED_ALWAYS
  • NOT_REQUIRED

Returns:

  • (String)

    The required behavior of the FacetAttribute.