CfnGatewayTargetMixinProps

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

Bases: object

Properties for CfnGatewayTargetPropsMixin.

Parameters:

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])
name (Optional[str]) – The name for the gateway target.
target_configuration (Union[IResolvable, TargetConfigurationProperty, Dict[str, Any], None]) – The target configuration for the Smithy model target.

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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

# schema_definition_property_: bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty

cfn_gateway_target_mixin_props = bedrockagentcore_mixins.CfnGatewayTargetMixinProps(
    credential_provider_configurations=[bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.CredentialProviderConfigurationProperty(
        credential_provider=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.CredentialProviderProperty(
            api_key_credential_provider=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty(
                credential_location="credentialLocation",
                credential_parameter_name="credentialParameterName",
                credential_prefix="credentialPrefix",
                provider_arn="providerArn"
            ),
            oauth_credential_provider=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.OAuthCredentialProviderProperty(
                custom_parameters={
                    "custom_parameters_key": "customParameters"
                },
                default_return_url="defaultReturnUrl",
                grant_type="grantType",
                provider_arn="providerArn",
                scopes=["scopes"]
            )
        ),
        credential_provider_type="credentialProviderType"
    )],
    description="description",
    gateway_identifier="gatewayIdentifier",
    metadata_configuration=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.MetadataConfigurationProperty(
        allowed_query_parameters=["allowedQueryParameters"],
        allowed_request_headers=["allowedRequestHeaders"],
        allowed_response_headers=["allowedResponseHeaders"]
    ),
    name="name",
    target_configuration=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.TargetConfigurationProperty(
        mcp=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.McpTargetConfigurationProperty(
            api_gateway=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.ApiGatewayTargetConfigurationProperty(
                api_gateway_tool_configuration=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.ApiGatewayToolConfigurationProperty(
                    tool_filters=[bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.ApiGatewayToolFilterProperty(
                        filter_path="filterPath",
                        methods=["methods"]
                    )],
                    tool_overrides=[bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.ApiGatewayToolOverrideProperty(
                        description="description",
                        method="method",
                        name="name",
                        path="path"
                    )]
                ),
                rest_api_id="restApiId",
                stage="stage"
            ),
            lambda_=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.McpLambdaTargetConfigurationProperty(
                lambda_arn="lambdaArn",
                tool_schema=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.ToolSchemaProperty(
                    inline_payload=[bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.ToolDefinitionProperty(
                        description="description",
                        input_schema=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty(
                            description="description",
                            items=schema_definition_property_,
                            properties={
                                "properties_key": schema_definition_property_
                            },
                            required=["required"],
                            type="type"
                        ),
                        name="name",
                        output_schema=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty(
                            description="description",
                            items=schema_definition_property_,
                            properties={
                                "properties_key": schema_definition_property_
                            },
                            required=["required"],
                            type="type"
                        )
                    )],
                    s3=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.S3ConfigurationProperty(
                        bucket_owner_account_id="bucketOwnerAccountId",
                        uri="uri"
                    )
                )
            ),
            mcp_server=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.McpServerTargetConfigurationProperty(
                endpoint="endpoint"
            ),
            open_api_schema=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty(
                inline_payload="inlinePayload",
                s3=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.S3ConfigurationProperty(
                    bucket_owner_account_id="bucketOwnerAccountId",
                    uri="uri"
                )
            ),
            smithy_model=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty(
                inline_payload="inlinePayload",
                s3=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.S3ConfigurationProperty(
                    bucket_owner_account_id="bucketOwnerAccountId",
                    uri="uri"
                )
            )
        )
    )
)