CfnCapacityProviderProps

class aws_cdk.aws_lambda.CfnCapacityProviderProps(*, permissions_config, vpc_config, capacity_provider_name=None, capacity_provider_scaling_config=None, instance_requirements=None, kms_key_arn=None, tags=None)

Bases: object

Properties for defining a CfnCapacityProvider.

Parameters:
  • permissions_config (Union[IResolvable, CapacityProviderPermissionsConfigProperty, Dict[str, Any]]) – IAM permissions configuration for the capacity provider.

  • vpc_config (Union[IResolvable, CapacityProviderVpcConfigProperty, Dict[str, Any]]) – VPC configuration for the capacity provider.

  • capacity_provider_name (Optional[str]) – The name of the capacity provider. The name must be unique within your AWS account and region. If you don’t specify a name, CloudFormation generates one.

  • capacity_provider_scaling_config (Union[IResolvable, CapacityProviderScalingConfigProperty, Dict[str, Any], None]) – The scaling configuration for the capacity provider.

  • instance_requirements (Union[IResolvable, InstanceRequirementsProperty, Dict[str, Any], None]) – Specifications for the types of EC2 instances that the capacity provider can use.

  • kms_key_arn (Optional[str]) – The ARN of the AWS Key Management Service (KMS) key used by the capacity provider.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags to apply to the capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-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_lambda as lambda_

cfn_capacity_provider_props = lambda.CfnCapacityProviderProps(
    permissions_config=lambda.CfnCapacityProvider.CapacityProviderPermissionsConfigProperty(
        capacity_provider_operator_role_arn="capacityProviderOperatorRoleArn"
    ),
    vpc_config=lambda.CfnCapacityProvider.CapacityProviderVpcConfigProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    ),

    # the properties below are optional
    capacity_provider_name="capacityProviderName",
    capacity_provider_scaling_config=lambda.CfnCapacityProvider.CapacityProviderScalingConfigProperty(
        max_vCpu_count=123,
        scaling_mode="scalingMode",
        scaling_policies=[lambda.CfnCapacityProvider.TargetTrackingScalingPolicyProperty(
            predefined_metric_type="predefinedMetricType",
            target_value=123
        )]
    ),
    instance_requirements=lambda.CfnCapacityProvider.InstanceRequirementsProperty(
        allowed_instance_types=["allowedInstanceTypes"],
        architectures=["architectures"],
        excluded_instance_types=["excludedInstanceTypes"]
    ),
    kms_key_arn="kmsKeyArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

capacity_provider_name

The name of the capacity provider.

The name must be unique within your AWS account and region. If you don’t specify a name, CloudFormation generates one.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityprovidername

capacity_provider_scaling_config

The scaling configuration for the capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig

instance_requirements

Specifications for the types of EC2 instances that the capacity provider can use.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-instancerequirements

kms_key_arn

The ARN of the AWS Key Management Service (KMS) key used by the capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-kmskeyarn

permissions_config

IAM permissions configuration for the capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-permissionsconfig

tags

A list of tags to apply to the capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-tags

vpc_config

VPC configuration for the capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-vpcconfig