Package software.amazon.awscdk.services.bedrockagentcore

Interface IGateway

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

  • Method Details

    • getAuthorizerConfiguration

      @Stability(Stable) @NotNull IGatewayAuthorizerConfig getAuthorizerConfiguration()
      The authorizer configuration for the gateway.

    • getGatewayArn

      @Stability(Stable) @NotNull String getGatewayArn()
      The ARN of the gateway resource.

    • getGatewayId

      @Stability(Stable) @NotNull String getGatewayId()
      The id of the gateway.

    • getGatewayName

      @Stability(Stable) @NotNull String getGatewayName()
      The name of the gateway.

    • getProtocolConfiguration

      @Stability(Stable) @NotNull IGatewayProtocolConfig getProtocolConfiguration()
      The protocol configuration for the gateway.

    • getRole

      @Stability(Stable) @NotNull IRole getRole()
      The IAM role that provides permissions for the gateway to access AWS services.

    • getCreatedAt

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

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the gateway.

    • getExceptionLevel

      @Stability(Stable) @Nullable default GatewayExceptionLevel getExceptionLevel()
      The exception level for the gateway.

    • getGatewayUrl

      @Stability(Stable) @Nullable default String getGatewayUrl()
      The URL endpoint for the gateway.

    • getKmsKey

      @Stability(Stable) @Nullable default IKey getKmsKey()
      The KMS key used for encryption.

    • getStatus

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

    • getStatusReason

      @Stability(Stable) @Nullable default List<String> getStatusReason()
      The status reasons for the gateway.

    • getUpdatedAt

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

    • grant

      @Stability(Stable) @NotNull Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      Grants IAM actions to the IAM Principal.

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

    • grantInvoke

      @Stability(Stable) @NotNull Grant grantInvoke(@NotNull IGrantable grantee)
      Grants permission to invoke this Gateway.

      Parameters:
      grantee - This parameter is required.

    • grantManage

      @Stability(Stable) @NotNull Grant grantManage(@NotNull IGrantable grantee)
      Grants Create, Update, and Delete actions on the Gateway.

      Parameters:
      grantee - This parameter is required.

    • grantRead

      @Stability(Stable) @NotNull Grant grantRead(@NotNull IGrantable grantee)
      Grants Get and List actions on the Gateway.

      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 gateway.

      Parameters:
      metricName - The name of the metric. This parameter is required.
      props - Optional metric configuration.

    • metric

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

      Parameters:
      metricName - The name of the metric. This parameter is required.

    • metricDuration

      @Stability(Stable) @NotNull Metric metricDuration(@Nullable MetricOptions props)
      Return a metric measuring the duration of requests for this gateway.

      The duration metric represents the total time elapsed between receiving the request and sending the final response token, representing complete end-to-end processing time.

      Default: - Average statistic over 5 minutes

      Parameters:
      props - Optional metric configuration.

    • metricDuration

      @Stability(Stable) @NotNull Metric metricDuration()
      Return a metric measuring the duration of requests for this gateway.

      The duration metric represents the total time elapsed between receiving the request and sending the final response token, representing complete end-to-end processing time.

      Default: - Average statistic over 5 minutes

    • metricInvocations

      @Stability(Stable) @NotNull Metric metricInvocations(@Nullable MetricOptions props)
      Return a metric containing the total number of invocations for this gateway.

      This metric tracks all successful invocations of the gateway.

      Default: - Sum statistic over 5 minutes

      Parameters:
      props - Optional metric configuration.

    • metricInvocations

      @Stability(Stable) @NotNull Metric metricInvocations()
      Return a metric containing the total number of invocations for this gateway.

      This metric tracks all successful invocations of the gateway.

      Default: - Sum statistic over 5 minutes

    • metricLatency

      @Stability(Stable) @NotNull Metric metricLatency(@Nullable MetricOptions props)
      Return a metric measuring the latency of requests for this gateway.

      The latency metric represents the time elapsed between when the service receives the request and when it begins sending the first response token.

      Default: - Average statistic over 5 minutes

      Parameters:
      props - Optional metric configuration.

    • metricLatency

      @Stability(Stable) @NotNull Metric metricLatency()
      Return a metric measuring the latency of requests for this gateway.

      The latency metric represents the time elapsed between when the service receives the request and when it begins sending the first response token.

      Default: - Average statistic over 5 minutes

    • metricSystemErrors

      @Stability(Stable) @NotNull Metric metricSystemErrors(@Nullable MetricOptions props)
      Return a metric containing the number of system errors (5xx status code) for this gateway.

      This metric tracks internal server errors and system failures.

      Default: - Sum statistic over 5 minutes

      Parameters:
      props - Optional metric configuration.

    • metricSystemErrors

      @Stability(Stable) @NotNull Metric metricSystemErrors()
      Return a metric containing the number of system errors (5xx status code) for this gateway.

      This metric tracks internal server errors and system failures.

      Default: - Sum statistic over 5 minutes

    • metricTargetExecutionTime

      @Stability(Stable) @NotNull Metric metricTargetExecutionTime(@Nullable MetricOptions props)
      Return a metric measuring the target execution time for this gateway.

      This metric helps determine the contribution of the target (Lambda, OpenAPI, etc.) to the total latency.

      Default: - Average statistic over 5 minutes

      Parameters:
      props - Optional metric configuration.

    • metricTargetExecutionTime

      @Stability(Stable) @NotNull Metric metricTargetExecutionTime()
      Return a metric measuring the target execution time for this gateway.

      This metric helps determine the contribution of the target (Lambda, OpenAPI, etc.) to the total latency.

      Default: - Average statistic over 5 minutes

    • metricTargetType

      @Stability(Stable) @NotNull Metric metricTargetType(@NotNull String targetType, @Nullable MetricOptions props)
      Return a metric containing the number of requests served by each target type for this gateway.

      Default: - Sum statistic over 5 minutes

      Parameters:
      targetType - The type of target (e.g., 'Lambda', 'OpenAPI', 'Smithy'). This parameter is required.
      props - Optional metric configuration.

    • metricTargetType

      @Stability(Stable) @NotNull Metric metricTargetType(@NotNull String targetType)
      Return a metric containing the number of requests served by each target type for this gateway.

      Default: - Sum statistic over 5 minutes

      Parameters:
      targetType - The type of target (e.g., 'Lambda', 'OpenAPI', 'Smithy'). This parameter is required.

    • metricThrottles

      @Stability(Stable) @NotNull Metric metricThrottles(@Nullable MetricOptions props)
      Return a metric containing the number of throttled requests (429 status code) for this gateway.

      This metric helps identify when the gateway is rate limiting requests.

      Default: - Sum statistic over 5 minutes

      Parameters:
      props - Optional metric configuration.

    • metricThrottles

      @Stability(Stable) @NotNull Metric metricThrottles()
      Return a metric containing the number of throttled requests (429 status code) for this gateway.

      This metric helps identify when the gateway is rate limiting requests.

      Default: - Sum statistic over 5 minutes

    • metricUserErrors

      @Stability(Stable) @NotNull Metric metricUserErrors(@Nullable MetricOptions props)
      Return a metric containing the number of user errors (4xx status code, excluding 429) for this gateway.

      This metric tracks client errors like bad requests, unauthorized access, etc.

      Default: - Sum statistic over 5 minutes

      Parameters:
      props - Optional metric configuration.

    • metricUserErrors

      @Stability(Stable) @NotNull Metric metricUserErrors()
      Return a metric containing the number of user errors (4xx status code, excluding 429) for this gateway.

      This metric tracks client errors like bad requests, unauthorized access, etc.

      Default: - Sum statistic over 5 minutes