interface CfnGatewayProps

Language	Type name
.NET	Amazon.CDK.AWS.BedrockAgentCore.CfnGatewayProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#CfnGatewayProps
Java	software.amazon.awscdk.services.bedrockagentcore.CfnGatewayProps
Python	aws_cdk.aws_bedrockagentcore.CfnGatewayProps
TypeScript	aws-cdk-lib » aws_bedrockagentcore » CfnGatewayProps

Properties for defining a CfnGateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';
const cfnGatewayProps: bedrockagentcore.CfnGatewayProps = {
  authorizerType: 'authorizerType',
  name: 'name',
  protocolType: 'protocolType',
  roleArn: 'roleArn',

  // the properties below are optional
  authorizerConfiguration: {
    customJwtAuthorizer: {
      discoveryUrl: 'discoveryUrl',

      // the properties below are optional
      allowedAudience: ['allowedAudience'],
      allowedClients: ['allowedClients'],
    },
  },
  description: 'description',
  exceptionLevel: 'exceptionLevel',
  kmsKeyArn: 'kmsKeyArn',
  protocolConfiguration: {
    mcp: {
      instructions: 'instructions',
      searchType: 'searchType',
      supportedVersions: ['supportedVersions'],
    },
  },
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
authorizerType	string	The authorizer type for the gateway.
name	string	The name for the gateway.
protocolType	string	The protocol type for the gateway target.
roleArn	string
authorizerConfiguration?	IResolvable | AuthorizerConfigurationProperty
description?	string	The description for the gateway.
exceptionLevel?	string	The exception level for the gateway.
kmsKeyArn?	string	The KMS key ARN for the gateway.
protocolConfiguration?	IResolvable | GatewayProtocolConfigurationProperty	The protocol configuration for the gateway target.
tags?	{ [string]: string }	The tags for the gateway.

---

authorizerType

Type: string

The authorizer type for the gateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-authorizertype

---

name

Type: string

The name for the gateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-name

---

protocolType

Type: string

The protocol type for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-protocoltype

---

roleArn

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-rolearn

---

authorizerConfiguration?

Type: IResolvable | AuthorizerConfigurationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-authorizerconfiguration

---

description?

Type: string (optional)

The description for the gateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-description

---

exceptionLevel?

Type: string (optional)

The exception level for the gateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-exceptionlevel

---

kmsKeyArn?

Type: string (optional)

The KMS key ARN for the gateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-kmskeyarn

---

protocolConfiguration?

Type: IResolvable | GatewayProtocolConfigurationProperty (optional)

The protocol configuration for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-protocolconfiguration

---

tags?

Type: { [string]: string } (optional)

The tags for the gateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-tags