Package software.amazon.awscdk.services.bedrockagentcore

Interface GatewayTargetSmithyProps

All Superinterfaces:

GatewayTargetCommonProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GatewayTargetSmithyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
           date="2026-05-19T08:18:44.417Z")
@Stability(Stable)
public interface GatewayTargetSmithyProps
extends software.amazon.jsii.JsiiSerializable, GatewayTargetCommonProps

Properties for creating a Smithy-based Gateway Target.

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);
 // Create a gateway target with Smithy Model and OAuth
 GatewayTarget target = GatewayTarget.forSmithy(this, "MySmithyTarget", GatewayTargetSmithyProps.builder()
         .gatewayTargetName("my-smithy-target")
         .description("Target for Smithy model integration")
         .gateway(gateway)
         .smithyModel(smithySchema)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GatewayTargetSmithyProps.Builder	builder()
default List<ICredentialProviderConfig>	getCredentialProviderConfigurations()	Credential providers for authentication Smithy targets only support IAM role authentication.
IGateway	getGateway()	The gateway this target belongs to.
ApiSchema	getSmithyModel()	The Smithy model defining the API.

Methods inherited from interface software.amazon.awscdk.services.bedrockagentcore.GatewayTargetCommonProps

getDescription, getGatewayTargetName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGateway

@Stability(Stable)
@NotNull
IGateway getGateway()

The gateway this target belongs to.

getSmithyModel

@Stability(Stable)
@NotNull
ApiSchema getSmithyModel()

The Smithy model defining the API.

getCredentialProviderConfigurations

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

Credential providers for authentication Smithy targets only support IAM role authentication.

Default: - [GatewayCredentialProvider.fromIamRole()]

builder

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

Returns:

a GatewayTargetSmithyProps.Builder of GatewayTargetSmithyProps