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

Syntax

New-ECSCapacityProvider
-Name <String>
-InstanceRequirements_AcceleratorManufacturer <String[]>
-InstanceRequirements_AcceleratorName <String[]>
-InstanceRequirements_AcceleratorType <String[]>
-InstanceRequirements_AllowedInstanceType <String[]>
-AutoScalingGroupProvider_AutoScalingGroupArn <String>
-InstanceRequirements_BareMetal <BareMetal>
-InstanceRequirements_BurstablePerformance <BurstablePerformance>
-ManagedInstancesProvider_InstanceLaunchTemplate_CapacityOptionType <CapacityOptionType>
-Cluster <String>
-InstanceRequirements_CpuManufacturer <String[]>
-InstanceLaunchTemplate_Ec2InstanceProfileArn <String>
-InstanceRequirements_ExcludedInstanceType <String[]>
-ManagedInstancesProvider_InfrastructureRoleArn <String>
-InstanceRequirements_InstanceGeneration <String[]>
-ManagedScaling_InstanceWarmupPeriod <Int32>
-InstanceRequirements_LocalStorage <LocalStorage>
-InstanceRequirements_LocalStorageType <String[]>
-AutoScalingGroupProvider_ManagedDraining <ManagedDraining>
-AutoScalingGroupProvider_ManagedTerminationProtection <ManagedTerminationProtection>
-AcceleratorCount_Max <Int32>
-AcceleratorTotalMemoryMiB_Max <Int32>
-BaselineEbsBandwidthMbps_Max <Int32>
-MemoryGiBPerVCpu_Max <Double>
-MemoryMiB_Max <Int32>
-NetworkBandwidthGbps_Max <Double>
-NetworkInterfaceCount_Max <Int32>
-TotalLocalStorageGB_Max <Double>
-VCpuCount_Max <Int32>
-ManagedScaling_MaximumScalingStepSize <Int32>
-InstanceRequirements_MaxSpotPriceAsPercentageOfOptimalOnDemandPrice <Int32>
-AcceleratorCount_Min <Int32>
-AcceleratorTotalMemoryMiB_Min <Int32>
-BaselineEbsBandwidthMbps_Min <Int32>
-MemoryGiBPerVCpu_Min <Double>
-MemoryMiB_Min <Int32>
-NetworkBandwidthGbps_Min <Double>
-NetworkInterfaceCount_Min <Int32>
-TotalLocalStorageGB_Min <Double>
-VCpuCount_Min <Int32>
-ManagedScaling_MinimumScalingStepSize <Int32>
-InstanceLaunchTemplate_Monitoring <ManagedInstancesMonitoringOptions>
-InstanceRequirements_OnDemandMaxPricePercentageOverLowestPrice <Int32>
-ManagedInstancesProvider_PropagateTag <PropagateMITags>
-InstanceRequirements_RequireHibernateSupport <Boolean>
-InfrastructureOptimization_ScaleInAfter <Int32>
-NetworkConfiguration_SecurityGroup <String[]>
-InstanceRequirements_SpotMaxPricePercentageOverLowestPrice <Int32>
-ManagedScaling_Status <ManagedScalingStatus>
-StorageConfiguration_StorageSizeGiB <Int32>
-NetworkConfiguration_Subnet <String[]>
-Tag <Tag[]>
-ManagedScaling_TargetCapacity <Int32>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonECSConfig>

Description

Creates a capacity provider. Capacity providers are associated with a cluster and are used in capacity provider strategies to facilitate cluster auto scaling. You can create capacity providers for Amazon ECS Managed Instances and EC2 instances. Fargate has the predefined FARGATE and FARGATE_SPOT capacity providers.

Parameters

-AcceleratorCount_Max <Int32>
The maximum number of accelerators. Instance types with more accelerators are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_AcceleratorCount_Max
-AcceleratorCount_Min <Int32>
The minimum number of accelerators. Instance types with fewer accelerators are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_AcceleratorCount_Min
-AcceleratorTotalMemoryMiB_Max <Int32>
The maximum total accelerator memory in MiB. Instance types with more accelerator memory are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_AcceleratorTotalMemoryMiB_Max
-AcceleratorTotalMemoryMiB_Min <Int32>
The minimum total accelerator memory in MiB. Instance types with less accelerator memory are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_AcceleratorTotalMemoryMiB_Min
-AutoScalingGroupProvider_AutoScalingGroupArn <String>
The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoScalingGroupProvider_ManagedDraining <ManagedDraining>
The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoScalingGroupProvider_ManagedTerminationProtection <ManagedTerminationProtection>
The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BaselineEbsBandwidthMbps_Max <Int32>
The maximum baseline Amazon EBS bandwidth in Mbps. Instance types with higher Amazon EBS bandwidth are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_BaselineEbsBandwidthMbps_Max
-BaselineEbsBandwidthMbps_Min <Int32>
The minimum baseline Amazon EBS bandwidth in Mbps. Instance types with lower Amazon EBS bandwidth are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_BaselineEbsBandwidthMbps_Min
-ClientConfig <AmazonECSConfig>
Amazon.PowerShell.Cmdlets.ECS.AmazonECSClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Cluster <String>
The name of the cluster to associate with the capacity provider. When you create a capacity provider with Amazon ECS Managed Instances, it becomes available only within the specified cluster.
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)
-InfrastructureOptimization_ScaleInAfter <Int32>
This parameter defines the number of seconds Amazon ECS Managed Instances waits before optimizing EC2 instances that have become idle or underutilized. A longer delay increases the likelihood of placing new tasks on idle or underutilized instances instances, reducing startup time. A shorter delay helps reduce infrastructure costs by optimizing idle or underutilized instances,instances more quickly.Valid values are:
  • null - Uses the default optimization behavior.
  • -1 - Disables automatic infrastructure optimization.
  • A value between 0 and 3600 (inclusive) - Specifies the number of seconds to wait before optimizing instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InfrastructureOptimization_ScaleInAfter
-InstanceLaunchTemplate_Ec2InstanceProfileArn <String>
The Amazon Resource Name (ARN) of the instance profile that Amazon ECS applies to Amazon ECS Managed Instances. This instance profile must include the necessary permissions for your tasks to access Amazon Web Services services and resources.For more information, see Amazon ECS instance profile for Managed Instances in the Amazon ECS Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_Ec2InstanceProfileArn
-InstanceLaunchTemplate_Monitoring <ManagedInstancesMonitoringOptions>
CloudWatch provides two categories of monitoring: basic monitoring and detailed monitoring. By default, your managed instance is configured for basic monitoring. You can optionally enable detailed monitoring to help you more quickly identify and act on operational issues. You can enable or turn off detailed monitoring at launch or when the managed instance is running or stopped. For more information, see Detailed monitoring for Amazon ECS Managed Instances in the Amazon ECS Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_Monitoring
-InstanceRequirements_AcceleratorManufacturer <String[]>
The accelerator manufacturers to include. You can specify nvidia, amd, amazon-web-services, or xilinx depending on your accelerator requirements. 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)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_AcceleratorManufacturers
-InstanceRequirements_AcceleratorName <String[]>
The specific accelerator names to include. For example, you can specify a100, v100, k80, or other specific accelerator models. 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)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_AcceleratorNames
-InstanceRequirements_AcceleratorType <String[]>
The accelerator types to include. You can specify gpu for graphics processing units, fpga for field programmable gate arrays, or inference for machine learning inference accelerators. 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)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_AcceleratorTypes
-InstanceRequirements_AllowedInstanceType <String[]>
The instance types to include in the selection. When specified, Amazon ECS only considers these instance types, subject to the other requirements specified. 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)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_AllowedInstanceTypes
-InstanceRequirements_BareMetal <BareMetal>
Indicates whether to include bare metal instance types. Set to included to allow bare metal instances, excluded to exclude them, or required to use only bare metal instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_BareMetal
-InstanceRequirements_BurstablePerformance <BurstablePerformance>
Indicates whether to include burstable performance instance types (T2, T3, T3a, T4g). Set to included to allow burstable instances, excluded to exclude them, or required to use only burstable instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_BurstablePerformance
-InstanceRequirements_CpuManufacturer <String[]>
The CPU manufacturers to include or exclude. You can specify intel, amd, or amazon-web-services to control which CPU types are used for your workloads. 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)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_CpuManufacturers
-InstanceRequirements_ExcludedInstanceType <String[]>
The instance types to exclude from selection. Use this to prevent Amazon ECS from selecting specific instance types that may not be suitable for your workloads. 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)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_ExcludedInstanceTypes
-InstanceRequirements_InstanceGeneration <String[]>
The instance generations to include. You can specify current to use the latest generation instances, or previous to include previous generation instances for cost optimization. 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)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_InstanceGenerations
-InstanceRequirements_LocalStorage <LocalStorage>
Indicates whether to include instance types with local storage. Set to included to allow local storage, excluded to exclude it, or required to use only instances with local storage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_LocalStorage
-InstanceRequirements_LocalStorageType <String[]>
The local storage types to include. You can specify hdd for hard disk drives, ssd for solid state drives, or both. 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)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_LocalStorageTypes
-InstanceRequirements_MaxSpotPriceAsPercentageOfOptimalOnDemandPrice <Int32>
The maximum price for Spot instances as a percentage of the optimal On-Demand price. This provides more precise cost control for Spot instance selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_MaxSpotPriceAsPercentageOfOptimalOnDemandPrice
-InstanceRequirements_OnDemandMaxPricePercentageOverLowestPrice <Int32>
The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon ECS selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_OnDemandMaxPricePercentageOverLowestPrice
-InstanceRequirements_RequireHibernateSupport <Boolean>
Indicates whether the instance types must support hibernation. When set to true, only instance types that support hibernation are selected.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_RequireHibernateSupport
-InstanceRequirements_SpotMaxPricePercentageOverLowestPrice <Int32>
The maximum price for Spot instances as a percentage over the lowest priced On-Demand instance. This helps control Spot instance costs while maintaining access to capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_SpotMaxPricePercentageOverLowestPrice
-ManagedInstancesProvider_InfrastructureRoleArn <String>
The Amazon Resource Name (ARN) of the infrastructure role that Amazon ECS uses to manage instances on your behalf. This role must have permissions to launch, terminate, and manage Amazon EC2 instances, as well as access to other Amazon Web Services services required for Amazon ECS Managed Instances functionality.For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstancesProvider_InstanceLaunchTemplate_CapacityOptionType <CapacityOptionType>
The capacity option type. This determines whether Amazon ECS launches On-Demand or Spot Instances for your managed instance capacity provider.Valid values are:
  • ON_DEMAND - Launches standard On-Demand Instances. On-Demand Instances provide predictable pricing and availability.
  • SPOT - Launches Spot Instances that use spare Amazon EC2 capacity at reduced cost. Spot Instances can be interrupted by Amazon EC2 with a two-minute notification when the capacity is needed back.
The default is On-DemandFor more information about Amazon EC2 capacity options, see Instance purchasing options in the Amazon EC2 User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedInstancesProvider_PropagateTag <PropagateMITags>
Specifies whether to propagate tags from the capacity provider to the Amazon ECS Managed Instances. When enabled, tags applied to the capacity provider are automatically applied to all instances launched by this provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_PropagateTags
-ManagedScaling_InstanceWarmupPeriod <Int32>
The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingGroupProvider_ManagedScaling_InstanceWarmupPeriod
-ManagedScaling_MaximumScalingStepSize <Int32>
The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default value of 10000 is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingGroupProvider_ManagedScaling_MaximumScalingStepSize
-ManagedScaling_MinimumScalingStepSize <Int32>
The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingGroupProvider_ManagedScaling_MinimumScalingStepSize
-ManagedScaling_Status <ManagedScalingStatus>
Determines whether to use managed scaling for the capacity provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingGroupProvider_ManagedScaling_Status
-ManagedScaling_TargetCapacity <Int32>
The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use a targetCapacity of 90. The default value of 100 percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingGroupProvider_ManagedScaling_TargetCapacity
-MemoryGiBPerVCpu_Max <Double>
The maximum amount of memory per vCPU in GiB. Instance types with a higher memory-to-vCPU ratio are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_MemoryGiBPerVCpu_Max
-MemoryGiBPerVCpu_Min <Double>
The minimum amount of memory per vCPU in GiB. Instance types with a lower memory-to-vCPU ratio are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_MemoryGiBPerVCpu_Min
-MemoryMiB_Max <Int32>
The maximum amount of memory in MiB. Instance types with more memory than this value are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_MemoryMiB_Max
-MemoryMiB_Min <Int32>
The minimum amount of memory in MiB. Instance types with less memory than this value are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_MemoryMiB_Min
-Name <String>
The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with "aws", "ecs", or "fargate".
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-NetworkBandwidthGbps_Max <Double>
The maximum network bandwidth in Gbps. Instance types with higher network bandwidth are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_NetworkBandwidthGbps_Max
-NetworkBandwidthGbps_Min <Double>
The minimum network bandwidth in Gbps. Instance types with lower network bandwidth are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_NetworkBandwidthGbps_Min
-NetworkConfiguration_SecurityGroup <String[]>
The list of security group IDs to apply to Amazon ECS Managed Instances. These security groups control the network traffic allowed to and from the instances. 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)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_NetworkConfiguration_SecurityGroups
-NetworkConfiguration_Subnet <String[]>
The list of subnet IDs where Amazon ECS can launch Amazon ECS Managed Instances. Instances are distributed across the specified subnets for high availability. All subnets must be in the same VPC. 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)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_NetworkConfiguration_Subnets
-NetworkInterfaceCount_Max <Int32>
The maximum number of network interfaces. Instance types that support more network interfaces are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_NetworkInterfaceCount_Max
-NetworkInterfaceCount_Min <Int32>
The minimum number of network interfaces. Instance types that support fewer network interfaces are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_NetworkInterfaceCount_Min
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'CapacityProvider'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ECS.Model.CreateCapacityProviderResponse). Specifying the name of a property of type Amazon.ECS.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)
-StorageConfiguration_StorageSizeGiB <Int32>
The size of the tasks volume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_StorageConfiguration_StorageSizeGiB
-Tag <Tag[]>
The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.The following basic restrictions apply to tags:
  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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
-TotalLocalStorageGB_Max <Double>
The maximum total local storage in GB. Instance types with more local storage are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_TotalLocalStorageGB_Max
-TotalLocalStorageGB_Min <Double>
The minimum total local storage in GB. Instance types with less local storage are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_TotalLocalStorageGB_Min
-VCpuCount_Max <Int32>
The maximum number of vCPUs. Instance types with more vCPUs than this value are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_VCpuCount_Max
-VCpuCount_Min <Int32>
The minimum number of vCPUs. Instance types with fewer vCPUs than this value are excluded from selection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_VCpuCount_Min

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.ECS.Model.CapacityProvider or Amazon.ECS.Model.CreateCapacityProviderResponse
This cmdlet returns an Amazon.ECS.Model.CapacityProvider object. The service call response (type Amazon.ECS.Model.CreateCapacityProviderResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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