AddSmithyTargetOptions

class aws_cdk.aws_bedrock_agentcore_alpha.AddSmithyTargetOptions(*, gateway_target_name, smithy_model, credential_provider_configurations=None, description=None)

Bases: object

(experimental) Options for adding a Smithy target to a gateway.

Parameters:

gateway_target_name (str) – (experimental) The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).
smithy_model (ApiSchema) – (experimental) The Smithy model defining the API.
credential_provider_configurations (Optional[Sequence[ICredentialProviderConfig]]) – (experimental) Credential providers for authentication. Default: - [GatewayCredentialProvider.iamRole()]
description (Optional[str]) – (experimental) Optional description for the gateway target. Default: - No description

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)

smithy_target = gateway.add_smithy_target("MySmithyTarget",
    gateway_target_name="my-smithy-target",
    description="Smithy model target",
    smithy_model=smithy_schema
)

Attributes

credential_provider_configurations

(experimental) Credential providers for authentication.

Default:

[GatewayCredentialProvider.iamRole()]

Stability:

experimental

description

(experimental) Optional description for the gateway target.

Default:

No description

Stability:

experimental

gateway_target_name

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

Stability:: experimental

smithy_model

(experimental) The Smithy model defining the API.

Stability:: experimental