Module: AWSCDK::Lambda::ILayerVersion

Includes:
IResource, Interfaces::AWSLambda::ILayerVersionRef
Included in:
LayerVersion
Defined in:
lambda/i_layer_version.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lambda/i_layer_version.rb', line 109

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :layer_version_ref => { kind: :property, name: "layerVersionRef", is_optional: false },
    :layer_version_arn => { kind: :property, name: "layerVersionArn", is_optional: false },
    :compatible_runtimes => { kind: :property, name: "compatibleRuntimes", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :add_permission => { kind: :method, name: "addPermission", is_optional: false },
  }
end

Instance Method Details

#add_permission(id, permission) ⇒ void

This method returns an undefined value.

Add permission for this layer version to specific entities.

Usage within the same account where the layer is defined is always allowed and does not require calling this method. Note that the principal that creates the Lambda function using the layer (for example, a CloudFormation changeset execution role) also needs to have the lambda:GetLayerVersion permission on the layer version.

Parameters:



102
103
104
105
106
107
 
# File 'lambda/i_layer_version.rb', line 102

def add_permission(id, permission)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  permission = permission.is_a?(Hash) ? ::AWSCDK::Lambda::LayerVersionPermission.new(**permission.transform_keys(&:to_sym)) : permission
  Jsii::Type.check_type(permission, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLkxheWVyVmVyc2lvblBlcm1pc3Npb24ifQ==")), "permission")
  jsii_call_method("addPermission", [id, permission])
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:



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

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

#compatible_runtimes ⇒ Array<AWSCDK::Lambda::Runtime>?

Note:

Default: - All supported runtimes. Setting this to Runtime.ALL is equivalent to leaving it undefined.

The runtimes compatible with this Layer.

Returns:



55
56
57
 
# File 'lambda/i_layer_version.rb', line 55

def compatible_runtimes()
  jsii_get_property("compatibleRuntimes")
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:



26
27
28
 
# File 'lambda/i_layer_version.rb', line 26

def env()
  jsii_get_property("env")
end

#layer_version_arn ⇒ String

The ARN of the Lambda Layer version that this Layer defines.

Returns:

  • (String) 


47
48
49
 
# File 'lambda/i_layer_version.rb', line 47

def layer_version_arn()
  jsii_get_property("layerVersionArn")
end

#layer_version_ref ⇒ AWSCDK::Interfaces::AWSLambda::LayerVersionReference

A reference to a LayerVersion resource.

Returns:



40
41
42
 
# File 'lambda/i_layer_version.rb', line 40

def layer_version_ref()
  jsii_get_property("layerVersionRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


11
12
13
 
# File 'lambda/i_layer_version.rb', line 11

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



33
34
35
 
# File 'lambda/i_layer_version.rb', line 33

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



66
67
68
69
70
71
 
# File 'lambda/i_layer_version.rb', line 66

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