Package software.amazon.awscdk.services.bedrockagentcore

Class GatewayBase

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.bedrockagentcore.GatewayBase
All Implemented Interfaces:
IGatewayRef, IEnvironmentAware, IResource, IGateway, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
Direct Known Subclasses:
Gateway
@Generated(value="jsii-pacmak/1.129.0 (build eaca441)", date="2026-05-19T08:18:44.407Z") @Stability(Stable) public abstract class GatewayBase extends Resource implements IGateway
**************************************************************************** Base Class ***************************************************************************.

  • Constructor Details

    • GatewayBase

      protected GatewayBase(software.amazon.jsii.JsiiObjectRef objRef)

    • GatewayBase

      protected GatewayBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • GatewayBase

      @Stability(Stable) protected GatewayBase(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ResourceProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props -

    • GatewayBase

      @Stability(Stable) protected GatewayBase(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.

  • Method Details

    • grant

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

      [disable-awslint:no-grants]

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

    • grantInvoke

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

      [disable-awslint:no-grants]

      Specified by:
      grantInvoke in interface IGateway
      Parameters:
      grantee - The principal to grant invoke permissions to. This parameter is required.

    • grantManage

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

      [disable-awslint:no-grants]

      Specified by:
      grantManage in interface IGateway
      Parameters:
      grantee - The principal to grant manage permissions to. This parameter is required.

    • grantRead

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

      [disable-awslint:no-grants]

      Specified by:
      grantRead in interface IGateway
      Parameters:
      grantee - The principal to grant read permissions to. This parameter is required.

    • metric

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

      By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

      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 public Metric metric(@NotNull String metricName)
      Return the given named metric for this gateway.

      By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

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

    • metricDuration

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

      Specified by:
      metricDuration in interface IGateway
      Parameters:
      props -

    • metricDuration

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

      Specified by:
      metricDuration in interface IGateway

    • metricInvocations

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

      Specified by:
      metricInvocations in interface IGateway
      Parameters:
      props -

    • metricInvocations

      @Stability(Stable) @NotNull public Metric metricInvocations()
      Return a metric containing the total number of invocations for this gateway.
      Specified by:
      metricInvocations in interface IGateway

    • metricLatency

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

      Specified by:
      metricLatency in interface IGateway
      Parameters:
      props -

    • metricLatency

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

      Specified by:
      metricLatency in interface IGateway

    • metricSystemErrors

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

      Specified by:
      metricSystemErrors in interface IGateway
      Parameters:
      props -

    • metricSystemErrors

      @Stability(Stable) @NotNull public Metric metricSystemErrors()
      Return a metric containing the number of system errors (5xx status code) for this gateway.
      Specified by:
      metricSystemErrors in interface IGateway

    • metricTargetExecutionTime

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

      Specified by:
      metricTargetExecutionTime in interface IGateway
      Parameters:
      props -

    • metricTargetExecutionTime

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

      Specified by:
      metricTargetExecutionTime in interface IGateway

    • metricTargetType

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

      Specified by:
      metricTargetType in interface IGateway
      Parameters:
      targetType - This parameter is required.
      props -

    • metricTargetType

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

      Specified by:
      metricTargetType in interface IGateway
      Parameters:
      targetType - This parameter is required.

    • metricThrottles

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

      Specified by:
      metricThrottles in interface IGateway
      Parameters:
      props -

    • metricThrottles

      @Stability(Stable) @NotNull public Metric metricThrottles()
      Return a metric containing the number of throttled requests (429 status code) for this gateway.
      Specified by:
      metricThrottles in interface IGateway

    • metricUserErrors

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

      Specified by:
      metricUserErrors in interface IGateway
      Parameters:
      props -

    • metricUserErrors

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

    • getAuthorizerConfiguration

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

    • getGatewayArn

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

    • getGatewayId

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

    • getGatewayName

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

    • getGatewayRef

      @Stability(Stable) @NotNull public GatewayReference getGatewayRef()
      A reference to a Gateway resource.
      Specified by:
      getGatewayRef in interface IGatewayRef

    • getProtocolConfiguration

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

    • getRole

      @Stability(Stable) @NotNull public abstract 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 public abstract String getCreatedAt()
      Timestamp when the gateway was created.
      Specified by:
      getCreatedAt in interface IGateway

    • getDescription

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

    • getExceptionLevel

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

    • getGatewayUrl

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

    • getKmsKey

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

    • getStatus

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

    • getStatusReason

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

    • getUpdatedAt

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