Class: AWSCDK::CodeDeploy::LambdaApplication

Inherits:
Resource
  • Object
show all
Includes:
ILambdaApplication
Defined in:
code_deploy/lambda_application.rb

Overview

A CodeDeploy Application that deploys to an AWS Lambda function.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ LambdaApplication

Returns a new instance of LambdaApplication.

Parameters:



12
13
14
15
16
17
18
 
# File 'code_deploy/lambda_application.rb', line 12

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CodeDeploy::LambdaApplicationProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWRlcGxveS5MYW1iZGFBcHBsaWNhdGlvblByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_lambda_application_arn(scope, id, lambda_application_arn) ⇒ AWSCDK::CodeDeploy::ILambdaApplication

Import an Application defined either outside the CDK, or in a different CDK Stack, by ARN.

Parameters:

  • scope (Constructs::Construct) —

    the parent Construct for this new Construct.

  • id (String) —

    the logical ID of this new Construct.

  • lambda_application_arn (String) —

    the ARN of the application to import.

Returns:



45
46
47
48
49
50
 
# File 'code_deploy/lambda_application.rb', line 45

def self.from_lambda_application_arn(scope, id, lambda_application_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(lambda_application_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lambdaApplicationArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codedeploy.LambdaApplication", "fromLambdaApplicationArn", [scope, id, lambda_application_arn])
end

.from_lambda_application_name(scope, id, lambda_application_name) ⇒ AWSCDK::CodeDeploy::ILambdaApplication

Import an Application defined either outside the CDK, or in a different CDK Stack.

The Application's account and region are assumed to be the same as the stack it is being imported into. If not, use from_lambda_application_arn.

Parameters:

  • scope (Constructs::Construct) —

    the parent Construct for this new Construct.

  • id (String) —

    the logical ID of this new Construct.

  • lambda_application_name (String) —

    the name of the application to import.

Returns:



61
62
63
64
65
66
 
# File 'code_deploy/lambda_application.rb', line 61

def self.from_lambda_application_name(scope, id, lambda_application_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(lambda_application_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lambdaApplicationName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codedeploy.LambdaApplication", "fromLambdaApplicationName", [scope, id, lambda_application_name])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'code_deploy/lambda_application.rb', line 20

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 },
    :application_arn => { kind: :property, name: "applicationArn", is_optional: false },
    :application_name => { kind: :property, name: "applicationName", is_optional: false },
    :application_ref => { kind: :property, name: "applicationRef", 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 },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


114
115
116
 
# File 'code_deploy/lambda_application.rb', line 114

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

Instance Method Details

#application_arn ⇒ String

Returns:

  • (String) 


119
120
121
 
# File 'code_deploy/lambda_application.rb', line 119

def application_arn()
  jsii_get_property("applicationArn")
end

#application_name ⇒ String

Returns:

  • (String) 


124
125
126
 
# File 'code_deploy/lambda_application.rb', line 124

def application_name()
  jsii_get_property("applicationName")
end

#application_ref ⇒ AWSCDK::Interfaces::AWSCodedeploy::ApplicationReference

A reference to a Application resource.

Returns:



131
132
133
 
# File 'code_deploy/lambda_application.rb', line 131

def application_ref()
  jsii_get_property("applicationRef")
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:



168
169
170
171
 
# File 'code_deploy/lambda_application.rb', line 168

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:



185
186
187
188
 
# File 'code_deploy/lambda_application.rb', line 185

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
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:



86
87
88
 
# File 'code_deploy/lambda_application.rb', line 86

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


191
192
193
 
# File 'code_deploy/lambda_application.rb', line 191

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) 


205
206
207
208
209
210
 
# File 'code_deploy/lambda_application.rb', line 205

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) 


220
221
222
223
 
# File 'code_deploy/lambda_application.rb', line 220

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) 


71
72
73
 
# File 'code_deploy/lambda_application.rb', line 71

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) 


100
101
102
 
# File 'code_deploy/lambda_application.rb', line 100

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



107
108
109
 
# File 'code_deploy/lambda_application.rb', line 107

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


138
139
140
 
# File 'code_deploy/lambda_application.rb', line 138

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) 


151
152
153
154
155
156
 
# File 'code_deploy/lambda_application.rb', line 151

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