CfnCapacityProvider

class aws_cdk.aws_lambda.CfnCapacityProvider(scope, id, *, permissions_config, vpc_config, capacity_provider_name=None, capacity_provider_scaling_config=None, instance_requirements=None, kms_key_arn=None, tags=None)

Bases: CfnResource

Creates a capacity provider that manages compute resources for Lambda functions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html
CloudformationResource:: AWS::Lambda::CapacityProvider
ExampleMetadata:: fixture=_generated

Example:

from aws_cdk import CfnTag
# 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 = lambda_.CfnCapacityProvider(self, "MyCfnCapacityProvider",
    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"
    )]
)

Create a new AWS::Lambda::CapacityProvider.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
permissions_config (Union[IResolvable, CapacityProviderPermissionsConfigProperty, Dict[str, Any]]) – The permissions configuration for the capacity provider.
vpc_config (Union[IResolvable, CapacityProviderVpcConfigProperty, Dict[str, Any]]) – The 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]) – The instance requirements for compute resources managed by the capacity provider.
kms_key_arn (Optional[str]) – The ARN of the KMS key used to encrypt the capacity provider’s resources.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A key-value pair that provides metadata for the capacity provider.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Lambda::CapacityProvider'

attr_arn

The Amazon Resource Name (ARN) of the capacity provider.

This is a read-only property that is automatically generated when the capacity provider is created.

CloudformationAttribute:: Arn

attr_state

The current state of the capacity provider.

CloudformationAttribute:: State

capacity_provider_name: The name of the capacity provider.

capacity_provider_ref: A reference to a CapacityProvider resource.

capacity_provider_scaling_config: The scaling configuration for the capacity provider.

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

env

instance_requirements: The instance requirements for compute resources managed by the capacity provider.

kms_key_arn: The ARN of the KMS key used to encrypt the capacity provider’s resources.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

permissions_config: The permissions configuration for the capacity provider.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: A key-value pair that provides metadata for the capacity provider.

vpc_config: The VPC configuration for the capacity provider.

Static Methods

classmethod arn_for_capacity_provider(resource)

Parameters:: resource (ICapacityProviderRef)
Return type:: str

classmethod from_capacity_provider_arn(scope, id, arn)

Creates a new ICapacityProviderRef from an ARN.

Parameters:

scope (Construct)
id (str)
arn (str)

Return type:

ICapacityProviderRef

classmethod from_capacity_provider_name(scope, id, capacity_provider_name)

Creates a new ICapacityProviderRef from a capacityProviderName.

Parameters:

scope (Construct)
id (str)
capacity_provider_name (str)

Return type:

ICapacityProviderRef

classmethod is_cfn_capacity_provider(x)

Checks whether the given object is a CfnCapacityProvider.

Parameters:: x (Any)
Return type:: bool

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

CapacityProviderPermissionsConfigProperty

class CfnCapacityProvider.CapacityProviderPermissionsConfigProperty(*, capacity_provider_operator_role_arn)

Bases: object

Configuration that specifies the permissions required for the capacity provider to manage compute resources.

Parameters:: capacity_provider_operator_role_arn (str) – The ARN of the IAM role that the capacity provider uses to manage compute instances and other AWS resources.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderpermissionsconfig.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_

capacity_provider_permissions_config_property = lambda.CfnCapacityProvider.CapacityProviderPermissionsConfigProperty(
    capacity_provider_operator_role_arn="capacityProviderOperatorRoleArn"
)

Attributes

capacity_provider_operator_role_arn

The ARN of the IAM role that the capacity provider uses to manage compute instances and other AWS resources.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderpermissionsconfig.html#cfn-lambda-capacityprovider-capacityproviderpermissionsconfig-capacityprovideroperatorrolearn

CapacityProviderScalingConfigProperty

class CfnCapacityProvider.CapacityProviderScalingConfigProperty(*, max_v_cpu_count=None, scaling_mode=None, scaling_policies=None)

Bases: object

Configuration that defines how the capacity provider scales compute instances based on demand and policies.

Parameters:

max_v_cpu_count (Union[int, float, None]) – The maximum number of vCPUs that the capacity provider can provision across all compute instances.
scaling_mode (Optional[str]) – The scaling mode that determines how the capacity provider responds to changes in demand.
scaling_policies (Union[IResolvable, Sequence[Union[IResolvable, TargetTrackingScalingPolicyProperty, Dict[str, Any]]], None]) – A list of target tracking scaling policies for the capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderscalingconfig.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_

capacity_provider_scaling_config_property = lambda.CfnCapacityProvider.CapacityProviderScalingConfigProperty(
    max_vCpu_count=123,
    scaling_mode="scalingMode",
    scaling_policies=[lambda.CfnCapacityProvider.TargetTrackingScalingPolicyProperty(
        predefined_metric_type="predefinedMetricType",
        target_value=123
    )]
)

Attributes

max_v_cpu_count

The maximum number of vCPUs that the capacity provider can provision across all compute instances.

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

scaling_mode

The scaling mode that determines how the capacity provider responds to changes in demand.

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

scaling_policies

A list of target tracking scaling policies for the capacity provider.

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

CapacityProviderVpcConfigProperty

class CfnCapacityProvider.CapacityProviderVpcConfigProperty(*, security_group_ids, subnet_ids)

Bases: object

VPC configuration that specifies the network settings for compute instances managed by the capacity provider.

Parameters:

security_group_ids (Sequence[str]) – A list of security group IDs that control network access for compute instances managed by the capacity provider.
subnet_ids (Sequence[str]) – A list of subnet IDs where the capacity provider launches compute instances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityprovidervpcconfig.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_

capacity_provider_vpc_config_property = lambda.CfnCapacityProvider.CapacityProviderVpcConfigProperty(
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

security_group_ids

A list of security group IDs that control network access for compute instances managed by the capacity provider.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityprovidervpcconfig.html#cfn-lambda-capacityprovider-capacityprovidervpcconfig-securitygroupids

subnet_ids

A list of subnet IDs where the capacity provider launches compute instances.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityprovidervpcconfig.html#cfn-lambda-capacityprovider-capacityprovidervpcconfig-subnetids

InstanceRequirementsProperty

class CfnCapacityProvider.InstanceRequirementsProperty(*, allowed_instance_types=None, architectures=None, excluded_instance_types=None)

Bases: object

Specifications that define the characteristics and constraints for compute instances used by the capacity provider.

Parameters:

allowed_instance_types (Optional[Sequence[str]]) – A list of EC2 instance types that the capacity provider is allowed to use. If not specified, all compatible instance types are allowed.
architectures (Optional[Sequence[str]]) – A list of supported CPU architectures for compute instances. Valid values include x86_64 and arm64 .
excluded_instance_types (Optional[Sequence[str]]) – A list of EC2 instance types that the capacity provider should not use, even if they meet other requirements.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-instancerequirements.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_

instance_requirements_property = lambda.CfnCapacityProvider.InstanceRequirementsProperty(
    allowed_instance_types=["allowedInstanceTypes"],
    architectures=["architectures"],
    excluded_instance_types=["excludedInstanceTypes"]
)

Attributes

allowed_instance_types

A list of EC2 instance types that the capacity provider is allowed to use.

If not specified, all compatible instance types are allowed.

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

architectures

A list of supported CPU architectures for compute instances.

Valid values include x86_64 and arm64 .

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

excluded_instance_types

A list of EC2 instance types that the capacity provider should not use, even if they meet other requirements.

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

TargetTrackingScalingPolicyProperty

class CfnCapacityProvider.TargetTrackingScalingPolicyProperty(*, predefined_metric_type, target_value)

Bases: object

A scaling policy for the capacity provider that automatically adjusts capacity to maintain a target value for a specific metric.

Parameters:

predefined_metric_type (str) – The predefined metric type to track for scaling decisions.
target_value (Union[int, float]) – The target value for the metric that the scaling policy attempts to maintain through scaling actions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-targettrackingscalingpolicy.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_

target_tracking_scaling_policy_property = lambda.CfnCapacityProvider.TargetTrackingScalingPolicyProperty(
    predefined_metric_type="predefinedMetricType",
    target_value=123
)

Attributes

predefined_metric_type

The predefined metric type to track for scaling decisions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-targettrackingscalingpolicy.html#cfn-lambda-capacityprovider-targettrackingscalingpolicy-predefinedmetrictype

target_value

The target value for the metric that the scaling policy attempts to maintain through scaling actions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-targettrackingscalingpolicy.html#cfn-lambda-capacityprovider-targettrackingscalingpolicy-targetvalue