interface CfnGatewayProps
Language | Type name |
---|---|
![]() | Amazon.CDK.aws_bedrockagentcore.CfnGatewayProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#CfnGatewayProps |
![]() | software.amazon.awscdk.services.bedrockagentcore.CfnGatewayProps |
![]() | aws_cdk.aws_bedrockagentcore.CfnGatewayProps |
![]() | aws-cdk-lib » aws_bedrockagentcore » CfnGatewayProps |
Properties for defining a CfnGateway
.
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 |
---|---|---|
authorizer | string | The authorizer type for the gateway. |
name | string | The name for the gateway. |
protocol | string | The protocol type for the gateway target. |
role | string | |
authorizer | IResolvable | Authorizer | |
description? | string | The description for the gateway. |
exception | string | The exception level for the gateway. |
kms | string | The KMS key ARN for the gateway. |
protocol | IResolvable | Gateway | The protocol configuration for the gateway target. |
tags? | { [string]: string } | The tags for the gateway. |
authorizerType
Type:
string
The authorizer type for the gateway.
name
Type:
string
The name for the gateway.
protocolType
Type:
string
The protocol type for the gateway target.
roleArn
Type:
string
authorizerConfiguration?
Type:
IResolvable
|
Authorizer
(optional)
description?
Type:
string
(optional)
The description for the gateway.
exceptionLevel?
Type:
string
(optional)
The exception level for the gateway.
kmsKeyArn?
Type:
string
(optional)
The KMS key ARN for the gateway.
protocolConfiguration?
Type:
IResolvable
|
Gateway
(optional)
The protocol configuration for the gateway target.
tags?
Type:
{ [string]: string }
(optional)
The tags for the gateway.