AWS CDK Reference

Appearance

v2.275.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.

AddSmithyTargetOptions Struct ​

Options for adding a Smithy target to a gateway.

Source
lib/gateway/gateway.ts

Example ​

ts
// 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 ​

credentialProviderConfigurationsoptionalICredentialProviderConfig[]credential_provider_configurationsoptionaltyping.List[ICredentialProviderConfig]credentialProviderConfigurationsoptionalList<ICredentialProviderConfig>CredentialProviderConfigurationsoptionalICredentialProviderConfig[]CredentialProviderConfigurationsoptional*[]ICredentialProviderConfig#
Credential providers for authentication.

Default: [GatewayCredentialProvider.iamRole()]

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Optional description for the gateway target.

Default: No description

gatewayTargetNameoptionalstringgateway_target_nameoptionalstrgatewayTargetNameoptionalStringGatewayTargetNameoptionalstringGatewayTargetNameoptional*string#
The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).

Default: auto generate

smithyModelApiSchemasmithy_modelApiSchemasmithyModelApiSchemaSmithyModelApiSchemaSmithyModelApiSchemarequired#
The Smithy model defining the API.