AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Bedrock Agent Core Control Plane Fronting Layer CreateGateway API operation.

Syntax

New-BACCGateway
-CustomJWTAuthorizer_AllowedAudience <String[]>
-CustomJWTAuthorizer_AllowedClient <String[]>
-CustomJWTAuthorizer_AllowedScope <String[]>
-PolicyEngineConfiguration_Arn <String>
-AuthorizerType <AuthorizerType>
-CustomJWTAuthorizer_CustomClaim <CustomClaimValidationType[]>
-Description <String>
-CustomJWTAuthorizer_DiscoveryUrl <String>
-ExceptionLevel <ExceptionLevel>
-Mcp_Instruction <String>
-InterceptorConfiguration <GatewayInterceptorConfiguration[]>
-KmsKeyArn <String>
-PolicyEngineConfiguration_Mode <GatewayPolicyEngineMode>
-Name <String>
-ProtocolType <GatewayProtocolType>
-RoleArn <String>
-Mcp_SearchType <SearchType>
-Mcp_SupportedVersion <String[]>
-Tag <Hashtable>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockAgentCoreControlConfig>

Description

Creates a gateway for Amazon Bedrock Agent. A gateway serves as an integration point between your agent and external services. If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

Parameters

-AuthorizerType <AuthorizerType>
The type of authorizer to use for the gateway.
  • CUSTOM_JWT - Authorize with a bearer token.
  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
  • NONE - No authorization
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonBedrockAgentCoreControlConfig>
Amazon.PowerShell.Cmdlets.BACC.AmazonBedrockAgentCoreControlClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomJWTAuthorizer_AllowedAudience <String[]>
Represents individual audience values that are validated in the incoming JWT token validation process. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthorizerConfiguration_CustomJWTAuthorizer_AllowedAudience
-CustomJWTAuthorizer_AllowedClient <String[]>
Represents individual client IDs that are validated in the incoming JWT token validation process. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthorizerConfiguration_CustomJWTAuthorizer_AllowedClients
-CustomJWTAuthorizer_AllowedScope <String[]>
An array of scopes that are allowed to access the token. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthorizerConfiguration_CustomJWTAuthorizer_AllowedScopes
-CustomJWTAuthorizer_CustomClaim <CustomClaimValidationType[]>
An array of objects that define a custom claim validation name, value, and operation Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthorizerConfiguration_CustomJWTAuthorizer_CustomClaims
-CustomJWTAuthorizer_DiscoveryUrl <String>
This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthorizerConfiguration_CustomJWTAuthorizer_DiscoveryUrl
-Description <String>
The description of the gateway.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExceptionLevel <ExceptionLevel>
The level of detail in error messages returned when invoking the gateway.
  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.
  • If the value is omitted, a generic error message is returned to the end user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InterceptorConfiguration <GatewayInterceptorConfiguration[]>
A list of configuration settings for a gateway interceptor. Gateway interceptors allow custom code to be invoked during gateway invocations. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInterceptorConfigurations
-KmsKeyArn <String>
The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Mcp_Instruction <String>
The instructions for using the Model Context Protocol gateway. These instructions provide guidance on how to interact with the gateway.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProtocolConfiguration_Mcp_Instructions
-Mcp_SearchType <SearchType>
The search type for the Model Context Protocol gateway. This field specifies how the gateway handles search operations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProtocolConfiguration_Mcp_SearchType
-Mcp_SupportedVersion <String[]>
The supported versions of the Model Context Protocol. This field specifies which versions of the protocol the gateway can use. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProtocolConfiguration_Mcp_SupportedVersions
-Name <String>
The name of the gateway. The name must be unique within your account.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyEngineConfiguration_Arn <String>
The ARN of the policy engine. The policy engine contains Cedar policies that define fine-grained authorization rules specifying who can perform what actions on which resources as agents interact through the gateway.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyEngineConfiguration_Mode <GatewayPolicyEngineMode>
The enforcement mode for the policy engine. Valid values include:
  • LOG_ONLY - The policy engine evaluates each action against your policies and adds traces on whether tool calls would be allowed or denied, but does not enforce the decision. Use this mode to test and validate policies before enabling enforcement.
  • ENFORCE - The policy engine evaluates actions against your policies and enforces decisions by allowing or denying agent operations. Test and validate policies in LOG_ONLY mode before enabling enforcement to avoid unintended denials or adversely affecting production traffic.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProtocolType <GatewayProtocolType>
The protocol type for the gateway.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgentCoreControl.Model.CreateGatewayResponse). Specifying the name of a property of type Amazon.BedrockAgentCoreControl.Model.CreateGatewayResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
A map of key-value pairs to associate with the gateway as metadata tags. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.BedrockAgentCoreControl.Model.CreateGatewayResponse
This cmdlet returns an Amazon.BedrockAgentCoreControl.Model.CreateGatewayResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z