AddSmithyTargetOptions

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

Bases: object

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

Parameters:

  • 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

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

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha

# api_schema: bedrock_agentcore_alpha.ApiSchema
# credential_provider_config: bedrock_agentcore_alpha.ICredentialProviderConfig

add_smithy_target_options = bedrock_agentcore_alpha.AddSmithyTargetOptions(
    smithy_model=api_schema,

    # the properties below are optional
    credential_provider_configurations=[credential_provider_config],
    description="description",
    gateway_target_name="gatewayTargetName"
)

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).

Default:

  • auto generate

Stability:

experimental

smithy_model

(experimental) The Smithy model defining the API.

Stability:

experimental