Class: AWSCDK::Lambda::CapacityProvider

Inherits:
Resource
  • Object
show all
Includes:
ICapacityProvider
Defined in:
lambda/capacity_provider.rb

Overview

A Lambda capacity provider that manages compute resources for Lambda functions.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CapacityProvider

Creates a new Lambda capacity provider.

Parameters:



14
15
16
17
18
19
20
 
# File 'lambda/capacity_provider.rb', line 14

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Lambda::CapacityProviderProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLkNhcGFjaXR5UHJvdmlkZXJQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_capacity_provider_arn(scope, id, capacity_provider_arn) ⇒ AWSCDK::Lambda::ICapacityProvider

Import an existing capacity provider by ARN.

Parameters:

  • scope (Constructs::Construct) —

    The parent construct.

  • id (String) —

    The construct ID.

  • capacity_provider_arn (String) —

    The ARN of the capacity provider to import.

Returns:



48
49
50
51
52
53
 
# File 'lambda/capacity_provider.rb', line 48

def self.from_capacity_provider_arn(scope, id, capacity_provider_arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(capacity_provider_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "capacityProviderArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lambda.CapacityProvider", "fromCapacityProviderArn", [scope, id, capacity_provider_arn])
end

.from_capacity_provider_attributes(scope, id, attrs) ⇒ AWSCDK::Lambda::ICapacityProvider

Import an existing capacity provider using its attributes.

Parameters:

Returns:



61
62
63
64
65
66
67
 
# File 'lambda/capacity_provider.rb', line 61

def self.from_capacity_provider_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::Lambda::CapacityProviderAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLkNhcGFjaXR5UHJvdmlkZXJBdHRyaWJ1dGVzIn0=")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lambda.CapacityProvider", "fromCapacityProviderAttributes", [scope, id, attrs])
end

.from_capacity_provider_name(scope, id, capacity_provider_name) ⇒ AWSCDK::Lambda::ICapacityProvider

Import an existing capacity provider by name.

Parameters:

  • scope (Constructs::Construct) —

    The parent construct.

  • id (String) —

    The construct ID.

  • capacity_provider_name (String) —

    The name of the capacity provider to import.

Returns:



75
76
77
78
79
80
 
# File 'lambda/capacity_provider.rb', line 75

def self.from_capacity_provider_name(scope, id, capacity_provider_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(capacity_provider_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "capacityProviderName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lambda.CapacityProvider", "fromCapacityProviderName", [scope, id, capacity_provider_name])
end

.jsii_overridable_methods ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lambda/capacity_provider.rb', line 22

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :capacity_provider_arn => { kind: :property, name: "capacityProviderArn", is_optional: false },
    :capacity_provider_name => { kind: :property, name: "capacityProviderName", is_optional: false },
    :capacity_provider_ref => { kind: :property, name: "capacityProviderRef", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_function => { kind: :method, name: "addFunction", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


128
129
130
 
# File 'lambda/capacity_provider.rb', line 128

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_lambda.CapacityProvider", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_function(func, options = nil) ⇒ void

This method returns an undefined value.

Configures a Lambda function to use this capacity provider.

Parameters:



248
249
250
251
252
253
 
# File 'lambda/capacity_provider.rb', line 248

def add_function(func, options = nil)
  Jsii::Type.check_type(func, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "func")
  options = options.is_a?(Hash) ? ::AWSCDK::Lambda::CapacityProviderFunctionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLkNhcGFjaXR5UHJvdmlkZXJGdW5jdGlvbk9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("addFunction", [func, options])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



186
187
188
189
 
# File 'lambda/capacity_provider.rb', line 186

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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).

Parameters:



203
204
205
206
 
# File 'lambda/capacity_provider.rb', line 203

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#capacity_provider_arn ⇒ String

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

Returns:

  • (String) 


135
136
137
 
# File 'lambda/capacity_provider.rb', line 135

def capacity_provider_arn()
  jsii_get_property("capacityProviderArn")
end

#capacity_provider_name ⇒ String

The name of the capacity provider.

Returns:

  • (String) 


142
143
144
 
# File 'lambda/capacity_provider.rb', line 142

def capacity_provider_name()
  jsii_get_property("capacityProviderName")
end

#capacity_provider_ref ⇒ AWSCDK::Interfaces::AWSLambda::CapacityProviderReference

A reference to a CapacityProvider resource.

Returns:



149
150
151
 
# File 'lambda/capacity_provider.rb', line 149

def capacity_provider_ref()
  jsii_get_property("capacityProviderRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



100
101
102
 
# File 'lambda/capacity_provider.rb', line 100

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


209
210
211
 
# File 'lambda/capacity_provider.rb', line 209

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


223
224
225
226
227
228
 
# File 'lambda/capacity_provider.rb', line 223

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


238
239
240
241
 
# File 'lambda/capacity_provider.rb', line 238

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


85
86
87
 
# File 'lambda/capacity_provider.rb', line 85

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


114
115
116
 
# File 'lambda/capacity_provider.rb', line 114

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



121
122
123
 
# File 'lambda/capacity_provider.rb', line 121

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


156
157
158
 
# File 'lambda/capacity_provider.rb', line 156

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


169
170
171
172
173
174
 
# File 'lambda/capacity_provider.rb', line 169

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end