Experimental
@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
GatewayTargetProps Struct
Properties for creating a Gateway Target resource.
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 credentialProviderConfig: bedrock_agentcore_alpha.ICredentialProviderConfig;
declare const gateway: bedrock_agentcore_alpha.Gateway;
declare const targetConfiguration: bedrock_agentcore_alpha.ITargetConfiguration;
const gatewayTargetProps: bedrock_agentcore_alpha.GatewayTargetProps = {
gateway: gateway,
targetConfiguration: targetConfiguration,
// 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.fromIamRole()]
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Optional description for the gateway target The description can have up to 200 characters.
Default: No description
The gateway this target belongs to.
gatewayTargetNameoptionalstringgateway_target_nameoptionalstrgatewayTargetNameoptionalStringGatewayTargetNameoptionalstringGatewayTargetNameoptional*string#The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.
Default: auto generate
targetConfigurationITargetConfigurationtarget_configurationITargetConfigurationtargetConfigurationITargetConfigurationTargetConfigurationITargetConfigurationTargetConfigurationITargetConfigurationrequired#The target configuration (Lambda, OpenAPI, or Smithy) Use one of the configuration helper classes: - LambdaTargetConfiguration.create() - OpenApiTargetConfiguration.create() - SmithyTargetConfiguration.create().