GatewayTargetSmithyProps

class aws_cdk.aws_bedrock_agentcore_alpha.GatewayTargetSmithyProps(*, gateway_target_name, description=None, gateway, smithy_model, credential_provider_configurations=None)

Bases: GatewayTargetCommonProps

(experimental) Properties for creating a Smithy-based Gateway Target.

Parameters:

  • gateway_target_name (str) – (experimental) The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.

  • description (Optional[str]) – (experimental) Optional description for the gateway target The description can have up to 200 characters. Default: - No description

  • gateway (IGateway) – (experimental) The gateway this target belongs to.

  • smithy_model (ApiSchema) – (experimental) The Smithy model defining the API.

  • credential_provider_configurations (Optional[Sequence[ICredentialProviderConfig]]) – (experimental) Credential providers for authentication Smithy targets only support IAM role authentication. Default: - [GatewayCredentialProvider.fromIamRole()]

Stability:

experimental

ExampleMetadata:

fixture=default infused

Example:

gateway = agentcore.Gateway(self, "MyGateway",
    gateway_name="my-gateway"
)

smithy_schema = agentcore.ApiSchema.from_local_asset(
    path.join(__dirname, "models", "smithy-model.json"))
smithy_schema.bind(self)

# Create a gateway target with Smithy Model and OAuth
target = agentcore.GatewayTarget.for_smithy(self, "MySmithyTarget",
    gateway_target_name="my-smithy-target",
    description="Target for Smithy model integration",
    gateway=gateway,
    smithy_model=smithy_schema
)

Attributes

credential_provider_configurations

(experimental) Credential providers for authentication Smithy targets only support IAM role authentication.

Default:

  • [GatewayCredentialProvider.fromIamRole()]

Stability:

experimental

description

(experimental) Optional description for the gateway target The description can have up to 200 characters.

Default:

  • No description

Stability:

experimental

gateway

(experimental) The gateway this target belongs to.

Stability:

experimental

gateway_target_name

^([0-9a-zA-Z][-]?){1,100}$.

Stability:

experimental

Type:

(experimental) The name of the gateway target The name must be unique within the gateway Pattern

smithy_model

(experimental) The Smithy model defining the API.

Stability:

experimental