Package software.amazon.awscdk.services.bedrockagentcore

Interface AddSmithyTargetOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AddSmithyTargetOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.130.0 (build 048a5ee)",
           date="2026-05-19T19:44:36.889Z")
@Stability(Stable)
public interface AddSmithyTargetOptions
extends software.amazon.jsii.JsiiSerializable

Options for adding a Smithy target to a gateway.

Example:

 Gateway gateway = Gateway.Builder.create(this, "MyGateway")
         .gatewayName("my-gateway")
         .build();
 AssetApiSchema smithySchema = ApiSchema.fromLocalAsset(path.join(__dirname, "models", "smithy-model.json"));
 smithySchema.bind(this);
 GatewayTarget smithyTarget = gateway.addSmithyTarget("MySmithyTarget", AddSmithyTargetOptions.builder()
         .gatewayTargetName("my-smithy-target")
         .description("Smithy model target")
         .smithyModel(smithySchema)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AddSmithyTargetOptions.Builder	A builder for AddSmithyTargetOptions
static final class	AddSmithyTargetOptions.Jsii$Proxy	An implementation for AddSmithyTargetOptions

Method Summary

Modifier and Type	Method	Description
static AddSmithyTargetOptions.Builder	builder()
default List<ICredentialProviderConfig>	getCredentialProviderConfigurations()	Credential providers for authentication.
default String	getDescription()	Optional description for the gateway target.
default String	getGatewayTargetName()	The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).
ApiSchema	getSmithyModel()	The Smithy model defining the API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSmithyModel

@Stability(Stable)
@NotNull
ApiSchema getSmithyModel()

The Smithy model defining the API.

getCredentialProviderConfigurations

@Stability(Stable)
@Nullable
default List<ICredentialProviderConfig> getCredentialProviderConfigurations()

Credential providers for authentication.

Default: - [GatewayCredentialProvider.iamRole()]

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Optional description for the gateway target.

Default: - No description

getGatewayTargetName

@Stability(Stable)
@Nullable
default String getGatewayTargetName()

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

Default: - auto generate

builder

@Stability(Stable)
static AddSmithyTargetOptions.Builder builder()

Returns:

a AddSmithyTargetOptions.Builder of AddSmithyTargetOptions