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

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 FacetAttribute data as a hash:

{
  name: "AttributeName", # required
  attribute_definition: {
    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",
        },
      },
    },
  },
  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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_definition ⇒ Types::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:



4725
4726
4727
4728
4729
4730
4731
4732
 
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4725

class FacetAttribute < Struct.new(
  :name,
  :attribute_definition,
  :attribute_reference,
  :required_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_reference ⇒ Types::FacetAttributeReference

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

Returns:



4725
4726
4727
4728
4729
4730
4731
4732
 
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4725

class FacetAttribute < Struct.new(
  :name,
  :attribute_definition,
  :attribute_reference,
  :required_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the facet attribute.

Returns:

  • (String) 


4725
4726
4727
4728
4729
4730
4731
4732
 
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4725

class FacetAttribute < Struct.new(
  :name,
  :attribute_definition,
  :attribute_reference,
  :required_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#required_behavior ⇒ String

The required behavior of the FacetAttribute.

Returns:

  • (String) 


4725
4726
4727
4728
4729
4730
4731
4732
 
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4725

class FacetAttribute < Struct.new(
  :name,
  :attribute_definition,
  :attribute_reference,
  :required_behavior)
  SENSITIVE = []
  include Aws::Structure
end