Class: AWSCDK::Lambda::CfnCapacityProvider

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSLambda::ICapacityProviderRef
Defined in:
lambda/cfn_capacity_provider.rb

Overview

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

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCapacityProvider

Create a new AWS::Lambda::CapacityProvider.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Lambda::CfnCapacityProviderProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'lambda/cfn_capacity_provider.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Lambda::CfnCapacityProviderProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLkNmbkNhcGFjaXR5UHJvdmlkZXJQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_capacity_provider(resource) ⇒ String

Parameters:

Returns:

  • (String) 


81
82
83
84
 
# File 'lambda/cfn_capacity_provider.rb', line 81

def self.arn_for_capacity_provider(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sYW1iZGEuSUNhcGFjaXR5UHJvdmlkZXJSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lambda.CfnCapacityProvider", "arnForCapacityProvider", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


214
215
216
 
# File 'lambda/cfn_capacity_provider.rb', line 214

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

.from_capacity_provider_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSLambda::ICapacityProviderRef

Creates a new ICapacityProviderRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



92
93
94
95
96
97
 
# File 'lambda/cfn_capacity_provider.rb', line 92

def self.from_capacity_provider_arn(scope, id, 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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lambda.CfnCapacityProvider", "fromCapacityProviderArn", [scope, id, arn])
end

.from_capacity_provider_name(scope, id, capacity_provider_name) ⇒ AWSCDK::Interfaces::AWSLambda::ICapacityProviderRef

Creates a new ICapacityProviderRef from a capacityProviderName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • capacity_provider_name (String)

Returns:



105
106
107
108
109
110
 
# File 'lambda/cfn_capacity_provider.rb', line 105

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.CfnCapacityProvider", "fromCapacityProviderName", [scope, id, capacity_provider_name])
end

.is_cfn_capacity_provider(x) ⇒ Boolean

Checks whether the given object is a CfnCapacityProvider.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


116
117
118
119
 
# File 'lambda/cfn_capacity_provider.rb', line 116

def self.is_cfn_capacity_provider(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lambda.CfnCapacityProvider", "isCfnCapacityProvider", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lambda/cfn_capacity_provider.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :capacity_provider_ref => { kind: :property, name: "capacityProviderRef", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :permissions_config => { kind: :property, name: "permissionsConfig", is_optional: false },
    :vpc_config => { kind: :property, name: "vpcConfig", is_optional: false },
    :capacity_provider_name => { kind: :property, name: "capacityProviderName", is_optional: true },
    :capacity_provider_scaling_config => { kind: :property, name: "capacityProviderScalingConfig", is_optional: true },
    :instance_requirements => { kind: :property, name: "instanceRequirements", is_optional: true },
    :kms_key_arn => { kind: :property, name: "kmsKeyArn", is_optional: true },
    :propagate_tags => { kind: :property, name: "propagateTags", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :telemetry_config => { kind: :property, name: "telemetryConfig", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



389
390
391
392
 
# File 'lambda/cfn_capacity_provider.rb', line 389

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

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:



401
402
403
404
 
# File 'lambda/cfn_capacity_provider.rb', line 401

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

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

Parameters:



411
412
413
414
 
# File 'lambda/cfn_capacity_provider.rb', line 411

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



422
423
424
425
426
 
# File 'lambda/cfn_capacity_provider.rb', line 422

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override 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,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

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

The value argument to add_override 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 (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


479
480
481
482
483
 
# File 'lambda/cfn_capacity_provider.rb', line 479

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

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

Parameters:

  • property_path (String) —

    The path to the property.



489
490
491
492
 
# File 'lambda/cfn_capacity_provider.rb', line 489

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

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

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



501
502
503
504
505
 
# File 'lambda/cfn_capacity_provider.rb', line 501

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



514
515
516
517
 
# File 'lambda/cfn_capacity_provider.rb', line 514

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

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:

See Also:



536
537
538
539
540
541
 
# File 'lambda/cfn_capacity_provider.rb', line 536

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

Returns:

  • (String) 


219
220
221
 
# File 'lambda/cfn_capacity_provider.rb', line 219

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_state ⇒ String

The current state of the capacity provider.

Returns:

  • (String) 


226
227
228
 
# File 'lambda/cfn_capacity_provider.rb', line 226

def attr_state()
  jsii_get_property("attrState")
end

#capacity_provider_name ⇒ String?

Returns:

  • (String, nil) 


271
272
273
 
# File 'lambda/cfn_capacity_provider.rb', line 271

def capacity_provider_name()
  jsii_get_property("capacityProviderName")
end

#capacity_provider_name=(value) ⇒ Object 



275
276
277
278
 
# File 'lambda/cfn_capacity_provider.rb', line 275

def capacity_provider_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "capacityProviderName") unless value.nil?
  jsii_set_property("capacityProviderName", value)
end

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

A reference to a CapacityProvider resource.

Returns:



233
234
235
 
# File 'lambda/cfn_capacity_provider.rb', line 233

def capacity_provider_ref()
  jsii_get_property("capacityProviderRef")
end

#capacity_provider_scaling_config ⇒ AWSCDK::IResolvable, ...

The scaling configuration for the capacity provider.

Returns:



283
284
285
 
# File 'lambda/cfn_capacity_provider.rb', line 283

def capacity_provider_scaling_config()
  jsii_get_property("capacityProviderScalingConfig")
end

#capacity_provider_scaling_config=(value) ⇒ Object 



287
288
289
290
291
 
# File 'lambda/cfn_capacity_provider.rb', line 287

def capacity_provider_scaling_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnCapacityProvider::CapacityProviderScalingConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuQ2FwYWNpdHlQcm92aWRlci5DYXBhY2l0eVByb3ZpZGVyU2NhbGluZ0NvbmZpZ1Byb3BlcnR5In1dfX0=")), "capacityProviderScalingConfig") unless value.nil?
  jsii_set_property("capacityProviderScalingConfig", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



240
241
242
 
# File 'lambda/cfn_capacity_provider.rb', line 240

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



167
168
169
 
# File 'lambda/cfn_capacity_provider.rb', line 167

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


172
173
174
 
# File 'lambda/cfn_capacity_provider.rb', line 172

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


545
546
547
548
 
# File 'lambda/cfn_capacity_provider.rb', line 545

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


177
178
179
 
# File 'lambda/cfn_capacity_provider.rb', line 177

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


184
185
186
 
# File 'lambda/cfn_capacity_provider.rb', line 184

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


129
130
131
 
# File 'lambda/cfn_capacity_provider.rb', line 129

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



189
190
191
 
# File 'lambda/cfn_capacity_provider.rb', line 189

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

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:

Returns:



558
559
560
561
562
 
# File 'lambda/cfn_capacity_provider.rb', line 558

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



569
570
571
572
 
# File 'lambda/cfn_capacity_provider.rb', line 569

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



639
640
641
642
 
# File 'lambda/cfn_capacity_provider.rb', line 639

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#instance_requirements ⇒ AWSCDK::IResolvable, ...

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

Returns:



296
297
298
 
# File 'lambda/cfn_capacity_provider.rb', line 296

def instance_requirements()
  jsii_get_property("instanceRequirements")
end

#instance_requirements=(value) ⇒ Object 



300
301
302
303
304
 
# File 'lambda/cfn_capacity_provider.rb', line 300

def instance_requirements=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnCapacityProvider::InstanceRequirementsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuQ2FwYWNpdHlQcm92aWRlci5JbnN0YW5jZVJlcXVpcmVtZW50c1Byb3BlcnR5In1dfX0=")), "instanceRequirements") unless value.nil?
  jsii_set_property("instanceRequirements", value)
end

#kms_key_arn ⇒ String?

The ARN of the KMS key used to encrypt the capacity provider's resources.

Returns:

  • (String, nil) 


309
310
311
 
# File 'lambda/cfn_capacity_provider.rb', line 309

def kms_key_arn()
  jsii_get_property("kmsKeyArn")
end

#kms_key_arn=(value) ⇒ Object 



313
314
315
316
 
# File 'lambda/cfn_capacity_provider.rb', line 313

def kms_key_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyArn") unless value.nil?
  jsii_set_property("kmsKeyArn", value)
end

#logical_id ⇒ String

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 override_logical_id(new_logical_id).

Returns:

  • (String) 


141
142
143
 
# File 'lambda/cfn_capacity_provider.rb', line 141

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


124
125
126
 
# File 'lambda/cfn_capacity_provider.rb', line 124

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

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

Returns:



580
581
582
 
# File 'lambda/cfn_capacity_provider.rb', line 580

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

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

Returns:



587
588
589
 
# File 'lambda/cfn_capacity_provider.rb', line 587

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

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

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



380
381
382
383
 
# File 'lambda/cfn_capacity_provider.rb', line 380

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#permissions_config ⇒ AWSCDK::IResolvable, AWSCDK::Lambda::CfnCapacityProvider::CapacityProviderPermissionsConfigProperty

The permissions configuration for the capacity provider.

Returns:



247
248
249
 
# File 'lambda/cfn_capacity_provider.rb', line 247

def permissions_config()
  jsii_get_property("permissionsConfig")
end

#permissions_config=(value) ⇒ Object 



251
252
253
254
255
 
# File 'lambda/cfn_capacity_provider.rb', line 251

def permissions_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnCapacityProvider::CapacityProviderPermissionsConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuQ2FwYWNpdHlQcm92aWRlci5DYXBhY2l0eVByb3ZpZGVyUGVybWlzc2lvbnNDb25maWdQcm9wZXJ0eSJ9XX19")), "permissionsConfig")
  jsii_set_property("permissionsConfig", value)
end

#propagate_tags ⇒ AWSCDK::IResolvable, ...

Returns:



319
320
321
 
# File 'lambda/cfn_capacity_provider.rb', line 319

def propagate_tags()
  jsii_get_property("propagateTags")
end

#propagate_tags=(value) ⇒ Object 



323
324
325
326
327
 
# File 'lambda/cfn_capacity_provider.rb', line 323

def propagate_tags=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnCapacityProvider::PropagateTagsConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuQ2FwYWNpdHlQcm92aWRlci5Qcm9wYWdhdGVUYWdzQ29uZmlnUHJvcGVydHkifV19fQ==")), "propagateTags") unless value.nil?
  jsii_set_property("propagateTags", value)
end

#ref ⇒ String

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

Returns:

  • (String) 


160
161
162
 
# File 'lambda/cfn_capacity_provider.rb', line 160

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

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:



598
599
600
601
 
# File 'lambda/cfn_capacity_provider.rb', line 598

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


605
606
607
608
 
# File 'lambda/cfn_capacity_provider.rb', line 605

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



615
616
617
618
619
 
# File 'lambda/cfn_capacity_provider.rb', line 615

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



624
625
626
 
# File 'lambda/cfn_capacity_provider.rb', line 624

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



150
151
152
 
# File 'lambda/cfn_capacity_provider.rb', line 150

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



332
333
334
 
# File 'lambda/cfn_capacity_provider.rb', line 332

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



336
337
338
339
340
 
# File 'lambda/cfn_capacity_provider.rb', line 336

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#telemetry_config ⇒ AWSCDK::IResolvable, ...

Returns:



343
344
345
 
# File 'lambda/cfn_capacity_provider.rb', line 343

def telemetry_config()
  jsii_get_property("telemetryConfig")
end

#telemetry_config=(value) ⇒ Object 



347
348
349
350
351
 
# File 'lambda/cfn_capacity_provider.rb', line 347

def telemetry_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnCapacityProvider::CapacityProviderTelemetryConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuQ2FwYWNpdHlQcm92aWRlci5DYXBhY2l0eVByb3ZpZGVyVGVsZW1ldHJ5Q29uZmlnUHJvcGVydHkifV19fQ==")), "telemetryConfig") unless value.nil?
  jsii_set_property("telemetryConfig", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



356
357
358
 
# File 'lambda/cfn_capacity_provider.rb', line 356

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


197
198
199
 
# File 'lambda/cfn_capacity_provider.rb', line 197

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


207
208
209
 
# File 'lambda/cfn_capacity_provider.rb', line 207

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


630
631
632
633
 
# File 'lambda/cfn_capacity_provider.rb', line 630

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc_config ⇒ AWSCDK::IResolvable, AWSCDK::Lambda::CfnCapacityProvider::CapacityProviderVPCConfigProperty

The VPC configuration for the capacity provider.

Returns:



260
261
262
 
# File 'lambda/cfn_capacity_provider.rb', line 260

def vpc_config()
  jsii_get_property("vpcConfig")
end

#vpc_config=(value) ⇒ Object 



264
265
266
267
268
 
# File 'lambda/cfn_capacity_provider.rb', line 264

def vpc_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnCapacityProvider::CapacityProviderVPCConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuQ2FwYWNpdHlQcm92aWRlci5DYXBhY2l0eVByb3ZpZGVyVnBjQ29uZmlnUHJvcGVydHkifV19fQ==")), "vpcConfig")
  jsii_set_property("vpcConfig", value)
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) 


369
370
371
372
373
374
 
# File 'lambda/cfn_capacity_provider.rb', line 369

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