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

Class: Aws::CloudDirectory::Types::TypedLinkAttributeDefinition

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

Overview

Note:

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

{
  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
}

A typed link attribute definition.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#default_value ⇒ Types::TypedAttributeValue

The default value of the attribute (if configured).

Returns:

#is_immutable ⇒ Boolean

Whether the attribute is mutable or not.

Returns:

  • (Boolean) —

    Whether the attribute is mutable or not.

#name ⇒ String

The unique name of the typed link attribute.

Returns:

  • (String) —

    The unique name of the typed link attribute.

#required_behavior ⇒ String

The required behavior of the TypedLinkAttributeDefinition.

Possible values:

  • REQUIRED_ALWAYS
  • NOT_REQUIRED

Returns:

  • (String) —

    The required behavior of the TypedLinkAttributeDefinition.

#rules ⇒ Hash<String,Types::Rule>

Validation rules that are attached to the attribute definition.

Returns:

  • (Hash<String,Types::Rule>) —

    Validation rules that are attached to the attribute definition.

#type ⇒ String

The type of the attribute.

Possible values:

  • STRING
  • BINARY
  • BOOLEAN
  • NUMBER
  • DATETIME
  • VARIANT

Returns:

  • (String) —

    The type of the attribute.