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 CreateAgentRuntime API operation.

Syntax

New-BACCAgentRuntime
-AgentRuntimeName <String>
-CustomJWTAuthorizer_AllowedAudience <String[]>
-CustomJWTAuthorizer_AllowedClient <String[]>
-CustomJWTAuthorizer_AllowedScope <String[]>
-S3_Bucket <String>
-ContainerConfiguration_ContainerUri <String>
-CustomJWTAuthorizer_CustomClaim <CustomClaimValidationType[]>
-Description <String>
-CustomJWTAuthorizer_DiscoveryUrl <String>
-CodeConfiguration_EntryPoint <String[]>
-EnvironmentVariable <Hashtable>
-LifecycleConfiguration_IdleRuntimeSessionTimeout <Int32>
-LifecycleConfiguration_MaxLifetime <Int32>
-NetworkConfiguration_NetworkMode <NetworkMode>
-S3_Prefix <String>
-RequestHeaderConfiguration_RequestHeaderAllowlist <String[]>
-RoleArn <String>
-CodeConfiguration_Runtime <AgentManagedRuntimeType>
-NetworkModeConfig_SecurityGroup <String[]>
-ProtocolConfiguration_ServerProtocol <ServerProtocol>
-NetworkModeConfig_Subnet <String[]>
-Tag <Hashtable>
-S3_VersionId <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockAgentCoreControlConfig>

Description

Creates an Amazon Bedrock AgentCore Runtime.

Parameters

-AgentRuntimeName <String>
The name of the AgentCore Runtime.
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 idempotency of the request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CodeConfiguration_EntryPoint <String[]>
The entry point for the code execution, specifying the function or method that should be invoked when the code runs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAgentRuntimeArtifact_CodeConfiguration_EntryPoint
-CodeConfiguration_Runtime <AgentManagedRuntimeType>
The runtime environment for executing the code (for example, Python 3.9 or Node.js 18).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAgentRuntimeArtifact_CodeConfiguration_Runtime
-ContainerConfiguration_ContainerUri <String>
The ECR URI of the container.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAgentRuntimeArtifact_ContainerConfiguration_ContainerUri
-CustomJWTAuthorizer_AllowedAudience <String[]>
Represents individual audience values that are validated in the incoming JWT token validation process.
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.
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.
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
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 AgentCore Runtime.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnvironmentVariable <Hashtable>
Environment variables to set in the AgentCore Runtime environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnvironmentVariables
-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)
-LifecycleConfiguration_IdleRuntimeSessionTimeout <Int32>
Timeout in seconds for idle runtime sessions. When a session remains idle for this duration, it will be automatically terminated. Default: 900 seconds (15 minutes).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LifecycleConfiguration_MaxLifetime <Int32>
Maximum lifetime for the instance in seconds. Once reached, instances will be automatically terminated and replaced. Default: 28800 seconds (8 hours).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkConfiguration_NetworkMode <NetworkMode>
The network mode for the AgentCore Runtime.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkModeConfig_SecurityGroup <String[]>
The security groups associated with the VPC configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_NetworkModeConfig_SecurityGroups
-NetworkModeConfig_Subnet <String[]>
The subnets associated with the VPC configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_NetworkModeConfig_Subnets
-ProtocolConfiguration_ServerProtocol <ServerProtocol>
The server protocol for the agent runtime. This field specifies which protocol the agent runtime uses to communicate with clients.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RequestHeaderConfiguration_RequestHeaderAllowlist <String[]>
A list of HTTP request headers that are allowed to be passed through to the runtime.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
The IAM role ARN that provides permissions for the AgentCore Runtime.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3_Bucket <String>
The name of the Amazon S3 bucket. This bucket contains the stored data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAgentRuntimeArtifact_CodeConfiguration_Code_S3_Bucket
-S3_Prefix <String>
The prefix for objects in the Amazon S3 bucket. This prefix is added to the object keys to organize the data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAgentRuntimeArtifact_CodeConfiguration_Code_S3_Prefix
-S3_VersionId <String>
The version ID of the Amazon Amazon S3 object. If not specified, the latest version of the object is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAgentRuntimeArtifact_CodeConfiguration_Code_S3_VersionId
-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.CreateAgentRuntimeResponse). Specifying the name of a property of type Amazon.BedrockAgentCoreControl.Model.CreateAgentRuntimeResponse 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 tag keys and values to assign to the agent runtime. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
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.CreateAgentRuntimeResponse
This cmdlet returns an Amazon.BedrockAgentCoreControl.Model.CreateAgentRuntimeResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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