CfnGatewayTargetProps

class aws_cdk.aws_bedrockagentcore.CfnGatewayTargetProps(*, name, target_configuration, credential_provider_configurations=None, description=None, gateway_identifier=None, metadata_configuration=None)

Bases: object

Properties for defining a CfnGatewayTarget.

Parameters:

name (str) – The name for the gateway target.
target_configuration (Union[IResolvable, TargetConfigurationProperty, Dict[str, Any]]) – The target configuration for the Smithy model target.
credential_provider_configurations (Union[IResolvable, Sequence[Union[IResolvable, CredentialProviderConfigurationProperty, Dict[str, Any]]], None]) – The OAuth credential provider configuration.
description (Optional[str]) – The description for the gateway target.
gateway_identifier (Optional[str]) – The gateway ID for the gateway target.
metadata_configuration (Union[IResolvable, MetadataConfigurationProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html

ExampleMetadata:

fixture=_generated

Example:

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

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

cfn_gateway_target_props = bedrockagentcore.CfnGatewayTargetProps(
    name="name",
    target_configuration=bedrockagentcore.CfnGatewayTarget.TargetConfigurationProperty(
        mcp=bedrockagentcore.CfnGatewayTarget.McpTargetConfigurationProperty(
            api_gateway=bedrockagentcore.CfnGatewayTarget.ApiGatewayTargetConfigurationProperty(
                api_gateway_tool_configuration=bedrockagentcore.CfnGatewayTarget.ApiGatewayToolConfigurationProperty(
                    tool_filters=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolFilterProperty(
                        filter_path="filterPath",
                        methods=["methods"]
                    )],

                    # the properties below are optional
                    tool_overrides=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolOverrideProperty(
                        method="method",
                        name="name",
                        path="path",

                        # the properties below are optional
                        description="description"
                    )]
                ),
                rest_api_id="restApiId",
                stage="stage"
            ),
            lambda_=bedrockagentcore.CfnGatewayTarget.McpLambdaTargetConfigurationProperty(
                lambda_arn="lambdaArn",
                tool_schema=bedrockagentcore.CfnGatewayTarget.ToolSchemaProperty(
                    inline_payload=[bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty(
                        description="description",
                        input_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
                            type="type",

                            # the properties below are optional
                            description="description",
                            items=schema_definition_property_,
                            properties={
                                "properties_key": schema_definition_property_
                            },
                            required=["required"]
                        ),
                        name="name",

                        # the properties below are optional
                        output_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
                            type="type",

                            # the properties below are optional
                            description="description",
                            items=schema_definition_property_,
                            properties={
                                "properties_key": schema_definition_property_
                            },
                            required=["required"]
                        )
                    )],
                    s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                        bucket_owner_account_id="bucketOwnerAccountId",
                        uri="uri"
                    )
                )
            ),
            mcp_server=bedrockagentcore.CfnGatewayTarget.McpServerTargetConfigurationProperty(
                endpoint="endpoint"
            ),
            open_api_schema=bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
                inline_payload="inlinePayload",
                s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                    bucket_owner_account_id="bucketOwnerAccountId",
                    uri="uri"
                )
            ),
            smithy_model=bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
                inline_payload="inlinePayload",
                s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                    bucket_owner_account_id="bucketOwnerAccountId",
                    uri="uri"
                )
            )
        )
    ),

    # the properties below are optional
    credential_provider_configurations=[bedrockagentcore.CfnGatewayTarget.CredentialProviderConfigurationProperty(
        credential_provider_type="credentialProviderType",

        # the properties below are optional
        credential_provider=bedrockagentcore.CfnGatewayTarget.CredentialProviderProperty(
            api_key_credential_provider=bedrockagentcore.CfnGatewayTarget.ApiKeyCredentialProviderProperty(
                provider_arn="providerArn",

                # the properties below are optional
                credential_location="credentialLocation",
                credential_parameter_name="credentialParameterName",
                credential_prefix="credentialPrefix"
            ),
            oauth_credential_provider=bedrockagentcore.CfnGatewayTarget.OAuthCredentialProviderProperty(
                provider_arn="providerArn",
                scopes=["scopes"],

                # the properties below are optional
                custom_parameters={
                    "custom_parameters_key": "customParameters"
                },
                default_return_url="defaultReturnUrl",
                grant_type="grantType"
            )
        )
    )],
    description="description",
    gateway_identifier="gatewayIdentifier",
    metadata_configuration=bedrockagentcore.CfnGatewayTarget.MetadataConfigurationProperty(
        allowed_query_parameters=["allowedQueryParameters"],
        allowed_request_headers=["allowedRequestHeaders"],
        allowed_response_headers=["allowedResponseHeaders"]
    )
)