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

Class: Aws::CloudDirectory::Types::UpdateFacetRequest

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

{
  schema_arn: "Arn", # required
  name: "FacetName", # required
  attribute_updates: [
    {
      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
    },
  ],
  object_type: "NODE", # accepts NODE, LEAF_NODE, POLICY, INDEX
}

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_updatesArray<Types::FacetAttributeUpdate>

List of attributes that need to be updated in a given schema Facet. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform.

Returns:



6643
6644
6645
6646
6647
6648
6649
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 6643

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

#nameString

The name of the facet.

Returns:

  • (String)


6643
6644
6645
6646
6647
6648
6649
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 6643

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

#object_typeString

The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

Returns:

  • (String)


6643
6644
6645
6646
6647
6648
6649
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 6643

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

#schema_arnString

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

Returns:

  • (String)


6643
6644
6645
6646
6647
6648
6649
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 6643

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