Skip to content
v2.278.0

MetadataConfiguration Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
const metadataConfiguration: bedrock_agentcore_alpha.MetadataConfiguration = {
  allowedQueryParameters: ['allowedQueryParameters'],
  allowedRequestHeaders: ['allowedRequestHeaders'],
  allowedResponseHeaders: ['allowedResponseHeaders'],
};
python
# 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"]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.agentcore.alpha.*;

MetadataConfiguration metadataConfiguration = MetadataConfiguration.builder()
        .allowedQueryParameters(List.of("allowedQueryParameters"))
        .allowedRequestHeaders(List.of("allowedRequestHeaders"))
        .allowedResponseHeaders(List.of("allowedResponseHeaders"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;

var metadataConfiguration = new MetadataConfiguration {
    AllowedQueryParameters = new [] { "allowedQueryParameters" },
    AllowedRequestHeaders = new [] { "allowedRequestHeaders" },
    AllowedResponseHeaders = new [] { "allowedResponseHeaders" }
};
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import bedrock_agentcore_alpha "github.com/aws/aws-cdk-go/awsbedrockagentcorealpha"

metadataConfiguration := &MetadataConfiguration{
	AllowedQueryParameters: []*string{
		jsii.String("allowedQueryParameters"),
	},
	AllowedRequestHeaders: []*string{
		jsii.String("allowedRequestHeaders"),
	},
	AllowedResponseHeaders: []*string{
		jsii.String("allowedResponseHeaders"),
	},
}

Properties ​

allowedQueryParametersoptionalstring[]allowed_query_parametersoptionaltyping.List[str]allowedQueryParametersoptionalList<String>AllowedQueryParametersoptionalstring[]AllowedQueryParametersoptional*[]*string #
List of query parameter names to pass through to the target.

Default: No query parameters are passed through

Constraints:

  • Array must contain 1-10 items
  • Each parameter name must be 1-40 characters
  • Cannot be an empty array
allowedRequestHeadersoptionalstring[]allowed_request_headersoptionaltyping.List[str]allowedRequestHeadersoptionalList<String>AllowedRequestHeadersoptionalstring[]AllowedRequestHeadersoptional*[]*string #
List of request header names to pass through to the target.

Default: No request headers are passed through

Constraints:

  • Array must contain 1-10 items
  • Each header name must be 1-100 characters
  • Cannot be an empty array
allowedResponseHeadersoptionalstring[]allowed_response_headersoptionaltyping.List[str]allowedResponseHeadersoptionalList<String>AllowedResponseHeadersoptionalstring[]AllowedResponseHeadersoptional*[]*string #
List of response header names to pass through from the target.

Default: No response headers are passed through

Constraints:

  • Array must contain 1-10 items
  • Each header name must be 1-100 characters
  • Cannot be an empty array