Skip to content
v2.277.0

Experimental

@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

GatewayBase L2 construct ​

Base class for Gateway constructs.

Initializer ​

ts
new GatewayBase(scope: Construct, id: string, props?: ResourceProps)
python
GatewayBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)
java
new GatewayBase(Construct scope, String id, ResourceProps props)
csharp
new GatewayBase(Construct scope, string id, ResourceProps? props = null)
go
NewGatewayBase(Scope Construct, Id *string, Props ResourceProps)

Construct Props ​

accountoptionalstringaccountoptionalstraccountoptionalStringAccountoptionalstringAccountoptional*string#
The AWS account ID this resource belongs to.

Default: the resource is in the same account as the stack it belongs to

environmentFromArnoptionalstringenvironment_from_arnoptionalstrenvironmentFromArnoptionalStringEnvironmentFromArnoptionalstringEnvironmentFromArnoptional*string#
ARN to deduce region and account from.

Default: take environment from account, region parameters, or use Stack environment.

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.

physicalNameoptionalstringphysical_nameoptionalstrphysicalNameoptionalStringPhysicalNameoptionalstringPhysicalNameoptional*string#
The value passed in by users to the physical name prop of the resource.

Default: The physical name will be allocated by CloudFormation at deployment time

notes
  • undefined implies that a physical name will be allocated by CloudFormation during deployment.
  • a concrete value implies a specific physical name
  • PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string#
The AWS region this resource belongs to.

Default: the resource is in the same region as the stack it belongs to

Properties ​

authorizerConfigurationIGatewayAuthorizerConfigauthorizer_configurationIGatewayAuthorizerConfigauthorizerConfigurationIGatewayAuthorizerConfigAuthorizerConfigurationIGatewayAuthorizerConfigAuthorizerConfigurationIGatewayAuthorizerConfig#
The authorizer configuration for the gateway.
createdAtmay be undefinedstringcreated_atmay be undefinedstrcreatedAtmay be undefinedStringCreatedAtmay be undefinedstringCreatedAtmay be undefined*string#
Timestamp when the gateway was created.
descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#
The description of the gateway.
The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

exceptionLevelmay be undefinedGatewayExceptionLevelexception_levelmay be undefinedGatewayExceptionLevelexceptionLevelmay be undefinedGatewayExceptionLevelExceptionLevelmay be undefinedGatewayExceptionLevelExceptionLevelmay be undefinedGatewayExceptionLevel#
The exception level for the gateway.
gatewayArnstringgateway_arnstrgatewayArnStringGatewayArnstringGatewayArn*string#
The ARN of the gateway resource.
gatewayIdstringgateway_idstrgatewayIdStringGatewayIdstringGatewayId*string#
The id of the gateway.
A reference to a Gateway resource.
gatewayUrlmay be undefinedstringgateway_urlmay be undefinedstrgatewayUrlmay be undefinedStringGatewayUrlmay be undefinedstringGatewayUrlmay be undefined*string#
The URL endpoint for the gateway.
kmsKeymay be undefinedIKeykms_keymay be undefinedIKeykmsKeymay be undefinedIKeyKmsKeymay be undefinedIKeyKmsKeymay be undefinedIKey#
The KMS key used for encryption.
namestringnamestrnameStringNamestringName*string#
The name of the gateway.
nodeNodenodeNodenodeNodeNodeNodeNodeNode#
The tree node.
protocolConfigurationIGatewayProtocolConfigprotocol_configurationIGatewayProtocolConfigprotocolConfigurationIGatewayProtocolConfigProtocolConfigurationIGatewayProtocolConfigProtocolConfigurationIGatewayProtocolConfig#
The protocol configuration for the gateway.
roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole#
The IAM role that provides permissions for the gateway to access AWS services.
stackStackstackStackstackStackStackStackStackStack#
The stack in which this resource is defined.
statusmay be undefinedstringstatusmay be undefinedstrstatusmay be undefinedStringStatusmay be undefinedstringStatusmay be undefined*string#
The status of the gateway.
statusReasonmay be undefinedstring[]status_reasonmay be undefinedtyping.List[str]statusReasonmay be undefinedList<String>StatusReasonmay be undefinedstring[]StatusReasonmay be undefined*[]*string#
The status reasons for the gateway.
updatedAtmay be undefinedstringupdated_atmay be undefinedstrupdatedAtmay be undefinedStringUpdatedAtmay be undefinedstringUpdatedAtmay be undefined*string#
Timestamp when the gateway was last updated.

Methods ​

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#
Override the cross-stack reference strength for this resource.
notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

  • strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#
Grants IAM actions to the IAM Principal.

[disable-awslint:no-grants]

2 parameters

Parameters

  • granteegranteegranteegranteeGrantee — The principal to grant permissions to.
  • actionsactionsactionsactionsActions — The actions to grant.
grantInvoke(grantee: IGrantable): Grantdef grant_invoke(self, grantee: IGrantable) -> Grantpublic Grant grantInvoke(IGrantable grantee)public Grant GrantInvoke(IGrantable grantee)func GrantInvoke(Grantee IGrantable) Grant#
Grants permission to invoke this Gateway.

[disable-awslint:no-grants]

1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — The principal to grant invoke permissions to.
grantManage(grantee: IGrantable): Grantdef grant_manage(self, grantee: IGrantable) -> Grantpublic Grant grantManage(IGrantable grantee)public Grant GrantManage(IGrantable grantee)func GrantManage(Grantee IGrantable) Grant#
Grants `Create`, `Update`, and `Delete` actions on the Gateway.

[disable-awslint:no-grants]

1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — The principal to grant manage permissions to.
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#
Grants `Get` and `List` actions on the Gateway.

[disable-awslint:no-grants]

1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — The principal to grant read permissions to.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#
Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#
Check whether the given construct is a Resource.
metric(metricName: string, dimensions: { [key: string]: string }, props?: MetricOptions): Metricdef metric(self, metric_name: str, dimensions: typing.Mapping[str, str], props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, Map<String, String> dimensions, MetricOptions props)public Metric Metric(string metricName, IDictionary<string, string> dimensions, MetricOptions? props = null)func Metric(MetricName *string, Dimensions *map[string]*string, Props MetricOptions) Metric#
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.

3 parameters

Parameters

  • metricNamemetric_namemetricNamemetricNameMetricName — The name of the metric.
  • dimensionsdimensionsdimensionsdimensionsDimensions — Additional dimensions for the metric.
  • propspropspropspropsProps — Optional metric configuration.
metricDuration(props?: MetricOptions): Metricdef metric_duration(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricDuration(MetricOptions props)public Metric MetricDuration(MetricOptions? props = null)func MetricDuration(Props MetricOptions) Metric#
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.

metricInvocations(props?: MetricOptions): Metricdef metric_invocations(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInvocations(MetricOptions props)public Metric MetricInvocations(MetricOptions? props = null)func MetricInvocations(Props MetricOptions) Metric#
Return a metric containing the total number of invocations for this gateway.
metricLatency(props?: MetricOptions): Metricdef metric_latency(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricLatency(MetricOptions props)public Metric MetricLatency(MetricOptions? props = null)func MetricLatency(Props MetricOptions) Metric#
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.

metricSystemErrors(props?: MetricOptions): Metricdef metric_system_errors(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSystemErrors(MetricOptions props)public Metric MetricSystemErrors(MetricOptions? props = null)func MetricSystemErrors(Props MetricOptions) Metric#
Return a metric containing the number of system errors (5xx status code) for this gateway.
metricTargetExecutionTime(props?: MetricOptions): Metricdef metric_target_execution_time(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTargetExecutionTime(MetricOptions props)public Metric MetricTargetExecutionTime(MetricOptions? props = null)func MetricTargetExecutionTime(Props MetricOptions) Metric#
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.

metricTargetType(targetType: string, props?: MetricOptions): Metricdef metric_target_type(self, target_type: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTargetType(String targetType, MetricOptions props)public Metric MetricTargetType(string targetType, MetricOptions? props = null)func MetricTargetType(TargetType *string, Props MetricOptions) Metric#
Return a metric containing the number of requests served by each target type for this gateway.
metricThrottles(props?: MetricOptions): Metricdef metric_throttles(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricThrottles(MetricOptions props)public Metric MetricThrottles(MetricOptions? props = null)func MetricThrottles(Props MetricOptions) Metric#
Return a metric containing the number of throttled requests (429 status code) for this gateway.
metricUserErrors(props?: MetricOptions): Metricdef metric_user_errors(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricUserErrors(MetricOptions props)public Metric MetricUserErrors(MetricOptions? props = null)func MetricUserErrors(Props MetricOptions) Metric#
Return a metric containing the number of user errors (4xx status code, excluding 429) for this gateway.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.