Create Facet

clouddirectory_create_facet

R Documentation

Description¶

Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

Usage¶

clouddirectory_create_facet(SchemaArn, Name, Attributes, ObjectType,
  FacetStyle)

Arguments¶

SchemaArn

[required] The schema ARN in which the new Facet will be created. For more information, see arns.

Name

[required] The name of the Facet, which is unique for a given schema.

Attributes

The attributes that are associated with the Facet.

ObjectType

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

Node: Can have multiple children but one parent.
Leaf node: Cannot have children but can have multiple parents.
Policy: Allows you to store a policy document and policy type. For more information, see Policies.
Index: Can be created with the Index API.

FacetStyle

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

Value¶

An empty list.

Request syntax¶

svc$create_facet(
  SchemaArn = "string",
  Name = "string",
  Attributes = list(
    list(
      Name = "string",
      AttributeDefinition = list(
        Type = "STRING"|"BINARY"|"BOOLEAN"|"NUMBER"|"DATETIME"|"VARIANT",
        DefaultValue = list(
          StringValue = "string",
          BinaryValue = raw,
          BooleanValue = TRUE|FALSE,
          NumberValue = "string",
          DatetimeValue = as.POSIXct(
            "2015-01-01"
          )
        ),
        IsImmutable = TRUE|FALSE,
        Rules = list(
          list(
            Type = "BINARY_LENGTH"|"NUMBER_COMPARISON"|"STRING_FROM_SET"|"STRING_LENGTH",
            Parameters = list(
              "string"
            )
          )
        )
      ),
      AttributeReference = list(
        TargetFacetName = "string",
        TargetAttributeName = "string"
      ),
      RequiredBehavior = "REQUIRED_ALWAYS"|"NOT_REQUIRED"
    )
  ),
  ObjectType = "NODE"|"LEAF_NODE"|"POLICY"|"INDEX",
  FacetStyle = "STATIC"|"DYNAMIC"
)