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

Class: Aws::CloudDirectory::Types::UpdateTypedLinkFacetRequest

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

{
  schema_arn: "Arn", # required
  name: "TypedLinkName", # required
  attribute_updates: [ # required
    {
      attribute: { # 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
      },
      action: "CREATE_OR_UPDATE", # required, accepts CREATE_OR_UPDATE, DELETE
    },
  ],
  identity_attribute_order: ["AttributeName"], # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_updatesArray<Types::TypedLinkFacetAttributeUpdate>

Attributes update structure.



6821
6822
6823
6824
6825
6826
6827
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 6821

class UpdateTypedLinkFacetRequest < Struct.new(
  :schema_arn,
  :name,
  :attribute_updates,
  :identity_attribute_order)
  include Aws::Structure
end

#identity_attribute_orderArray<String>

The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed link.

Returns:

  • (Array<String>)


6821
6822
6823
6824
6825
6826
6827
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 6821

class UpdateTypedLinkFacetRequest < Struct.new(
  :schema_arn,
  :name,
  :attribute_updates,
  :identity_attribute_order)
  include Aws::Structure
end

#nameString

The unique name of the typed link facet.

Returns:

  • (String)


6821
6822
6823
6824
6825
6826
6827
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 6821

class UpdateTypedLinkFacetRequest < Struct.new(
  :schema_arn,
  :name,
  :attribute_updates,
  :identity_attribute_order)
  include Aws::Structure
end

#schema_arnString

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Returns:

  • (String)


6821
6822
6823
6824
6825
6826
6827
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 6821

class UpdateTypedLinkFacetRequest < Struct.new(
  :schema_arn,
  :name,
  :attribute_updates,
  :identity_attribute_order)
  include Aws::Structure
end