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

Class: Aws::CloudDirectory::Types::FacetAttributeUpdate

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

Overview

Note:

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

{
  attribute: {
    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
  },
  action: "CREATE_OR_UPDATE", # accepts CREATE_OR_UPDATE, DELETE
}

A structure that contains information used to update an attribute.

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The action to perform when updating the attribute.

Possible values:

  • CREATE_OR_UPDATE
  • DELETE

Returns:

  • (String)

    The action to perform when updating the attribute.

#attributeTypes::FacetAttribute

The attribute to update.

Returns: