Skip to content

CreateFacetRequest

Source code in docs_src/capo_clouddirectory/types/create_facet_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class CreateFacetRequest(TypedDict, closed=True):
    schema_arn: "capo_clouddirectory.types.arn.Arn"
    """<p>The schema ARN in which the new <a>Facet</a> will be created. For more information, see <a>arns</a>.</p>"""
    name: "capo_clouddirectory.types.facet_name.FacetName"
    """<p>The name of the <a>Facet</a>, which is unique for a given schema.</p>"""
    attributes: NotRequired[
        "capo_clouddirectory.types.facet_attribute_list.FacetAttributeList"
    ]
    """<p>The attributes that are associated with the <a>Facet</a>.</p>"""
    object_type: NotRequired["capo_clouddirectory.types.object_type.ObjectType"]
    """<p>Specifies whether a given object created from this facet is of type node, leaf node, policy or index.</p> <ul> <li> <p>Node: Can have multiple children but one parent.</p> </li> </ul> <ul> <li> <p>Leaf node: Cannot have children but can have multiple parents.</p> </li> </ul> <ul> <li> <p>Policy: Allows you to store a policy document and policy type. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies">Policies</a>.</p> </li> </ul> <ul> <li> <p>Index: Can be created with the Index API.</p> </li> </ul>"""
    facet_style: NotRequired["capo_clouddirectory.types.facet_style.FacetStyle"]
    """<p>There are two different styles that you can define on any given facet, <code>Static</code> and <code>Dynamic</code>. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.</p>"""

attributes instance-attribute 

attributes: NotRequired[FacetAttributeList]

The attributes that are associated with the Facet.

facet_style instance-attribute 

facet_style: NotRequired[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.

name instance-attribute 

name: FacetName

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

object_type instance-attribute 

object_type: NotRequired[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.

schema_arn instance-attribute 

schema_arn: Arn

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