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

Syntax

New-BACCCapacityProvider
-Name <String>
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_InstanceRequirements_AllowedInstanceType <String[]>
-PermissionsConfiguration_CapacityProviderOperatorRoleArn <String>
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_CapacityReservationSpecification_CapacityReservationTarget_CapacityReservationId <String>
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_CapacityReservationSpecification_CapacityReservationPreference <CapacityReservationPreference>
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_CapacityReservationSpecification_CapacityReservationTarget_CapacityReservationResourceGroupArn <String>
-Description <String>
-ComputeConfiguration_Ec2Configuration_RootVolume_Encrypted <Boolean>
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_EphemeralVolume <EphemeralBlockDeviceMapping[]>
-ComputeConfiguration_Ec2Configuration_RootVolume_FreeSpaceGiB <Int32>
-ComputeConfiguration_Ec2Configuration_LifecycleConfiguration_IdleInstanceTimeout <Int32>
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_InstanceProfileArn <String>
-ComputeConfiguration_Ec2Configuration_RootVolume_Iops <Int32>
-ComputeConfiguration_Ec2Configuration_RootVolume_KmsKeyId <String>
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_LicenseSpecification <LicenseSpecification[]>
-ComputeConfiguration_Ec2Configuration_LifecycleConfiguration_MaxLifetime <Int32>
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_Monitoring <Monitoring>
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_OperatingSystem <OperatingSystem>
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_PropagatedTag <Hashtable>
-ComputeConfiguration_Ec2Configuration_VpcConfiguration_SecurityGroup <String[]>
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_SshKeyName <String>
-ComputeConfiguration_Ec2Configuration_VpcConfiguration_Subnet <String[]>
-Tag <Hashtable>
-ComputeConfiguration_Ec2Configuration_RootVolume_Throughput <Int32>
-ComputeConfiguration_Ec2Configuration_Volume <VolumeConfiguration[]>
-ComputeConfiguration_Ec2Configuration_RootVolume_VolumeType <EbsVolumeType>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockAgentCoreControlConfig>

Description

Creates a capacity provider. A capacity provider defines the Amazon EC2 infrastructure for AgentCore Runtime, including the operating system, allowed instance types, networking, and storage. It also specifies the IAM permissions that AgentCore uses to manage those instances. The capacity provider name must be unique within your account. After you create the capacity provider, it enters a CREATING state and transitions to READY when it is available for use.

Parameters

-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)
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_CapacityReservationSpecification_CapacityReservationPreference <CapacityReservationPreference>
The Capacity Reservation preference for the instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_CapacityReservationSpecification_CapacityReservationTarget_CapacityReservationId <String>
The ID of the Capacity Reservation in which to run the instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_CapacityReservationSpecification_CapacityReservationTarget_CapacityReservationResourceGroupArn <String>
The Amazon Resource Name (ARN) of the Capacity Reservation resource group in which to run the instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_EphemeralVolume <EphemeralBlockDeviceMapping[]>
The block device mappings for instance store (ephemeral) volumes. You can specify up to five mappings. 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)
AliasesComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_EphemeralVolumes
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_InstanceProfileArn <String>
The Amazon Resource Name (ARN) of the IAM instance profile to associate with launched instances. If provided, this overrides the default instance profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_InstanceRequirements_AllowedInstanceType <String[]>
The list of allowed instance types. You can specify up to 30 instance types. 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)
AliasesComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_InstanceRequirements_AllowedInstanceTypes
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_LicenseSpecification <LicenseSpecification[]>
The license configurations to associate with the instances. You can specify up to five configurations. 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)
AliasesComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_LicenseSpecifications
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_Monitoring <Monitoring>
The monitoring level for the instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_OperatingSystem <OperatingSystem>
The operating system and CPU architecture for the instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_PropagatedTag <Hashtable>
The tags to propagate to all Amazon EC2 resources (instances, volumes, and network interfaces) that the capacity provider creates. 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)
AliasesComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_PropagatedTags
-ComputeConfiguration_Ec2Configuration_LaunchTemplateSource_LaunchParameters_SshKeyName <String>
The name of the SSH key pair to configure on the instances for SSH connectivity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_LifecycleConfiguration_IdleInstanceTimeout <Int32>
The number of seconds an instance can remain idle before it is stopped. An instance is considered idle when all of its agents are idle. The default is 900 seconds (15 minutes).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_LifecycleConfiguration_MaxLifetime <Int32>
The maximum lifetime of an instance, in seconds. When an instance reaches this limit, the service terminates it regardless of activity. The default is 28800 seconds (8 hours). The maximum is 1209600 seconds (14 days).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_RootVolume_Encrypted <Boolean>
Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot specify an encryption value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_RootVolume_FreeSpaceGiB <Int32>
The free space guaranteed on the root volume, in GiB. AgentCore adds the operating system overhead on top of this value. The default is 8 GiB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_RootVolume_Iops <Int32>
The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. Supported values: gp3, 3,000–80,000; io1, 100–64,000; io2, 100–256,000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_RootVolume_KmsKeyId <String>
The identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for Amazon EBS encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_RootVolume_Throughput <Int32>
The throughput to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125–2,000 MiB/s.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_RootVolume_VolumeType <EbsVolumeType>
The Amazon EBS volume type. If you do not specify a type, the default is gp3.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfiguration_Ec2Configuration_Volume <VolumeConfiguration[]>
The named persistent Amazon EBS volumes for the capacity provider. A capacity provider can define up to five volumes. 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)
AliasesComputeConfiguration_Ec2Configuration_Volumes
-ComputeConfiguration_Ec2Configuration_VpcConfiguration_SecurityGroup <String[]>
The IDs of the security groups to associate with the instances. You must specify at least one security group. 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)
AliasesComputeConfiguration_Ec2Configuration_VpcConfiguration_SecurityGroups
-ComputeConfiguration_Ec2Configuration_VpcConfiguration_Subnet <String[]>
The IDs of the subnets in which to launch instances. You must specify at least one subnet. 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)
AliasesComputeConfiguration_Ec2Configuration_VpcConfiguration_Subnets
-Description <String>
An optional description of the capacity provider. If you don't specify a description, the service creates the capacity provider without one.
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)
-Name <String>
The name of the capacity provider. The name must be unique within your account.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PermissionsConfiguration_CapacityProviderOperatorRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that AgentCore assumes to manage the capacity provider, including launching, tagging, and terminating instances and their network interfaces. We recommend scoping this role to the minimum permissions that your workloads require.
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.CreateCapacityProviderResponse). Specifying the name of a property of type Amazon.BedrockAgentCoreControl.Model.CreateCapacityProviderResponse 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 associate with the capacity provider. If you don't specify tags, the capacity provider is created with no 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.CreateCapacityProviderResponse
This cmdlet returns an Amazon.BedrockAgentCoreControl.Model.CreateCapacityProviderResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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