Package software.amazon.awscdk.services.kendra

Class CfnIndexProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.kendra.CfnIndexProps.Jsii$Proxy
All Implemented Interfaces:
CfnIndexProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnIndexProps
@Stability(Stable) @Internal public static final class CfnIndexProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnIndexProps
An implementation for CfnIndexProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnIndexProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnIndexProps.Builder.

  • Method Details

    • getEdition

      public final String getEdition()
      Description copied from interface: CfnIndexProps
      Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

      Valid values are DEVELOPER_EDITION and ENTERPRISE_EDITION .

      Specified by:
      getEdition in interface CfnIndexProps

    • getName

      public final String getName()
      Description copied from interface: CfnIndexProps
      The name of the index.
      Specified by:
      getName in interface CfnIndexProps

    • getRoleArn

      public final String getRoleArn()
      Description copied from interface: CfnIndexProps
      An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.

      This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

      Specified by:
      getRoleArn in interface CfnIndexProps

    • getCapacityUnits

      public final Object getCapacityUnits()
      Description copied from interface: CfnIndexProps
      AWS::Kendra::Index.CapacityUnits.
      Specified by:
      getCapacityUnits in interface CfnIndexProps

    • getDescription

      public final String getDescription()
      Description copied from interface: CfnIndexProps
      A description for the index.
      Specified by:
      getDescription in interface CfnIndexProps

    • getDocumentMetadataConfigurations

      public final Object getDocumentMetadataConfigurations()
      Description copied from interface: CfnIndexProps
      Specifies the properties of an index field.

      You can add either a custom or a built-in field. You can add and remove built-in fields at any time. When a built-in field is removed it's configuration reverts to the default for the field. Custom fields can't be removed from an index after they are added.

      Specified by:
      getDocumentMetadataConfigurations in interface CfnIndexProps

    • getServerSideEncryptionConfiguration

      public final Object getServerSideEncryptionConfiguration()
      Description copied from interface: CfnIndexProps
      The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.

      Amazon Kendra doesn't support asymmetric CMKs.

      Specified by:
      getServerSideEncryptionConfiguration in interface CfnIndexProps

    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnIndexProps
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

      Specified by:
      getTags in interface CfnIndexProps

    • getUserContextPolicy

      public final String getUserContextPolicy()
      Description copied from interface: CfnIndexProps
      The user context policy.

      ATTRIBUTE_FILTER

      • All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext .

      USER_TOKEN

      • Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
      Specified by:
      getUserContextPolicy in interface CfnIndexProps

    • getUserTokenConfigurations

      public final Object getUserTokenConfigurations()
      Description copied from interface: CfnIndexProps
      Defines the type of user token used for the index.
      Specified by:
      getUserTokenConfigurations in interface CfnIndexProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object