Class GatewayBase

**************************************************************************** Base Class ***************************************************************************.

Inheritance

object

Resource

GatewayBase

Gateway

Implements

IGateway

IResource

IGatewayRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.With(params IMixin[])

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.BedrockAgentCore

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public abstract class GatewayBase : Resource, IGateway, IResource, IGatewayRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public MustInherit Class GatewayBase Inherits Resource Implements IGateway, IResource, IGatewayRef, IConstruct, IDependable, IEnvironmentAware

Synopsis

Constructors

GatewayBase(Construct, string, IResourceProps?)

**************************************************************************** Base Class ***************************************************************************.

Properties

AuthorizerConfiguration	The authorizer configuration for the gateway.
CreatedAt	Timestamp when the gateway was created.
Description	The description of the gateway.
ExceptionLevel	The exception level for the gateway.
GatewayArn	The ARN of the gateway resource.
GatewayId	The id of the gateway.
GatewayName	The name of the gateway.
GatewayRef	A reference to a Gateway resource.
GatewayUrl	The URL endpoint for the gateway.
KmsKey	The KMS key used for encryption.
ProtocolConfiguration	The protocol configuration for the gateway.
Role	The IAM role that provides permissions for the gateway to access AWS services.
Status	The status of the gateway.
StatusReason	The status reasons for the gateway.
UpdatedAt	Timestamp when the gateway was last updated.

Methods

Grant(IGrantable, params string[])	Grants IAM actions to the IAM Principal.
GrantInvoke(IGrantable)	Grants permission to invoke this Gateway.
GrantManage(IGrantable)	Grants Create, Update, and Delete actions on the Gateway.
GrantRead(IGrantable)	Grants Get and List actions on the Gateway.
Metric(string, IMetricOptions?)	Return the given named metric for this gateway.
MetricDuration(IMetricOptions?)	Return a metric measuring the duration of requests for this gateway.
MetricInvocations(IMetricOptions?)	Return a metric containing the total number of invocations for this gateway.
MetricLatency(IMetricOptions?)	Return a metric measuring the latency of requests for this gateway.
MetricSystemErrors(IMetricOptions?)	Return a metric containing the number of system errors (5xx status code) for this gateway.
MetricTargetExecutionTime(IMetricOptions?)	Return a metric measuring the target execution time for this gateway.
MetricTargetType(string, IMetricOptions?)	Return a metric containing the number of requests served by each target type for this gateway.
MetricThrottles(IMetricOptions?)	Return a metric containing the number of throttled requests (429 status code) for this gateway.
MetricUserErrors(IMetricOptions?)	Return a metric containing the number of user errors (4xx status code, excluding 429) for this gateway.

Constructors

GatewayBase(Construct, string, IResourceProps?)

**************************************************************************** Base Class ***************************************************************************.

protected GatewayBase(Construct scope, string id, IResourceProps? props = null)

Parameters

scope Construct

id string

props IResourceProps

Properties

AuthorizerConfiguration

The authorizer configuration for the gateway.

public abstract IGatewayAuthorizerConfig AuthorizerConfiguration { get; }

Property Value

IGatewayAuthorizerConfig

CreatedAt

Timestamp when the gateway was created.

public abstract string? CreatedAt { get; }

Property Value

string

Description

The description of the gateway.

public abstract string? Description { get; }

Property Value

string

ExceptionLevel

The exception level for the gateway.

public abstract GatewayExceptionLevel? ExceptionLevel { get; }

Property Value

GatewayExceptionLevel

GatewayArn

The ARN of the gateway resource.

public abstract string GatewayArn { get; }

Property Value

string

GatewayId

The id of the gateway.

public abstract string GatewayId { get; }

Property Value

string

GatewayName

The name of the gateway.

public abstract string GatewayName { get; }

Property Value

string

GatewayRef

A reference to a Gateway resource.

public virtual IGatewayReference GatewayRef { get; }

Property Value

IGatewayReference

GatewayUrl

The URL endpoint for the gateway.

public abstract string? GatewayUrl { get; }

Property Value

string

KmsKey

The KMS key used for encryption.

public abstract IKey? KmsKey { get; }

Property Value

IKey

ProtocolConfiguration

The protocol configuration for the gateway.

public abstract IGatewayProtocolConfig ProtocolConfiguration { get; }

Property Value

IGatewayProtocolConfig

Role

The IAM role that provides permissions for the gateway to access AWS services.

public abstract IRole Role { get; }

Property Value

IRole

Status

The status of the gateway.

public abstract string? Status { get; }

Property Value

string

StatusReason

The status reasons for the gateway.

public abstract string[]? StatusReason { get; }

Property Value

string[]

UpdatedAt

Timestamp when the gateway was last updated.

public abstract string? UpdatedAt { get; }

Property Value

string

Methods

Grant(IGrantable, params string[])

Grants IAM actions to the IAM Principal.

public virtual Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable

The principal to grant permissions to.

actions string[]

The actions to grant.

Returns

Grant

Remarks

[disable-awslint:no-grants]

GrantInvoke(IGrantable)

Grants permission to invoke this Gateway.

public virtual Grant GrantInvoke(IGrantable grantee)

Parameters

grantee IGrantable

The principal to grant invoke permissions to.

Returns

Grant

Remarks

[disable-awslint:no-grants]

GrantManage(IGrantable)

Grants Create, Update, and Delete actions on the Gateway.

public virtual Grant GrantManage(IGrantable grantee)

Parameters

grantee IGrantable

The principal to grant manage permissions to.

Returns

Grant

Remarks

[disable-awslint:no-grants]

GrantRead(IGrantable)

Grants Get and List actions on the Gateway.

public virtual Grant GrantRead(IGrantable grantee)

Parameters

grantee IGrantable

The principal to grant read permissions to.

Returns

Grant

Remarks

[disable-awslint:no-grants]

Metric(string, IMetricOptions?)

Return the given named metric for this gateway.

public virtual Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

metricName string

The name of the metric.

props IMetricOptions

Optional metric configuration.

Returns

Metric

Remarks

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.

MetricDuration(IMetricOptions?)

Return a metric measuring the duration of requests for this gateway.

public virtual Metric MetricDuration(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

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.

MetricInvocations(IMetricOptions?)

Return a metric containing the total number of invocations for this gateway.

public virtual Metric MetricInvocations(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

MetricLatency(IMetricOptions?)

Return a metric measuring the latency of requests for this gateway.

public virtual Metric MetricLatency(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

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

MetricSystemErrors(IMetricOptions?)

Return a metric containing the number of system errors (5xx status code) for this gateway.

public virtual Metric MetricSystemErrors(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

MetricTargetExecutionTime(IMetricOptions?)

Return a metric measuring the target execution time for this gateway.

public virtual Metric MetricTargetExecutionTime(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

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

MetricTargetType(string, IMetricOptions?)

Return a metric containing the number of requests served by each target type for this gateway.

public virtual Metric MetricTargetType(string targetType, IMetricOptions? props = null)

Parameters

targetType string

props IMetricOptions

Returns

Metric

MetricThrottles(IMetricOptions?)

Return a metric containing the number of throttled requests (429 status code) for this gateway.

public virtual Metric MetricThrottles(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

MetricUserErrors(IMetricOptions?)

Return a metric containing the number of user errors (4xx status code, excluding 429) for this gateway.

public virtual Metric MetricUserErrors(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Implements

IGateway

IResource

IGatewayRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware