Package software.amazon.awscdk.services.bedrockagentcore

Class CfnGateway

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.bedrockagentcore.CfnGateway
All Implemented Interfaces:
IInspectable, IGatewayRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:15.835Z") @Stability(Stable) public class CfnGateway extends CfnResource implements IInspectable, IGatewayRef, ITaggableV2
Amazon Bedrock AgentCore Gateway provides a unified connectivity layer between agents and the tools and resources they need to interact with.

For more information about creating a gateway, see Set up an Amazon Bedrock AgentCore gateway .

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

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.*;
 CfnGateway cfnGateway = CfnGateway.Builder.create(this, "MyCfnGateway")
         .authorizerType("authorizerType")
         .name("name")
         .protocolType("protocolType")
         .roleArn("roleArn")
         // the properties below are optional
         .authorizerConfiguration(AuthorizerConfigurationProperty.builder()
                 .customJwtAuthorizer(CustomJWTAuthorizerConfigurationProperty.builder()
                         .discoveryUrl("discoveryUrl")
                         // the properties below are optional
                         .allowedAudience(List.of("allowedAudience"))
                         .allowedClients(List.of("allowedClients"))
                         .build())
                 .build())
         .description("description")
         .exceptionLevel("exceptionLevel")
         .kmsKeyArn("kmsKeyArn")
         .protocolConfiguration(GatewayProtocolConfigurationProperty.builder()
                 .mcp(MCPGatewayConfigurationProperty.builder()
                         .instructions("instructions")
                         .searchType("searchType")
                         .supportedVersions(List.of("supportedVersions"))
                         .build())
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnGateway

      protected CfnGateway(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnGateway

      protected CfnGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnGateway

      @Stability(Stable) public CfnGateway(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGatewayProps props)
      Create a new AWS::BedrockAgentCore::Gateway.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForGateway

      @Stability(Stable) @NotNull public static String arnForGateway(@NotNull IGatewayRef resource)
      Parameters:
      resource - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The date and time at which the gateway was created.

    • getAttrGatewayArn

      @Stability(Stable) @NotNull public String getAttrGatewayArn()
      The ARN for the gateway.

    • getAttrGatewayIdentifier

      @Stability(Stable) @NotNull public String getAttrGatewayIdentifier()

    • getAttrGatewayUrl

      @Stability(Stable) @NotNull public String getAttrGatewayUrl()
      The gateway URL for the gateway.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status for the gateway.

    • getAttrStatusReasons

      @Stability(Stable) @NotNull public List<String> getAttrStatusReasons()
      The status reasons for the gateway.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()

    • getAttrWorkloadIdentityDetails

      @Stability(Stable) @NotNull public IResolvable getAttrWorkloadIdentityDetails()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getGatewayRef

      @Stability(Stable) @NotNull public GatewayReference getGatewayRef()
      A reference to a Gateway resource.
      Specified by:
      getGatewayRef in interface IGatewayRef

    • getAuthorizerType

      @Stability(Stable) @NotNull public String getAuthorizerType()
      The authorizer type for the gateway.

    • setAuthorizerType

      @Stability(Stable) public void setAuthorizerType(@NotNull String value)
      The authorizer type for the gateway.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name for the gateway.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name for the gateway.

    • getProtocolType

      @Stability(Stable) @NotNull public String getProtocolType()
      The protocol type for the gateway target.

    • setProtocolType

      @Stability(Stable) public void setProtocolType(@NotNull String value)
      The protocol type for the gateway target.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)

    • getAuthorizerConfiguration

      @Stability(Stable) @Nullable public Object getAuthorizerConfiguration()
      Returns union: either IResolvable or CfnGateway.AuthorizerConfigurationProperty

    • setAuthorizerConfiguration

      @Stability(Stable) public void setAuthorizerConfiguration(@Nullable IResolvable value)

    • setAuthorizerConfiguration

      @Stability(Stable) public void setAuthorizerConfiguration(@Nullable CfnGateway.AuthorizerConfigurationProperty value)

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description for the gateway.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description for the gateway.

    • getExceptionLevel

      @Stability(Stable) @Nullable public String getExceptionLevel()
      The exception level for the gateway.

    • setExceptionLevel

      @Stability(Stable) public void setExceptionLevel(@Nullable String value)
      The exception level for the gateway.

    • getKmsKeyArn

      @Stability(Stable) @Nullable public String getKmsKeyArn()
      The KMS key ARN for the gateway.

    • setKmsKeyArn

      @Stability(Stable) public void setKmsKeyArn(@Nullable String value)
      The KMS key ARN for the gateway.

    • getProtocolConfiguration

      @Stability(Stable) @Nullable public Object getProtocolConfiguration()
      The protocol configuration for the gateway target.

      Returns union: either IResolvable or CfnGateway.GatewayProtocolConfigurationProperty

    • setProtocolConfiguration

      @Stability(Stable) public void setProtocolConfiguration(@Nullable IResolvable value)
      The protocol configuration for the gateway target.

    • setProtocolConfiguration

      @Stability(Stable) public void setProtocolConfiguration(@Nullable CfnGateway.GatewayProtocolConfigurationProperty value)
      The protocol configuration for the gateway target.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      The tags for the gateway.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      The tags for the gateway.