MetadataConfiguration

class aws_cdk.aws_bedrock_agentcore_alpha.MetadataConfiguration(*, allowed_query_parameters=None, allowed_request_headers=None, allowed_response_headers=None)

Bases: object

(experimental) Configuration for passing metadata (headers and query parameters) to the API Gateway target.

Parameters:

  • allowed_query_parameters (Optional[Sequence[str]]) – (experimental) List of query parameter names to pass through to the target. Constraints: - Array must contain 1-10 items - Each parameter name must be 1-40 characters - Cannot be an empty array Default: - No query parameters are passed through

  • allowed_request_headers (Optional[Sequence[str]]) – (experimental) List of request header names to pass through to the target. Constraints: - Array must contain 1-10 items - Each header name must be 1-100 characters - Cannot be an empty array Default: - No request headers are passed through

  • allowed_response_headers (Optional[Sequence[str]]) – (experimental) List of response header names to pass through from the target. Constraints: - Array must contain 1-10 items - Each header name must be 1-100 characters - Cannot be an empty array Default: - No response headers are passed through

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

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

metadata_configuration = bedrock_agentcore_alpha.MetadataConfiguration(
    allowed_query_parameters=["allowedQueryParameters"],
    allowed_request_headers=["allowedRequestHeaders"],
    allowed_response_headers=["allowedResponseHeaders"]
)

Attributes

allowed_query_parameters

(experimental) List of query parameter names to pass through to the target.

Constraints:

  • Array must contain 1-10 items

  • Each parameter name must be 1-40 characters

  • Cannot be an empty array

Default:

  • No query parameters are passed through

Stability:

experimental

allowed_request_headers

(experimental) List of request header names to pass through to the target.

Constraints:

  • Array must contain 1-10 items

  • Each header name must be 1-100 characters

  • Cannot be an empty array

Default:

  • No request headers are passed through

Stability:

experimental

allowed_response_headers

(experimental) List of response header names to pass through from the target.

Constraints:

  • Array must contain 1-10 items

  • Each header name must be 1-100 characters

  • Cannot be an empty array

Default:

  • No response headers are passed through

Stability:

experimental