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

Class: Aws::Kendra::Types::Principal

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Principal as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "PrincipalName", # required
  type: "USER", # required, accepts USER, GROUP
  access: "ALLOW", # required, accepts ALLOW, DENY
}

Provides user and group information for document access filtering.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access ⇒ String

Whether to allow or deny access to the principal.

Possible values:

  • ALLOW
  • DENY

Returns:

  • (String) —

    Whether to allow or deny access to the principal.

#name ⇒ String

The name of the user or group.

Returns:

  • (String) —

    The name of the user or group.

#type ⇒ String

The type of principal.

Possible values:

  • USER
  • GROUP

Returns:

  • (String) —

    The type of principal.