AddSmithyTargetOptions

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

Bases: object

Options for adding a Smithy target to a gateway.

Parameters:

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

  • credential_provider_configurations (Optional[Sequence[ICredentialProviderConfig]]) – Credential providers for authentication. Default: - [GatewayCredentialProvider.iamRole()]

  • description (Optional[str]) – Optional description for the gateway target. Default: - No description

  • gateway_target_name (Optional[str]) – The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen). Default: - auto generate

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

Credential providers for authentication.

Default:

  • [GatewayCredentialProvider.iamRole()]

description

Optional description for the gateway target.

Default:

  • No description

gateway_target_name

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

Default:

  • auto generate

smithy_model

The Smithy model defining the API.