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

Class: Aws::CloudDirectory::Types::TypedLinkFacet

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

Overview

Note:

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

{
  name: "TypedLinkName", # required
  attributes: [ # required
    {
      name: "AttributeName", # required
      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",
          },
        },
      },
      required_behavior: "REQUIRED_ALWAYS", # required, accepts REQUIRED_ALWAYS, NOT_REQUIRED
    },
  ],
  identity_attribute_order: ["AttributeName"], # required
}

Defines the typed links structure and its attributes. To create a typed link facet, use the CreateTypedLinkFacet API.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#attributesArray<Types::TypedLinkAttributeDefinition>

A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

Returns:

#identity_attribute_orderArray<String>

The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

Returns:

  • (Array<String>)

    The set of attributes that distinguish links made from this facet from each other, in the order of significance.

#nameString

The unique name of the typed link facet.

Returns:

  • (String)

    The unique name of the typed link facet.