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.

Gateway L2 construct ​

Gateway resource for AWS Bedrock Agent Core.

Serves as an integration point between your agent and external services.

Example ​

ts

// Create a Policy engine
const policyEngine = new agentcore.PolicyEngine(this, "MyPolicyEngine", {
  policyEngineName: "my_policy_engine",
  description: "Policy engine for access control",
});

const gateway = new agentcore.Gateway(this, "MyGateway", {
  gatewayName: "my-gateway",
  policyEngineConfiguration: {
    policyEngine: policyEngine,
    mode: agentcore.PolicyEngineMode.ENFORCE, // Default is LOG_ONLY
  },
});

// Add policy to policy engine
policyEngine.addPolicy("AllowAllActions", {
  definition: `
    permit(
      principal,
      action,
      resource == AgentCore::Gateway::"${gateway.gatewayArn}"
    );
  `,
  description: "Allow all actions on specific gateway (development)",
  validationMode: agentcore.PolicyValidationMode.IGNORE_ALL_FINDINGS, // This will ignore all cedar warnings
});

// you can add multiple policies to the policy engine
policyEngine.addPolicy("SpecificToolPolicy", {
  definition: `
    permit(
      principal is AgentCore::OAuthUser,
      action == AgentCore::Action::"WeatherTool__get_forecast",
      resource == AgentCore::Gateway::"${gateway.gatewayArn}"
    );
  `,
  description: "Allow specific weather tool access",
  validationMode: agentcore.PolicyValidationMode.FAIL_ON_ANY_FINDINGS, // This will fail policy creation for any cedar warning
});
python
# Create a Policy engine
policy_engine = agentcore.PolicyEngine(self, "MyPolicyEngine",
    policy_engine_name="my_policy_engine",
    description="Policy engine for access control"
)

gateway = agentcore.Gateway(self, "MyGateway",
    gateway_name="my-gateway",
    policy_engine_configuration=agentcore.GatewayPolicyEngineConfig(
        policy_engine=policy_engine,
        mode=agentcore.PolicyEngineMode.ENFORCE
    )
)

# Add policy to policy engine
policy_engine.add_policy("AllowAllActions",
    definition=f"""
        permit(
          principal,
          action,
          resource == AgentCore::Gateway::\"{gateway.gatewayArn}\"
        );
      """,
    description="Allow all actions on specific gateway (development)",
    validation_mode=agentcore.PolicyValidationMode.IGNORE_ALL_FINDINGS
)

# you can add multiple policies to the policy engine
policy_engine.add_policy("SpecificToolPolicy",
    definition=f"""
        permit(
          principal is AgentCore::OAuthUser,
          action == AgentCore::Action::\"WeatherTool__get_forecast\",
          resource == AgentCore::Gateway::\"{gateway.gatewayArn}\"
        );
      """,
    description="Allow specific weather tool access",
    validation_mode=agentcore.PolicyValidationMode.FAIL_ON_ANY_FINDINGS
)
java
// Create a Policy engine
PolicyEngine policyEngine = PolicyEngine.Builder.create(this, "MyPolicyEngine")
        .policyEngineName("my_policy_engine")
        .description("Policy engine for access control")
        .build();

Gateway gateway = Gateway.Builder.create(this, "MyGateway")
        .gatewayName("my-gateway")
        .policyEngineConfiguration(GatewayPolicyEngineConfig.builder()
                .policyEngine(policyEngine)
                .mode(PolicyEngineMode.ENFORCE)
                .build())
        .build();

// Add policy to policy engine
policyEngine.addPolicy("AllowAllActions", AddPolicyOptions.builder()
        .definition(String.format("%n    permit(%n      principal,%n      action,%n      resource == AgentCore::Gateway::\"%s\"%n    );%n  ", gateway.getGatewayArn()))
        .description("Allow all actions on specific gateway (development)")
        .validationMode(PolicyValidationMode.IGNORE_ALL_FINDINGS)
        .build());

// you can add multiple policies to the policy engine
policyEngine.addPolicy("SpecificToolPolicy", AddPolicyOptions.builder()
        .definition(String.format("%n    permit(%n      principal is AgentCore::OAuthUser,%n      action == AgentCore::Action::\"WeatherTool__get_forecast\",%n      resource == AgentCore::Gateway::\"%s\"%n    );%n  ", gateway.getGatewayArn()))
        .description("Allow specific weather tool access")
        .validationMode(PolicyValidationMode.FAIL_ON_ANY_FINDINGS)
        .build());
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
// Create a Policy engine
var policyEngine = new PolicyEngine(this, "MyPolicyEngine", new PolicyEngineProps {
    PolicyEngineName = "my_policy_engine",
    Description = "Policy engine for access control"
});

var gateway = new Gateway(this, "MyGateway", new GatewayProps {
    GatewayName = "my-gateway",
    PolicyEngineConfiguration = new GatewayPolicyEngineConfig {
        PolicyEngine = policyEngine,
        Mode = PolicyEngineMode.ENFORCE
    }
});

// Add policy to policy engine
policyEngine.AddPolicy("AllowAllActions", new AddPolicyOptions {
    Definition = $@"
        permit(
          principal,
          action,
          resource == AgentCore::Gateway::""{gateway.gatewayArn}""
        );
      ",
    Description = "Allow all actions on specific gateway (development)",
    ValidationMode = PolicyValidationMode.IGNORE_ALL_FINDINGS
});

// you can add multiple policies to the policy engine
policyEngine.AddPolicy("SpecificToolPolicy", new AddPolicyOptions {
    Definition = $@"
        permit(
          principal is AgentCore::OAuthUser,
          action == AgentCore::Action::""WeatherTool__get_forecast"",
          resource == AgentCore::Gateway::""{gateway.gatewayArn}""
        );
      ",
    Description = "Allow specific weather tool access",
    ValidationMode = PolicyValidationMode.FAIL_ON_ANY_FINDINGS
});
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2
// Create a Policy engine
policyEngine := agentcore.NewPolicyEngine(this, jsii.String("MyPolicyEngine"), &PolicyEngineProps{
	PolicyEngineName: jsii.String("my_policy_engine"),
	Description: jsii.String("Policy engine for access control"),
})

gateway := agentcore.NewGateway(this, jsii.String("MyGateway"), &GatewayProps{
	GatewayName: jsii.String("my-gateway"),
	PolicyEngineConfiguration: &GatewayPolicyEngineConfig{
		PolicyEngine: policyEngine,
		Mode: agentcore.PolicyEngineMode_ENFORCE(),
	},
})

// Add policy to policy engine
policyEngine.AddPolicy(jsii.String("AllowAllActions"), &AddPolicyOptions{
	Definition: fmt.Sprintf("\n    permit(\n      principal,\n      action,\n      resource == AgentCore::Gateway::\"%v\"\n    );\n  ", gateway.GatewayArn),
	Description: jsii.String("Allow all actions on specific gateway (development)"),
	ValidationMode: agentcore.PolicyValidationMode_IGNORE_ALL_FINDINGS(),
})

// you can add multiple policies to the policy engine
policyEngine.AddPolicy(jsii.String("SpecificToolPolicy"), &AddPolicyOptions{
	Definition: fmt.Sprintf("\n    permit(\n      principal is AgentCore::OAuthUser,\n      action == AgentCore::Action::\"WeatherTool__get_forecast\",\n      resource == AgentCore::Gateway::\"%v\"\n    );\n  ", gateway.*GatewayArn),
	Description: jsii.String("Allow specific weather tool access"),
	ValidationMode: agentcore.PolicyValidationMode_FAIL_ON_ANY_FINDINGS(),
})

Initializer ​

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

Construct Props ​

authorizerConfigurationoptionalIGatewayAuthorizerConfigauthorizer_configurationoptionalIGatewayAuthorizerConfigauthorizerConfigurationoptionalIGatewayAuthorizerConfigAuthorizerConfigurationoptionalIGatewayAuthorizerConfigAuthorizerConfigurationoptionalIGatewayAuthorizerConfig#
The authorizer configuration for the gateway.

Default: A default authorizer will be created using Cognito

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Optional description for the gateway Valid characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and spaces The description can have up to 200 characters.

Default: No description

exceptionLeveloptionalGatewayExceptionLevelexception_leveloptionalGatewayExceptionLevelexceptionLeveloptionalGatewayExceptionLevelExceptionLeveloptionalGatewayExceptionLevelExceptionLeveloptionalGatewayExceptionLevel#
The verbosity of exception messages Use DEBUG mode to see granular exception messages from a Gateway.

Default: Exception messages are sanitized for presentation to end users

gatewayNameoptionalstringgateway_nameoptionalstrgatewayNameoptionalStringGatewayNameoptionalstringGatewayNameoptional*string#
The name of the gateway Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen) The name must be unique within your account.

Default: auto generate

interceptorConfigurationsoptionalIInterceptor[]interceptor_configurationsoptionaltyping.List[IInterceptor]interceptorConfigurationsoptionalList<IInterceptor>InterceptorConfigurationsoptionalIInterceptor[]InterceptorConfigurationsoptional*[]IInterceptor#
Interceptor configurations for the gateway.

Default: No interceptors

notes

Interceptors allow you to run custom code during each gateway invocation:

  • REQUEST interceptors execute before the gateway calls the target
  • RESPONSE interceptors execute after the target responds

A gateway can have at most one REQUEST interceptor and one RESPONSE interceptor.

kmsKeyoptionalIKeykms_keyoptionalIKeykmsKeyoptionalIKeyKmsKeyoptionalIKeyKmsKeyoptionalIKey#
The AWS KMS key used to encrypt data associated with the gateway.

Default: No encryption

policyEngineConfigurationoptionalGatewayPolicyEngineConfigpolicy_engine_configurationoptionalGatewayPolicyEngineConfigpolicyEngineConfigurationoptionalGatewayPolicyEngineConfigPolicyEngineConfigurationoptionalGatewayPolicyEngineConfigPolicyEngineConfigurationoptionalGatewayPolicyEngineConfig#
The policy engine configuration for this gateway.

Default: No policy engine (requests are not subject to Cedar policy authorization)

When provided, the specified policy engine will be associated with this gateway. All agent requests through this gateway will be evaluated against the Cedar policies defined in the policy engine.

protocolConfigurationoptionalIGatewayProtocolConfigprotocol_configurationoptionalIGatewayProtocolConfigprotocolConfigurationoptionalIGatewayProtocolConfigProtocolConfigurationoptionalIGatewayProtocolConfigProtocolConfigurationoptionalIGatewayProtocolConfig#
The protocol configuration for the gateway.

Default: A default protocol configuration will be created using MCP with following params supportedVersions: [MCPProtocolVersion.MCP_2025_03_26], searchType: McpGatewaySearchType.SEMANTIC, instructions: "Default gateway to connect to external MCP tools",

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

Default: A new role will be created

tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#
Tags for the gateway A list of key:value pairs of tags to apply to this Gateway resource.

Default: No tags

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.
gatewayIdstringgateway_idstrgatewayIdStringGatewayIdstringGatewayId*string#
The unique identifier 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.
oauthScopesmay be undefinedstring[]oauth_scopesmay be undefinedtyping.List[str]oauthScopesmay be undefinedList<String>OauthScopesmay be undefinedstring[]OauthScopesmay be undefined*[]*string#
The OAuth2 scope strings for client credentials flow.

Only available when using the default Cognito authorizer.

policyEngineConfigurationmay be undefinedGatewayPolicyEngineConfigpolicy_engine_configurationmay be undefinedGatewayPolicyEngineConfigpolicyEngineConfigurationmay be undefinedGatewayPolicyEngineConfigPolicyEngineConfigurationmay be undefinedGatewayPolicyEngineConfigPolicyEngineConfigurationmay be undefinedGatewayPolicyEngineConfig#
The policy engine configuration associated with this gateway.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#
Uniquely identifies this class.
protocolConfigurationIGatewayProtocolConfigprotocol_configurationIGatewayProtocolConfigprotocolConfigurationIGatewayProtocolConfigProtocolConfigurationIGatewayProtocolConfigProtocolConfigurationIGatewayProtocolConfig#
The protocol configuration for the gateway.
resourceServermay be undefinedIUserPoolResourceServerresource_servermay be undefinedIUserPoolResourceServerresourceServermay be undefinedIUserPoolResourceServerResourceServermay be undefinedIUserPoolResourceServerResourceServermay be undefinedIUserPoolResourceServer#
The Cognito Resource Server created for the gateway (if using default Cognito authorizer).
roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole#
The IAM role for the gateway.
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.
tagsmay be undefined{ [key: string]: string }tagsmay be undefinedtyping.Mapping[str, str]tagsmay be undefinedMap<String, String>Tagsmay be undefinedIDictionary<string, string>Tagsmay be undefined*map[string]*string#
Tags applied to the gateway.
tokenEndpointUrlmay be undefinedstringtoken_endpoint_urlmay be undefinedstrtokenEndpointUrlmay be undefinedStringTokenEndpointUrlmay be undefinedstringTokenEndpointUrlmay be undefined*string#
The OAuth2 token endpoint URL for client credentials flow.

Only available when using the default Cognito authorizer.

updatedAtmay be undefinedstringupdated_atmay be undefinedstrupdatedAtmay be undefinedStringUpdatedAtmay be undefinedstringUpdatedAtmay be undefined*string#
Timestamp when the gateway was last updated.
userPoolmay be undefinedIUserPooluser_poolmay be undefinedIUserPooluserPoolmay be undefinedIUserPoolUserPoolmay be undefinedIUserPoolUserPoolmay be undefinedIUserPool#
The Cognito User Pool created for the gateway (if using default Cognito authorizer).
userPoolClientmay be undefinedIUserPoolClientuser_pool_clientmay be undefinedIUserPoolClientuserPoolClientmay be undefinedIUserPoolClientUserPoolClientmay be undefinedIUserPoolClientUserPoolClientmay be undefinedIUserPoolClient#
The Cognito User Pool Client created for the gateway (if using default Cognito authorizer).
userPoolDomainmay be undefinedIUserPoolDomainuser_pool_domainmay be undefinedIUserPoolDomainuserPoolDomainmay be undefinedIUserPoolDomainUserPoolDomainmay be undefinedIUserPoolDomainUserPoolDomainmay be undefinedIUserPoolDomain#
The Cognito User Pool Domain created for the gateway (if using default Cognito authorizer).

Methods ​

addApiGatewayTarget(id: string, props: AddApiGatewayTargetOptions): GatewayTargetdef add_api_gateway_target(self, id: str, props: AddApiGatewayTargetOptions) -> GatewayTargetpublic GatewayTarget addApiGatewayTarget(String id, AddApiGatewayTargetOptions props)public GatewayTarget AddApiGatewayTarget(string id, AddApiGatewayTargetOptions props)func AddApiGatewayTarget(Id *string, Props AddApiGatewayTargetOptions) GatewayTarget#
Add an API Gateway target to this gateway This is a convenience method that creates a GatewayTarget associated with this gateway.
2 parameters · returns

Parameters

  • ididididId — The construct id for the target.
  • propspropspropspropsProps — Properties for the API Gateway target.

Returns: The created GatewayTarget

addInterceptor(interceptor: IInterceptor): voiddef add_interceptor(self, interceptor: IInterceptor) -> Nonepublic void addInterceptor(IInterceptor interceptor)public void AddInterceptor(IInterceptor interceptor)func AddInterceptor(Interceptor IInterceptor)#
Add an interceptor to this gateway.
notes · 1 parameter

Interceptors allow you to run custom code at specific points in the gateway request/response flow:

  • REQUEST interceptors execute before the gateway calls the target
  • RESPONSE interceptors execute after the target responds

A gateway can have at most one REQUEST interceptor and one RESPONSE interceptor.

Parameters

  • interceptorinterceptorinterceptorinterceptorInterceptor — The interceptor to add (use LambdaInterceptor factory methods).
addLambdaTarget(id: string, props: AddLambdaTargetOptions): GatewayTargetdef add_lambda_target(self, id: str, props: AddLambdaTargetOptions) -> GatewayTargetpublic GatewayTarget addLambdaTarget(String id, AddLambdaTargetOptions props)public GatewayTarget AddLambdaTarget(string id, AddLambdaTargetOptions props)func AddLambdaTarget(Id *string, Props AddLambdaTargetOptions) GatewayTarget#
Add a Lambda target to this gateway This is a convenience method that creates a GatewayTarget associated with this gateway.
2 parameters · returns

Parameters

  • ididididId — The construct id for the target.
  • propspropspropspropsProps — Properties for the Lambda target.

Returns: The created GatewayTarget

addMcpServerTarget(id: string, props: AddMcpServerTargetOptions): GatewayTargetdef add_mcp_server_target(self, id: str, props: AddMcpServerTargetOptions) -> GatewayTargetpublic GatewayTarget addMcpServerTarget(String id, AddMcpServerTargetOptions props)public GatewayTarget AddMcpServerTarget(string id, AddMcpServerTargetOptions props)func AddMcpServerTarget(Id *string, Props AddMcpServerTargetOptions) GatewayTarget#
Add an MCP server target to this gateway This is a convenience method that creates a GatewayTarget associated with this gateway.
2 parameters · returns

Parameters

  • ididididId — The construct id for the target.
  • propspropspropspropsProps — Properties for the MCP server target.

Returns: The created GatewayTarget

addOpenApiTarget(id: string, props: AddOpenApiTargetOptions): GatewayTargetdef add_open_api_target(self, id: str, props: AddOpenApiTargetOptions) -> GatewayTargetpublic GatewayTarget addOpenApiTarget(String id, AddOpenApiTargetOptions props)public GatewayTarget AddOpenApiTarget(string id, AddOpenApiTargetOptions props)func AddOpenApiTarget(Id *string, Props AddOpenApiTargetOptions) GatewayTarget#
Add an OpenAPI target to this gateway This is a convenience method that creates a GatewayTarget associated with this gateway.
2 parameters · returns

Parameters

  • ididididId — The construct id for the target.
  • propspropspropspropsProps — Properties for the OpenAPI target.

Returns: The created GatewayTarget

addSmithyTarget(id: string, props: AddSmithyTargetOptions): GatewayTargetdef add_smithy_target(self, id: str, props: AddSmithyTargetOptions) -> GatewayTargetpublic GatewayTarget addSmithyTarget(String id, AddSmithyTargetOptions props)public GatewayTarget AddSmithyTarget(string id, AddSmithyTargetOptions props)func AddSmithyTarget(Id *string, Props AddSmithyTargetOptions) GatewayTarget#
Add a Smithy target to this gateway This is a convenience method that creates a GatewayTarget associated with this gateway.
2 parameters · returns

Parameters

  • ididididId — The construct id for the target.
  • propspropspropspropsProps — Properties for the Smithy target.

Returns: The created GatewayTarget

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

fromGatewayAttributes(scope: Construct, id: string, attrs: GatewayAttributes): IGateway@staticmethod def from_gateway_attributes(scope: Construct, id: str, attrs: GatewayAttributes) -> IGatewaypublic static IGateway fromGatewayAttributes(Construct scope, String id, GatewayAttributes attrs)public static IGateway FromGatewayAttributes(Construct scope, string id, GatewayAttributes attrs)func FromGatewayAttributes(Scope Construct, Id *string, Attrs GatewayAttributes) IGatewaystatic#
Import an existing Gateway using its attributes.
3 parameters · returns

Parameters

  • scopescopescopescopeScope — The construct scope.
  • ididididId — The construct id.
  • attrsattrsattrsattrsAttrs — The attributes of the existing Gateway.

Returns: An IGateway instance representing the imported gateway

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.