Package software.amazon.awscdk.services.bedrockagentcore

Interface IGateway.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IGateway, IGatewayRef, IGatewayRef.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IGateway.Jsii$Proxy
Enclosing interface:
IGateway
@Internal public static interface IGateway.Jsii$Default extends IGateway, IResource.Jsii$Default, IGatewayRef.Jsii$Default
Internal default implementation for IGateway.

  • Method Details

    • getAuthorizerConfiguration

      @Stability(Stable) @NotNull default IGatewayAuthorizerConfig getAuthorizerConfiguration()
      The authorizer configuration for the gateway.
      Specified by:
      getAuthorizerConfiguration in interface IGateway

    • getGatewayArn

      @Stability(Stable) @NotNull default String getGatewayArn()
      The ARN of the gateway resource.
      Specified by:
      getGatewayArn in interface IGateway

    • getGatewayId

      @Stability(Stable) @NotNull default String getGatewayId()
      The id of the gateway.
      Specified by:
      getGatewayId in interface IGateway

    • getGatewayName

      @Stability(Stable) @NotNull default String getGatewayName()
      The name of the gateway.
      Specified by:
      getGatewayName in interface IGateway

    • getProtocolConfiguration

      @Stability(Stable) @NotNull default IGatewayProtocolConfig getProtocolConfiguration()
      The protocol configuration for the gateway.
      Specified by:
      getProtocolConfiguration in interface IGateway

    • getRole

      @Stability(Stable) @NotNull default IRole getRole()
      The IAM role that provides permissions for the gateway to access AWS services.
      Specified by:
      getRole in interface IGateway

    • getCreatedAt

      @Stability(Stable) @Nullable default String getCreatedAt()
      Timestamp when the gateway was created.
      Specified by:
      getCreatedAt in interface IGateway

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the gateway.
      Specified by:
      getDescription in interface IGateway

    • getExceptionLevel

      @Stability(Stable) @Nullable default GatewayExceptionLevel getExceptionLevel()
      The exception level for the gateway.
      Specified by:
      getExceptionLevel in interface IGateway

    • getGatewayUrl

      @Stability(Stable) @Nullable default String getGatewayUrl()
      The URL endpoint for the gateway.
      Specified by:
      getGatewayUrl in interface IGateway

    • getKmsKey

      @Stability(Stable) @Nullable default IKey getKmsKey()
      The KMS key used for encryption.
      Specified by:
      getKmsKey in interface IGateway

    • getStatus

      @Stability(Stable) @Nullable default String getStatus()
      The status of the gateway.
      Specified by:
      getStatus in interface IGateway

    • getStatusReason

      @Stability(Stable) @Nullable default List<String> getStatusReason()
      The status reasons for the gateway.
      Specified by:
      getStatusReason in interface IGateway

    • getUpdatedAt

      @Stability(Stable) @Nullable default String getUpdatedAt()
      Timestamp when the gateway was last updated.
      Specified by:
      getUpdatedAt in interface IGateway

    • grant

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

      Specified by:
      grant in interface IGateway
      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantInvoke

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

      Specified by:
      grantInvoke in interface IGateway
      Parameters:
      grantee - This parameter is required.

    • grantManage

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

      Specified by:
      grantManage in interface IGateway
      Parameters:
      grantee - This parameter is required.

    • grantRead

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

      Specified by:
      grantRead in interface IGateway
      Parameters:
      grantee - This parameter is required.

    • metric

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

      Specified by:
      metric in interface IGateway
      Parameters:
      metricName - The name of the metric. This parameter is required.
      props - Optional metric configuration.

    • metric

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

      Specified by:
      metric in interface IGateway
      Parameters:
      metricName - The name of the metric. This parameter is required.

    • metricDuration

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricDuration in interface IGateway
      Parameters:
      props - Optional metric configuration.

    • metricDuration

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricDuration in interface IGateway

    • metricInvocations

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricInvocations in interface IGateway
      Parameters:
      props - Optional metric configuration.

    • metricInvocations

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricInvocations in interface IGateway

    • metricLatency

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricLatency in interface IGateway
      Parameters:
      props - Optional metric configuration.

    • metricLatency

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricLatency in interface IGateway

    • metricSystemErrors

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricSystemErrors in interface IGateway
      Parameters:
      props - Optional metric configuration.

    • metricSystemErrors

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricSystemErrors in interface IGateway

    • metricTargetExecutionTime

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricTargetExecutionTime in interface IGateway
      Parameters:
      props - Optional metric configuration.

    • metricTargetExecutionTime

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricTargetExecutionTime in interface IGateway

    • metricTargetType

      @Stability(Stable) @NotNull default 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

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

    • metricTargetType

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricTargetType in interface IGateway
      Parameters:
      targetType - The type of target (e.g., 'Lambda', 'OpenAPI', 'Smithy'). This parameter is required.

    • metricThrottles

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricThrottles in interface IGateway
      Parameters:
      props - Optional metric configuration.

    • metricThrottles

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricThrottles in interface IGateway

    • metricUserErrors

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricUserErrors in interface IGateway
      Parameters:
      props - Optional metric configuration.

    • metricUserErrors

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricUserErrors in interface IGateway