interface AddSmithyTargetOptions
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.AddSmithyTargetOptions |
 Go | github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#AddSmithyTargetOptions |
 Java | software.amazon.awscdk.services.bedrock.agentcore.alpha.AddSmithyTargetOptions |
 Python | aws_cdk.aws_bedrock_agentcore_alpha.AddSmithyTargetOptions |
 TypeScript (source) | @aws-cdk/aws-bedrock-agentcore-alpha » AddSmithyTargetOptions |
Options for adding a Smithy target to a gateway.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
declare const apiSchema: bedrock_agentcore_alpha.ApiSchema;
declare const credentialProviderConfig: bedrock_agentcore_alpha.ICredentialProviderConfig;
const addSmithyTargetOptions: bedrock_agentcore_alpha.AddSmithyTargetOptions = {
smithyModel: apiSchema,
// the properties below are optional
credentialProviderConfigurations: [credentialProviderConfig],
description: 'description',
gatewayTargetName: 'gatewayTargetName',
};
Properties
| Name | Type | Description |
|---|---|---|
| smithy | Api | The Smithy model defining the API. |
| credential | ICredential[] | Credential providers for authentication. |
| description? | string | Optional description for the gateway target. |
| gateway | string | The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen). |
smithyModel
Type:
Api
The Smithy model defining the API.
credentialProviderConfigurations?
Type:
ICredential[]
(optional, default: [GatewayCredentialProvider.iamRole()])
Credential providers for authentication.
description?
Type:
string
(optional, default: No description)
Optional description for the gateway target.
gatewayTargetName?
Type:
string
(optional, default: auto generate)
The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).