CfnGatewayTargetPropsMixin

class aws_cdk.mixins_preview.aws_bedrockagentcore.mixins.CfnGatewayTargetPropsMixin(props, *, strategy=None)

Bases: Mixin

After creating a gateway, you can add targets, which define the tools that your gateway will host.

For more information about adding gateway targets, see Add targets to an existing gateway .

See the Properties section below for descriptions of both the required and optional properties.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html
CloudformationResource:: AWS::BedrockAgentCore::GatewayTarget
Mixin:: true
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 import mixins
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

# schema_definition_property_: bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty

cfn_gateway_target_props_mixin = bedrockagentcore_mixins.CfnGatewayTargetPropsMixin(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"
                },
                provider_arn="providerArn",
                scopes=["scopes"]
            )
        ),
        credential_provider_type="credentialProviderType"
    )],
    description="description",
    gateway_identifier="gatewayIdentifier",
    name="name",
    target_configuration=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.TargetConfigurationProperty(
        mcp=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.McpTargetConfigurationProperty(
            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"
                )
            )
        )
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::BedrockAgentCore::GatewayTarget.

Parameters:

props (Union[CfnGatewayTargetMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['credentialProviderConfigurations', 'description', 'gatewayIdentifier', 'name', 'targetConfiguration']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ApiKeyCredentialProviderProperty

class CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty(*, credential_location=None, credential_parameter_name=None, credential_prefix=None, provider_arn=None)

Bases: object

The API key credential provider for the gateway target.

Parameters:

credential_location (Optional[str]) – The credential location for the gateway target.
credential_parameter_name (Optional[str]) – The credential parameter name for the provider for the gateway target.
credential_prefix (Optional[str]) – The API key credential provider for the gateway target.
provider_arn (Optional[str]) – The provider ARN for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.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

api_key_credential_provider_property = bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty(
    credential_location="credentialLocation",
    credential_parameter_name="credentialParameterName",
    credential_prefix="credentialPrefix",
    provider_arn="providerArn"
)

Attributes

credential_location

The credential location for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentiallocation

credential_parameter_name

The credential parameter name for the provider for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialparametername

credential_prefix

The API key credential provider for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialprefix

provider_arn

The provider ARN for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-providerarn

ApiSchemaConfigurationProperty

class CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty(*, inline_payload=None, s3=None)

Bases: object

The API schema configuration for the gateway target.

Parameters:

inline_payload (Optional[str]) – The inline payload for the gateway.
s3 (Union[IResolvable, S3ConfigurationProperty, Dict[str, Any], None]) – The API schema configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.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

api_schema_configuration_property = bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty(
    inline_payload="inlinePayload",
    s3=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.S3ConfigurationProperty(
        bucket_owner_account_id="bucketOwnerAccountId",
        uri="uri"
    )
)

Attributes

inline_payload

The inline payload for the gateway.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-inlinepayload

s3

The API schema configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-s3

CredentialProviderConfigurationProperty

class CfnGatewayTargetPropsMixin.CredentialProviderConfigurationProperty(*, credential_provider=None, credential_provider_type=None)

Bases: object

The credential provider configuration for the gateway target.

Parameters:

credential_provider (Union[IResolvable, CredentialProviderProperty, Dict[str, Any], None]) – The credential provider for the gateway target.
credential_provider_type (Optional[str]) – The credential provider type for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.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

credential_provider_configuration_property = 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"
            },
            provider_arn="providerArn",
            scopes=["scopes"]
        )
    ),
    credential_provider_type="credentialProviderType"
)

Attributes

credential_provider

The credential provider for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovider

credential_provider_type

The credential provider type for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovidertype

CredentialProviderProperty

class CfnGatewayTargetPropsMixin.CredentialProviderProperty(*, api_key_credential_provider=None, oauth_credential_provider=None)

Bases: object

Parameters:

api_key_credential_provider (Union[IResolvable, ApiKeyCredentialProviderProperty, Dict[str, Any], None]) – The API key credential provider.
oauth_credential_provider (Union[IResolvable, OAuthCredentialProviderProperty, Dict[str, Any], None]) – The OAuth credential provider for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.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

credential_provider_property = 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"
        },
        provider_arn="providerArn",
        scopes=["scopes"]
    )
)

Attributes

api_key_credential_provider

The API key credential provider.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html#cfn-bedrockagentcore-gatewaytarget-credentialprovider-apikeycredentialprovider

oauth_credential_provider

The OAuth credential provider for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html#cfn-bedrockagentcore-gatewaytarget-credentialprovider-oauthcredentialprovider

McpLambdaTargetConfigurationProperty

class CfnGatewayTargetPropsMixin.McpLambdaTargetConfigurationProperty(*, lambda_arn=None, tool_schema=None)

Bases: object

The Lambda target configuration.

Parameters:

lambda_arn (Optional[str]) – The ARN of the Lambda target configuration.
tool_schema (Union[IResolvable, ToolSchemaProperty, Dict[str, Any], None]) – The tool schema configuration for the gateway target MCP configuration for Lambda.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.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

mcp_lambda_target_configuration_property = 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"
        )
    )
)

Attributes

lambda_arn

The ARN of the Lambda target configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-lambdaarn

tool_schema

The tool schema configuration for the gateway target MCP configuration for Lambda.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-toolschema

McpServerTargetConfigurationProperty

class CfnGatewayTargetPropsMixin.McpServerTargetConfigurationProperty(*, endpoint=None)

Bases: object

Parameters:: endpoint (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration.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

mcp_server_target_configuration_property = bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.McpServerTargetConfigurationProperty(
    endpoint="endpoint"
)

Attributes

endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-endpoint

Type:: see

McpTargetConfigurationProperty

class CfnGatewayTargetPropsMixin.McpTargetConfigurationProperty(*, lambda_=None, mcp_server=None, open_api_schema=None, smithy_model=None)

Bases: object

The MCP target configuration for the gateway target.

Parameters:

lambda – The Lambda MCP configuration for the gateway target.
mcp_server (Union[IResolvable, McpServerTargetConfigurationProperty, Dict[str, Any], None])
open_api_schema (Union[IResolvable, ApiSchemaConfigurationProperty, Dict[str, Any], None]) – The OpenApi schema for the gateway target MCP configuration.
smithy_model (Union[IResolvable, ApiSchemaConfigurationProperty, Dict[str, Any], None]) – The target configuration for the Smithy model target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.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

mcp_target_configuration_property = bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.McpTargetConfigurationProperty(
    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"
        )
    )
)

Attributes

lambda_

The Lambda MCP configuration for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-lambda

mcp_server

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-mcpserver

Type:: see

open_api_schema

The OpenApi schema for the gateway target MCP configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-openapischema

smithy_model

The target configuration for the Smithy model target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-smithymodel

OAuthCredentialProviderProperty

class CfnGatewayTargetPropsMixin.OAuthCredentialProviderProperty(*, custom_parameters=None, provider_arn=None, scopes=None)

Bases: object

The OAuth credential provider for the gateway target.

Parameters:

custom_parameters (Union[Mapping[str, str], IResolvable, None]) – The OAuth credential provider.
provider_arn (Optional[str]) – The provider ARN for the gateway target.
scopes (Optional[Sequence[str]]) – The OAuth credential provider scopes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.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

o_auth_credential_provider_property = bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.OAuthCredentialProviderProperty(
    custom_parameters={
        "custom_parameters_key": "customParameters"
    },
    provider_arn="providerArn",
    scopes=["scopes"]
)

Attributes

custom_parameters

The OAuth credential provider.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-customparameters

provider_arn

The provider ARN for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-providerarn

scopes

The OAuth credential provider scopes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-scopes

S3ConfigurationProperty

class CfnGatewayTargetPropsMixin.S3ConfigurationProperty(*, bucket_owner_account_id=None, uri=None)

Bases: object

The S3 configuration for the gateway target.

Parameters:

bucket_owner_account_id (Optional[str]) – The S3 configuration bucket owner account ID for the gateway target.
uri (Optional[str]) – The configuration URI for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.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

s3_configuration_property = bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.S3ConfigurationProperty(
    bucket_owner_account_id="bucketOwnerAccountId",
    uri="uri"
)

Attributes

bucket_owner_account_id

The S3 configuration bucket owner account ID for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html#cfn-bedrockagentcore-gatewaytarget-s3configuration-bucketowneraccountid

uri

The configuration URI for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html#cfn-bedrockagentcore-gatewaytarget-s3configuration-uri

SchemaDefinitionProperty

class CfnGatewayTargetPropsMixin.SchemaDefinitionProperty(*, description=None, items=None, properties=None, required=None, type=None)

Bases: object

The schema definition for the gateway target.

Parameters:

description (Optional[str]) – The workload identity details for the gateway.
items (Union[IResolvable, SchemaDefinitionProperty, Dict[str, Any], None])
properties (Union[IResolvable, Mapping[str, Union[IResolvable, SchemaDefinitionProperty, Dict[str, Any]]], None]) – The schema definition properties for the gateway target.
required (Optional[Sequence[str]]) – The schema definition.
type (Optional[str]) – The scheme definition type for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.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

schema_definition_property = bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty(
    description="description",
    items=schema_definition_property_,
    properties={
        "properties_key": schema_definition_property_
    },
    required=["required"],
    type="type"
)

Attributes

description

The workload identity details for the gateway.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-description

items

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-items

Type:: see

properties

The schema definition properties for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-properties

required

The schema definition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-required

type

The scheme definition type for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-type

TargetConfigurationProperty

class CfnGatewayTargetPropsMixin.TargetConfigurationProperty(*, mcp=None)

Bases: object

The target configuration.

Parameters:: mcp (Union[IResolvable, McpTargetConfigurationProperty, Dict[str, Any], None]) – The target configuration definition for MCP.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.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

target_configuration_property = bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.TargetConfigurationProperty(
    mcp=bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.McpTargetConfigurationProperty(
        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"
            )
        )
    )
)

Attributes

mcp

The target configuration definition for MCP.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-targetconfiguration-mcp

ToolDefinitionProperty

class CfnGatewayTargetPropsMixin.ToolDefinitionProperty(*, description=None, input_schema=None, name=None, output_schema=None)

Bases: object

The tool definition for the gateway.

Parameters:

description (Optional[str])
input_schema (Union[IResolvable, SchemaDefinitionProperty, Dict[str, Any], None]) – The input schema for the gateway target.
name (Optional[str]) – The tool name.
output_schema (Union[IResolvable, SchemaDefinitionProperty, Dict[str, Any], None]) – The tool definition output schema for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.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

tool_definition_property = 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"
    )
)

Attributes

description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-description

Type:: see

input_schema

The input schema for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-inputschema

name

The tool name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-name

output_schema

The tool definition output schema for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-outputschema

ToolSchemaProperty

class CfnGatewayTargetPropsMixin.ToolSchemaProperty(*, inline_payload=None, s3=None)

Bases: object

The tool schema for the gateway target.

Parameters:

inline_payload (Union[IResolvable, Sequence[Union[IResolvable, ToolDefinitionProperty, Dict[str, Any]]], None]) – The inline payload for the gateway target.
s3 (Union[IResolvable, S3ConfigurationProperty, Dict[str, Any], None]) – The S3 tool schema for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.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

tool_schema_property = 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"
    )
)

Attributes

inline_payload

The inline payload for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html#cfn-bedrockagentcore-gatewaytarget-toolschema-inlinepayload

s3

The S3 tool schema for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html#cfn-bedrockagentcore-gatewaytarget-toolschema-s3