Package software.amazon.awscdk.services.bedrockagentcore

Interface IMemory

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IGrantable, IMemoryRef, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IMemory.Jsii$Default
All Known Implementing Classes:
IMemory.Jsii$Proxy, Memory, MemoryBase
@Generated(value="jsii-pacmak/1.129.0 (build eaca441)", date="2026-05-19T08:18:44.445Z") @Stability(Stable) public interface IMemory extends software.amazon.jsii.JsiiSerializable, IResource, IGrantable, IMemoryRef
Interface for Memory resources.

  • Method Details

    • getMemoryArn

      @Stability(Stable) @NotNull String getMemoryArn()
      The ARN of the memory resource.

    • getMemoryId

      @Stability(Stable) @NotNull String getMemoryId()
      The id of the memory.

    • getCreatedAt

      @Stability(Stable) @Nullable default String getCreatedAt()
      Timestamp when the memory was created.

    • getExecutionRole

      @Stability(Stable) @Nullable default IRole getExecutionRole()
      The IAM role that provides permissions for the memory to access AWS services.

    • getKmsKey

      @Stability(Stable) @Nullable default IKey getKmsKey()
      Custom KMS key for encryption (if provided).

    • getStatus

      @Stability(Stable) @Nullable default String getStatus()
      The status of the memory.

    • getUpdatedAt

      @Stability(Stable) @Nullable default String getUpdatedAt()
      Timestamp when the memory was last updated.

    • grant

      @Stability(Stable) @NotNull Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      Grant the given principal identity permissions to perform actions on this memory.

      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantAdmin

      @Stability(Stable) @NotNull Grant grantAdmin(@NotNull IGrantable grantee)
      Grant the given principal identity permissions to manage the control plane of this memory.

      Parameters:
      grantee - This parameter is required.

    • grantDelete

      @Stability(Stable) @NotNull Grant grantDelete(@NotNull IGrantable grantee)
      Grant the given principal identity permissions to delete content on this memory.

      Parameters:
      grantee - This parameter is required.

    • grantDeleteLongTermMemory

      @Stability(Stable) @NotNull Grant grantDeleteLongTermMemory(@NotNull IGrantable grantee)
      Grant the given principal identity permissions to delete Long-Term Memory (LTM) content on this memory.

      Parameters:
      grantee - This parameter is required.

    • grantDeleteShortTermMemory

      @Stability(Stable) @NotNull Grant grantDeleteShortTermMemory(@NotNull IGrantable grantee)
      Grant the given principal identity permissions to delete Short-Term Memory (STM) content on this memory.

      Parameters:
      grantee - This parameter is required.

    • grantFullAccess

      @Stability(Stable) @NotNull Grant grantFullAccess(@NotNull IGrantable grantee)
      Grant the given principal identity permissions to do every action on this memory.

      Parameters:
      grantee - This parameter is required.

    • grantRead

      @Stability(Stable) @NotNull Grant grantRead(@NotNull IGrantable grantee)
      Grant the given principal identity permissions to read the contents of this memory.

      Both Short-Term Memory (STM) and Long-Term Memory (LTM).

      Parameters:
      grantee - This parameter is required.

    • grantReadLongTermMemory

      @Stability(Stable) @NotNull Grant grantReadLongTermMemory(@NotNull IGrantable grantee)
      Grant the given principal identity permissions to read the Long-Term Memory (LTM) contents of this memory.

      Parameters:
      grantee - This parameter is required.

    • grantReadShortTermMemory

      @Stability(Stable) @NotNull Grant grantReadShortTermMemory(@NotNull IGrantable grantee)
      Grant the given principal identity permissions to read the Short-Term Memory (STM) contents of this memory.

      Parameters:
      grantee - This parameter is required.

    • grantWrite

      @Stability(Stable) @NotNull Grant grantWrite(@NotNull IGrantable grantee)
      Grant the given principal identity permissions to write content to this memory.

      Parameters:
      grantee - This parameter is required.

    • metric

      @Stability(Stable) @NotNull Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this memory.

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

      @Stability(Stable) @NotNull Metric metric(@NotNull String metricName)
      Return the given named metric for this memory.

      Parameters:
      metricName - This parameter is required.

    • metricErrorsForApiOperation

      @Stability(Stable) @NotNull Metric metricErrorsForApiOperation(@NotNull String operation, @Nullable MetricOptions props)
      Return a metric containing the number of errors for a specific API operation performed on this memory.

      Parameters:
      operation - This parameter is required.
      props -

    • metricErrorsForApiOperation

      @Stability(Stable) @NotNull Metric metricErrorsForApiOperation(@NotNull String operation)
      Return a metric containing the number of errors for a specific API operation performed on this memory.

      Parameters:
      operation - This parameter is required.

    • metricEventCreationCount

      @Stability(Stable) @NotNull Metric metricEventCreationCount(@Nullable MetricOptions props)
      Returns the metric containing the number of created memory events and memory records.

      Parameters:
      props -

    • metricEventCreationCount

      @Stability(Stable) @NotNull Metric metricEventCreationCount()
      Returns the metric containing the number of created memory events and memory records.

    • metricForApiOperation

      @Stability(Stable) @NotNull Metric metricForApiOperation(@NotNull String metricName, @NotNull String operation, @Nullable MetricOptions props)
      Return the given named metric related to the API operation performed on this memory.

      Parameters:
      metricName - This parameter is required.
      operation - This parameter is required.
      props -

    • metricForApiOperation

      @Stability(Stable) @NotNull Metric metricForApiOperation(@NotNull String metricName, @NotNull String operation)
      Return the given named metric related to the API operation performed on this memory.

      Parameters:
      metricName - This parameter is required.
      operation - This parameter is required.

    • metricInvocationsForApiOperation

      @Stability(Stable) @NotNull Metric metricInvocationsForApiOperation(@NotNull String operation, @Nullable MetricOptions props)
      Return a metric containing the total number of API requests made for a specific memory operation.

      Parameters:
      operation - This parameter is required.
      props -

    • metricInvocationsForApiOperation

      @Stability(Stable) @NotNull Metric metricInvocationsForApiOperation(@NotNull String operation)
      Return a metric containing the total number of API requests made for a specific memory operation.

      Parameters:
      operation - This parameter is required.

    • metricLatencyForApiOperation

      @Stability(Stable) @NotNull Metric metricLatencyForApiOperation(@NotNull String operation, @Nullable MetricOptions props)
      Return a metric measuring the latency of a specific API operation performed on this memory.

      Parameters:
      operation - This parameter is required.
      props -

    • metricLatencyForApiOperation

      @Stability(Stable) @NotNull Metric metricLatencyForApiOperation(@NotNull String operation)
      Return a metric measuring the latency of a specific API operation performed on this memory.

      Parameters:
      operation - This parameter is required.