Class: Aws::CloudDirectory::Types::TypedLinkFacet
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudDirectory::Types::TypedLinkFacet
- Defined in:
- gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb
Overview
When making an API call, you may pass TypedLinkFacet data as a hash:
{
name: "TypedLinkName", # required
attributes: [ # required
{
name: "AttributeName", # required
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",
},
},
},
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#attributes ⇒ Array<Types::TypedLinkAttributeDefinition>
A set of key-value pairs associated with the typed link.
-
#identity_attribute_order ⇒ Array<String>
The set of attributes that distinguish links made from this facet from each other, in the order of significance.
-
#name ⇒ String
The unique name of the typed link facet.
Instance Attribute Details
#attributes ⇒ Array<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.
7868 7869 7870 7871 7872 7873 7874 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 7868 class TypedLinkFacet < Struct.new( :name, :attributes, :identity_attribute_order) SENSITIVE = [] include Aws::Structure end |
#identity_attribute_order ⇒ Array<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.
7868 7869 7870 7871 7872 7873 7874 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 7868 class TypedLinkFacet < Struct.new( :name, :attributes, :identity_attribute_order) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The unique name of the typed link facet.
7868 7869 7870 7871 7872 7873 7874 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 7868 class TypedLinkFacet < Struct.new( :name, :attributes, :identity_attribute_order) SENSITIVE = [] include Aws::Structure end |