Experimental
@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
AddOpenApiTargetOptions Struct
Options for adding an OpenAPI target to a gateway.
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 addOpenApiTargetOptions: bedrock_agentcore_alpha.AddOpenApiTargetOptions = {
apiSchema: apiSchema,
// the properties below are optional
credentialProviderConfigurations: [credentialProviderConfig],
description: 'description',
gatewayTargetName: 'gatewayTargetName',
validateOpenApiSchema: false,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha
# api_schema: bedrock_agentcore_alpha.ApiSchema
# credential_provider_config: bedrock_agentcore_alpha.ICredentialProviderConfig
add_open_api_target_options = bedrock_agentcore_alpha.AddOpenApiTargetOptions(
api_schema=api_schema,
# the properties below are optional
credential_provider_configurations=[credential_provider_config],
description="description",
gateway_target_name="gatewayTargetName",
validate_open_api_schema=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.agentcore.alpha.*;
ApiSchema apiSchema;
ICredentialProviderConfig credentialProviderConfig;
AddOpenApiTargetOptions addOpenApiTargetOptions = AddOpenApiTargetOptions.builder()
.apiSchema(apiSchema)
// the properties below are optional
.credentialProviderConfigurations(List.of(credentialProviderConfig))
.description("description")
.gatewayTargetName("gatewayTargetName")
.validateOpenApiSchema(false)
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;
ApiSchema apiSchema;
ICredentialProviderConfig credentialProviderConfig;
var addOpenApiTargetOptions = new AddOpenApiTargetOptions {
ApiSchema = apiSchema,
// the properties below are optional
CredentialProviderConfigurations = new [] { credentialProviderConfig },
Description = "description",
GatewayTargetName = "gatewayTargetName",
ValidateOpenApiSchema = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import bedrock_agentcore_alpha "github.com/aws/aws-cdk-go/awsbedrockagentcorealpha"
var apiSchema ApiSchema
var credentialProviderConfig ICredentialProviderConfig
addOpenApiTargetOptions := &AddOpenApiTargetOptions{
ApiSchema: apiSchema,
// the properties below are optional
CredentialProviderConfigurations: []ICredentialProviderConfig{
credentialProviderConfig,
},
Description: jsii.String("description"),
GatewayTargetName: jsii.String("gatewayTargetName"),
ValidateOpenApiSchema: jsii.Boolean(false),
}
Properties
apiSchemaApiSchemaapi_schemaApiSchemaapiSchemaApiSchemaApiSchemaApiSchemaApiSchemaApiSchemarequired#The OpenAPI schema defining the API.
credentialProviderConfigurationsoptionalICredentialProviderConfig[]credential_provider_configurationsoptionaltyping.List[ICredentialProviderConfig]credentialProviderConfigurationsoptionalList<ICredentialProviderConfig>CredentialProviderConfigurationsoptionalICredentialProviderConfig[]CredentialProviderConfigurationsoptional*[]ICredentialProviderConfig#Credential providers for outbound authentication (OpenAPI targets use API Key or OAuth, not IAM).
Default: none (no credential configuration on the target; supply providers for secured backends)
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
validateOpenApiSchemaoptionalbooleanvalidate_open_api_schemaoptionalboolvalidateOpenApiSchemaoptionalBooleanValidateOpenApiSchemaoptionalboolValidateOpenApiSchemaoptional*bool= true#Whether to validate the OpenAPI schema or not Note: Validation is only performed for inline and asset-based schema and during CDK synthesis.
S3 schemas cannot be validated at synthesis time.