CfnGatewayTarget

class aws_cdk.aws_bedrockagentcore.CfnGatewayTarget(scope, id, *, credential_provider_configurations, name, target_configuration, description=None, gateway_identifier=None)

Bases: CfnResource

Amazon Bedrock AgentCore is in preview release and is subject to change.

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
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 = bedrockagentcore.CfnGatewayTarget(self, "MyCfnGatewayTarget",
    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"
                }
            )
        )
    )],
    name="name",
    target_configuration=bedrockagentcore.CfnGatewayTarget.TargetConfigurationProperty(
        mcp=bedrockagentcore.CfnGatewayTarget.McpTargetConfigurationProperty(
            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"
                    )
                )
            ),
            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
    description="description",
    gateway_identifier="gatewayIdentifier"
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
credential_provider_configurations (Union[IResolvable, Sequence[Union[IResolvable, CredentialProviderConfigurationProperty, Dict[str, Any]]]]) – The OAuth credential provider configuration.
name (str) – The name for the gateway target.
target_configuration (Union[IResolvable, TargetConfigurationProperty, Dict[str, Any]]) – The target configuration for the Smithy model target.
description (Optional[str]) – The description for the gateway target.
gateway_identifier (Optional[str]) – The gateway ID for the gateway target.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::BedrockAgentCore::GatewayTarget'

attr_created_at

The date and time at which the gateway target was created.

CloudformationAttribute:: CreatedAt

attr_gateway_arn

GatewayArn

Type:: cloudformationAttribute

attr_status

The status for the gateway target.

CloudformationAttribute:: Status

attr_status_reasons

The status reasons for the gateway target.

CloudformationAttribute:: StatusReasons

attr_target_id

The target ID for the gateway target.

CloudformationAttribute:: TargetId

attr_updated_at

The time at which the resource was updated.

CloudformationAttribute:: UpdatedAt

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

credential_provider_configurations: The OAuth credential provider configuration.

description: The description for the gateway target.

gateway_identifier: The gateway ID for the gateway target.

gateway_target_ref: A reference to a GatewayTarget resource.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name for the gateway target.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

target_configuration: The target configuration for the Smithy model target.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

ApiKeyCredentialProviderProperty

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

Bases: object

The API key credential provider for the gateway target.

Parameters:

provider_arn (str) – The provider ARN for the gateway target.
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.

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 import aws_bedrockagentcore as bedrockagentcore

api_key_credential_provider_property = bedrockagentcore.CfnGatewayTarget.ApiKeyCredentialProviderProperty(
    provider_arn="providerArn",

    # the properties below are optional
    credential_location="credentialLocation",
    credential_parameter_name="credentialParameterName",
    credential_prefix="credentialPrefix"
)

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 CfnGatewayTarget.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 import aws_bedrockagentcore as bedrockagentcore

api_schema_configuration_property = bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
    inline_payload="inlinePayload",
    s3=bedrockagentcore.CfnGatewayTarget.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 CfnGatewayTarget.CredentialProviderConfigurationProperty(*, credential_provider_type, credential_provider=None)

Bases: object

The credential provider configuration for the gateway target.

Parameters:

credential_provider_type (str) – The credential provider type for the gateway target.
credential_provider (Union[IResolvable, CredentialProviderProperty, Dict[str, Any], None]) – The credential provider 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 import aws_bedrockagentcore as bedrockagentcore

credential_provider_configuration_property = 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"
            }
        )
    )
)

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 CfnGatewayTarget.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 import aws_bedrockagentcore as bedrockagentcore

credential_provider_property = 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"
        }
    )
)

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 CfnGatewayTarget.McpLambdaTargetConfigurationProperty(*, lambda_arn, tool_schema)

Bases: object

The Lambda target configuration.

Parameters:

lambda_arn (str) – The ARN of the Lambda target configuration.
tool_schema (Union[IResolvable, ToolSchemaProperty, Dict[str, Any]]) – 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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

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

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

McpTargetConfigurationProperty

class CfnGatewayTarget.McpTargetConfigurationProperty(*, lambda_=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.
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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

mcp_target_configuration_property = bedrockagentcore.CfnGatewayTarget.McpTargetConfigurationProperty(
    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"
            )
        )
    ),
    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"
        )
    )
)

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

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 CfnGatewayTarget.OAuthCredentialProviderProperty(*, provider_arn, scopes, custom_parameters=None)

Bases: object

The OAuth credential provider for the gateway target.

Parameters:

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

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 import aws_bedrockagentcore as bedrockagentcore

o_auth_credential_provider_property = bedrockagentcore.CfnGatewayTarget.OAuthCredentialProviderProperty(
    provider_arn="providerArn",
    scopes=["scopes"],

    # the properties below are optional
    custom_parameters={
        "custom_parameters_key": "customParameters"
    }
)

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 CfnGatewayTarget.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 import aws_bedrockagentcore as bedrockagentcore

s3_configuration_property = bedrockagentcore.CfnGatewayTarget.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 CfnGatewayTarget.SchemaDefinitionProperty(*, type, description=None, items=None, properties=None, required=None)

Bases: object

The schema definition for the gateway target.

Parameters:

type (str) – The scheme definition type for the gateway target.
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.

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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

schema_definition_property = bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
    type="type",

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

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 CfnGatewayTarget.TargetConfigurationProperty(*, mcp)

Bases: object

The target configuration.

Parameters:: mcp (Union[IResolvable, McpTargetConfigurationProperty, Dict[str, Any]]) – 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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

target_configuration_property = bedrockagentcore.CfnGatewayTarget.TargetConfigurationProperty(
    mcp=bedrockagentcore.CfnGatewayTarget.McpTargetConfigurationProperty(
        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"
                )
            )
        ),
        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"
            )
        )
    )
)

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 CfnGatewayTarget.ToolDefinitionProperty(*, description, input_schema, name, output_schema=None)

Bases: object

The tool definition for the gateway.

Parameters:

description (str)
input_schema (Union[IResolvable, SchemaDefinitionProperty, Dict[str, Any]]) – The input schema for the gateway target.
name (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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

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

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 CfnGatewayTarget.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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

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

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