GatewayTargetProps

class aws_cdk.aws_bedrock_agentcore_alpha.GatewayTargetProps(*, description=None, gateway_target_name=None, gateway, target_configuration, credential_provider_configurations=None)

Bases: GatewayTargetCommonProps

(experimental) Properties for creating a Gateway Target resource.

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.

  • target_configuration (ITargetConfiguration) – (experimental) The target configuration (Lambda, OpenAPI, or Smithy) Use one of the configuration helper classes: - LambdaTargetConfiguration.create() - OpenApiTargetConfiguration.create() - SmithyTargetConfiguration.create().

  • credential_provider_configurations (Optional[Sequence[ICredentialProviderConfig]]) – (experimental) Credential providers for 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

# credential_provider_config: bedrock_agentcore_alpha.ICredentialProviderConfig
# gateway: bedrock_agentcore_alpha.Gateway
# target_configuration: bedrock_agentcore_alpha.ITargetConfiguration

gateway_target_props = bedrock_agentcore_alpha.GatewayTargetProps(
    gateway=gateway,
    target_configuration=target_configuration,

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

target_configuration

  • LambdaTargetConfiguration.create() - OpenApiTargetConfiguration.create() - SmithyTargetConfiguration.create().

Stability:

experimental

Type:

(experimental) The target configuration (Lambda, OpenAPI, or Smithy) Use one of the configuration helper classes