CfnCapacityProviderProps
- class aws_cdk.aws_ecs.CfnCapacityProviderProps(*, auto_scaling_group_provider=None, cluster_name=None, managed_instances_provider=None, name=None, tags=None)
Bases:
objectProperties for defining a
CfnCapacityProvider.- Parameters:
auto_scaling_group_provider (
Union[IResolvable,AutoScalingGroupProviderProperty,Dict[str,Any],None]) – The Auto Scaling group settings for the capacity provider.cluster_name (
Optional[str]) – The cluster that this capacity provider is associated with. Managed instances capacity providers are cluster-scoped, meaning they can only be used within their associated cluster. This is required for Managed instances.managed_instances_provider (
Union[IResolvable,ManagedInstancesProviderProperty,Dict[str,Any],None]) – The configuration for the Amazon ECS Managed Instances provider. This includes the infrastructure role, the launch template configuration, and tag propagation settings.name (
Optional[str]) – The name of the capacity provider. If a name is specified, it cannot start withaws,ecs, orfargate. If no name is specified, a default name in theCFNStackName-CFNResourceName-RandomStringformat is used.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both. 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: + - = . _ : /
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs cfn_capacity_provider_props = ecs.CfnCapacityProviderProps( auto_scaling_group_provider=ecs.CfnCapacityProvider.AutoScalingGroupProviderProperty( auto_scaling_group_arn="autoScalingGroupArn", # the properties below are optional managed_draining="managedDraining", managed_scaling=ecs.CfnCapacityProvider.ManagedScalingProperty( instance_warmup_period=123, maximum_scaling_step_size=123, minimum_scaling_step_size=123, status="status", target_capacity=123 ), managed_termination_protection="managedTerminationProtection" ), cluster_name="clusterName", managed_instances_provider=ecs.CfnCapacityProvider.ManagedInstancesProviderProperty( infrastructure_role_arn="infrastructureRoleArn", instance_launch_template=ecs.CfnCapacityProvider.InstanceLaunchTemplateProperty( ec2_instance_profile_arn="ec2InstanceProfileArn", network_configuration=ecs.CfnCapacityProvider.ManagedInstancesNetworkConfigurationProperty( subnets=["subnets"], # the properties below are optional security_groups=["securityGroups"] ), # the properties below are optional instance_requirements=ecs.CfnCapacityProvider.InstanceRequirementsRequestProperty( memory_mi_b=ecs.CfnCapacityProvider.MemoryMiBRequestProperty( min=123, # the properties below are optional max=123 ), v_cpu_count=ecs.CfnCapacityProvider.VCpuCountRangeRequestProperty( min=123, # the properties below are optional max=123 ), # the properties below are optional accelerator_count=ecs.CfnCapacityProvider.AcceleratorCountRequestProperty( max=123, min=123 ), accelerator_manufacturers=["acceleratorManufacturers"], accelerator_names=["acceleratorNames"], accelerator_total_memory_mi_b=ecs.CfnCapacityProvider.AcceleratorTotalMemoryMiBRequestProperty( max=123, min=123 ), accelerator_types=["acceleratorTypes"], allowed_instance_types=["allowedInstanceTypes"], bare_metal="bareMetal", baseline_ebs_bandwidth_mbps=ecs.CfnCapacityProvider.BaselineEbsBandwidthMbpsRequestProperty( max=123, min=123 ), burstable_performance="burstablePerformance", cpu_manufacturers=["cpuManufacturers"], excluded_instance_types=["excludedInstanceTypes"], instance_generations=["instanceGenerations"], local_storage="localStorage", local_storage_types=["localStorageTypes"], max_spot_price_as_percentage_of_optimal_on_demand_price=123, memory_gi_bPer_vCpu=ecs.CfnCapacityProvider.MemoryGiBPerVCpuRequestProperty( max=123, min=123 ), network_bandwidth_gbps=ecs.CfnCapacityProvider.NetworkBandwidthGbpsRequestProperty( max=123, min=123 ), network_interface_count=ecs.CfnCapacityProvider.NetworkInterfaceCountRequestProperty( max=123, min=123 ), on_demand_max_price_percentage_over_lowest_price=123, require_hibernate_support=False, spot_max_price_percentage_over_lowest_price=123, total_local_storage_gb=ecs.CfnCapacityProvider.TotalLocalStorageGBRequestProperty( max=123, min=123 ) ), monitoring="monitoring", storage_configuration=ecs.CfnCapacityProvider.ManagedInstancesStorageConfigurationProperty( storage_size_gi_b=123 ) ), # the properties below are optional propagate_tags="propagateTags" ), name="name", tags=[CfnTag( key="key", value="value" )] )
Attributes
- auto_scaling_group_provider
The Auto Scaling group settings for the capacity provider.
- cluster_name
The cluster that this capacity provider is associated with.
Managed instances capacity providers are cluster-scoped, meaning they can only be used within their associated cluster.
This is required for Managed instances.
- managed_instances_provider
The configuration for the Amazon ECS Managed Instances provider.
This includes the infrastructure role, the launch template configuration, and tag propagation settings.
- name
The name of the capacity provider.
If a name is specified, it cannot start with
aws,ecs, orfargate. If no name is specified, a default name in theCFNStackName-CFNResourceName-RandomStringformat is used.
- tags
The metadata that you apply to the capacity provider to help you categorize and organize it.
Each tag consists of a key and an optional value. You define both.
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 AWS 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.