GatewayTargetSmithyProps

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

Bases: GatewayTargetCommonProps

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

Parameters:

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

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

  • 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=_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
# gateway: bedrock_agentcore_alpha.Gateway

gateway_target_smithy_props = bedrock_agentcore_alpha.GatewayTargetSmithyProps(
    gateway=gateway,
    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 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}$.

Default:

  • auto generate

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