Interface CfnGatewayProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGatewayProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
date="2026-09-10T17:51:39.979Z")
@Stability(Stable)
public interface CfnGatewayProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnGateway.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrockagentcore.*;
CfnGatewayProps cfnGatewayProps = CfnGatewayProps.builder()
.authorizerType("authorizerType")
.name("name")
.roleArn("roleArn")
// the properties below are optional
.authorizerConfiguration(AuthorizerConfigurationProperty.builder()
.customJwtAuthorizer(CustomJWTAuthorizerConfigurationProperty.builder()
.discoveryUrl("discoveryUrl")
// the properties below are optional
.advertisedScopeMapping(Map.of(
"advertisedScopeMappingKey", "advertisedScopeMapping"))
.allowedAudience(List.of("allowedAudience"))
.allowedClients(List.of("allowedClients"))
.allowedScopes(List.of("allowedScopes"))
.customClaims(List.of(CustomClaimValidationTypeProperty.builder()
.authorizingClaimMatchValue(AuthorizingClaimMatchValueTypeProperty.builder()
.claimMatchOperator("claimMatchOperator")
.claimMatchValue(ClaimMatchValueTypeProperty.builder()
.matchValueString("matchValueString")
.matchValueStringList(List.of("matchValueStringList"))
.build())
.build())
.inboundTokenClaimName("inboundTokenClaimName")
.inboundTokenClaimValueType("inboundTokenClaimValueType")
.build()))
.privateEndpoint(PrivateEndpointProperty.builder()
.managedVpcResource(ManagedVpcResourceProperty.builder()
.endpointIpAddressType("endpointIpAddressType")
.subnetIds(List.of("subnetIds"))
.vpcIdentifier("vpcIdentifier")
// the properties below are optional
.routingDomain("routingDomain")
.securityGroupIds(List.of("securityGroupIds"))
.build())
.selfManagedLatticeResource(SelfManagedLatticeResourceProperty.builder()
.resourceConfigurationIdentifier("resourceConfigurationIdentifier")
.build())
.build())
.build())
.build())
.description("description")
.exceptionLevel("exceptionLevel")
.interceptorConfigurations(List.of(GatewayInterceptorConfigurationProperty.builder()
.interceptionPoints(List.of("interceptionPoints"))
.interceptor(InterceptorConfigurationProperty.builder()
.lambda(LambdaInterceptorConfigurationProperty.builder()
.arn("arn")
.build())
.build())
// the properties below are optional
.inputConfiguration(InterceptorInputConfigurationProperty.builder()
.passRequestHeaders(false)
// the properties below are optional
.payloadFilter(InterceptorPayloadFilterProperty.builder()
.exclude(List.of(InterceptorPayloadExclusionSelectorProperty.builder()
.field("field")
.build()))
.build())
.build())
.build()))
.kmsKeyArn("kmsKeyArn")
.policyEngineConfiguration(GatewayPolicyEngineConfigurationProperty.builder()
.arn("arn")
.mode("mode")
.build())
.protocolConfiguration(GatewayProtocolConfigurationProperty.builder()
.mcp(MCPGatewayConfigurationProperty.builder()
.instructions("instructions")
.searchType("searchType")
.sessionConfiguration(SessionConfigurationProperty.builder()
.sessionTimeoutInSeconds(123)
.build())
.streamingConfiguration(StreamingConfigurationProperty.builder()
.enableResponseStreaming(false)
.build())
.supportedVersions(List.of("supportedVersions"))
.build())
.build())
.protocolType("protocolType")
.tags(Map.of(
"tagsKey", "tags"))
.wafConfiguration(WafConfigurationProperty.builder()
.failureMode("failureMode")
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnGatewayPropsstatic final classAn implementation forCfnGatewayProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnGatewayProps.Builderbuilder()default ObjectReturns union: eitherIResolvableorCfnGateway.AuthorizerConfigurationPropertyThe authorizer type for the gateway.default StringThe description for the gateway.default StringThe exception level for the gateway.default ObjectReturns union: eitherIResolvableor Listinvalid input: '<'eitherIResolvableorCfnGateway.GatewayInterceptorConfigurationProperty>default StringThe KMS key ARN for the gateway.getName()The name for the gateway.default ObjectReturns union: eitherIResolvableorCfnGateway.GatewayPolicyEngineConfigurationPropertydefault ObjectThe protocol configuration for the gateway target.default StringThe protocol type for the gateway target.getTags()The tags for the gateway.default ObjectReturns union: eitherIResolvableorCfnGateway.WafConfigurationPropertyMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAuthorizerType
The authorizer type for the gateway.- See Also:
-
getName
The name for the gateway.- See Also:
-
getRoleArn
- See Also:
-
getAuthorizerConfiguration
Returns union: eitherIResolvableorCfnGateway.AuthorizerConfigurationProperty- See Also:
-
getDescription
The description for the gateway.- See Also:
-
getExceptionLevel
The exception level for the gateway.- See Also:
-
getInterceptorConfigurations
Returns union: eitherIResolvableor Listinvalid input: '<'eitherIResolvableorCfnGateway.GatewayInterceptorConfigurationProperty>- See Also:
-
getKmsKeyArn
The KMS key ARN for the gateway.- See Also:
-
getPolicyEngineConfiguration
Returns union: eitherIResolvableorCfnGateway.GatewayPolicyEngineConfigurationProperty- See Also:
-
getProtocolConfiguration
The protocol configuration for the gateway target.Returns union: either
IResolvableorCfnGateway.GatewayProtocolConfigurationProperty- See Also:
-
getProtocolType
The protocol type for the gateway target.- See Also:
-
getTags
The tags for the gateway.- See Also:
-
getWafConfiguration
Returns union: eitherIResolvableorCfnGateway.WafConfigurationProperty- See Also:
-
builder
- Returns:
- a
CfnGatewayProps.BuilderofCfnGatewayProps
-