interface CfnGatewayTargetMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.BedrockAgentCore.Mixins.CfnGatewayTargetMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrockagentcore/mixins#CfnGatewayTargetMixinProps
Java	software.amazon.awscdk.mixins.preview.services.bedrockagentcore.mixins.CfnGatewayTargetMixinProps
Python	aws_cdk.mixins_preview.aws_bedrockagentcore.mixins.CfnGatewayTargetMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_bedrockagentcore » mixins » CfnGatewayTargetMixinProps

Properties for CfnGatewayTargetPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as bedrockagentcore_mixins } from '@aws-cdk/mixins-preview/aws-bedrockagentcore';

declare const schemaDefinitionProperty_: bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty;
const cfnGatewayTargetMixinProps: bedrockagentcore_mixins.CfnGatewayTargetMixinProps = {
  credentialProviderConfigurations: [{
    credentialProvider: {
      apiKeyCredentialProvider: {
        credentialLocation: 'credentialLocation',
        credentialParameterName: 'credentialParameterName',
        credentialPrefix: 'credentialPrefix',
        providerArn: 'providerArn',
      },
      oauthCredentialProvider: {
        customParameters: {
          customParametersKey: 'customParameters',
        },
        providerArn: 'providerArn',
        scopes: ['scopes'],
      },
    },
    credentialProviderType: 'credentialProviderType',
  }],
  description: 'description',
  gatewayIdentifier: 'gatewayIdentifier',
  name: 'name',
  targetConfiguration: {
    mcp: {
      lambda: {
        lambdaArn: 'lambdaArn',
        toolSchema: {
          inlinePayload: [{
            description: 'description',
            inputSchema: {
              description: 'description',
              items: schemaDefinitionProperty_,
              properties: {
                propertiesKey: schemaDefinitionProperty_,
              },
              required: ['required'],
              type: 'type',
            },
            name: 'name',
            outputSchema: {
              description: 'description',
              items: schemaDefinitionProperty_,
              properties: {
                propertiesKey: schemaDefinitionProperty_,
              },
              required: ['required'],
              type: 'type',
            },
          }],
          s3: {
            bucketOwnerAccountId: 'bucketOwnerAccountId',
            uri: 'uri',
          },
        },
      },
      mcpServer: {
        endpoint: 'endpoint',
      },
      openApiSchema: {
        inlinePayload: 'inlinePayload',
        s3: {
          bucketOwnerAccountId: 'bucketOwnerAccountId',
          uri: 'uri',
        },
      },
      smithyModel: {
        inlinePayload: 'inlinePayload',
        s3: {
          bucketOwnerAccountId: 'bucketOwnerAccountId',
          uri: 'uri',
        },
      },
    },
  },
};

Properties

Name	Type	Description
credentialProviderConfigurations?	IResolvable | (IResolvable | CredentialProviderConfigurationProperty)[]	The OAuth credential provider configuration.
description?	string	The description for the gateway target.
gatewayIdentifier?	string	The gateway ID for the gateway target.
name?	string	The name for the gateway target.
targetConfiguration?	IResolvable | TargetConfigurationProperty	The target configuration for the Smithy model target.

---

credentialProviderConfigurations?

Type: IResolvable | (IResolvable | CredentialProviderConfigurationProperty)[] (optional)

The OAuth credential provider configuration.

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

---

description?

Type: string (optional)

The description for the gateway target.

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

---

gatewayIdentifier?

Type: string (optional)

The gateway ID for the gateway target.

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

---

name?

Type: string (optional)

The name for the gateway target.

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

---

targetConfiguration?

Type: IResolvable | TargetConfigurationProperty (optional)

The target configuration for the Smithy model target.

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