Class: Aws::CloudDirectory::Types::CreateFacetRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-clouddirectory/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Array<Types::FacetAttribute>

The attributes that are associated with the Facet.

Returns:



2169
2170
2171
2172
2173
2174
2175
2176
2177
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 2169

class CreateFacetRequest < Struct.new(
  :schema_arn,
  :name,
  :attributes,
  :object_type,
  :facet_style)
  SENSITIVE = []
  include Aws::Structure
end

#facet_style ⇒ String

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.

Returns:

  • (String) 


2169
2170
2171
2172
2173
2174
2175
2176
2177
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 2169

class CreateFacetRequest < Struct.new(
  :schema_arn,
  :name,
  :attributes,
  :object_type,
  :facet_style)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 


2169
2170
2171
2172
2173
2174
2175
2176
2177
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 2169

class CreateFacetRequest < Struct.new(
  :schema_arn,
  :name,
  :attributes,
  :object_type,
  :facet_style)
  SENSITIVE = []
  include Aws::Structure
end

#object_type ⇒ String

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.

^

[1]: docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies

Returns:

  • (String) 


2169
2170
2171
2172
2173
2174
2175
2176
2177
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 2169

class CreateFacetRequest < Struct.new(
  :schema_arn,
  :name,
  :attributes,
  :object_type,
  :facet_style)
  SENSITIVE = []
  include Aws::Structure
end

#schema_arn ⇒ String

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

Returns:

  • (String) 


2169
2170
2171
2172
2173
2174
2175
2176
2177
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 2169

class CreateFacetRequest < Struct.new(
  :schema_arn,
  :name,
  :attributes,
  :object_type,
  :facet_style)
  SENSITIVE = []
  include Aws::Structure
end