Class: AWSCDK::CodeDeploy::LambdaDeploymentGroup

Inherits:
Resource
  • Object
show all
Includes:
ILambdaDeploymentGroup
Defined in:
code_deploy/lambda_deployment_group.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ LambdaDeploymentGroup

Returns a new instance of LambdaDeploymentGroup.

Parameters:



11
12
13
14
15
16
17
 
# File 'code_deploy/lambda_deployment_group.rb', line 11

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

Class Method Details

.from_lambda_deployment_group_attributes(scope, id, attrs) ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentGroup

Import an Lambda Deployment Group defined either outside the CDK app, or in a different AWS region.

Account and region for the DeploymentGroup are taken from the application.

Parameters:

Returns:



54
55
56
57
58
59
60
 
# File 'code_deploy/lambda_deployment_group.rb', line 54

def self.from_lambda_deployment_group_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::CodeDeploy::LambdaDeploymentGroupAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWRlcGxveS5MYW1iZGFEZXBsb3ltZW50R3JvdXBBdHRyaWJ1dGVzIn0=")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codedeploy.LambdaDeploymentGroup", "fromLambdaDeploymentGroupAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'code_deploy/lambda_deployment_group.rb', line 19

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 => { kind: :property, name: "application", is_optional: false },
    :application_name => { kind: :property, name: "applicationName", is_optional: false },
    :deployment_config => { kind: :property, name: "deploymentConfig", is_optional: false },
    :deployment_group_arn => { kind: :property, name: "deploymentGroupArn", is_optional: false },
    :deployment_group_name => { kind: :property, name: "deploymentGroupName", is_optional: false },
    :deployment_group_ref => { kind: :property, name: "deploymentGroupRef", is_optional: false },
    :role => { kind: :property, name: "role", 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_alarm => { kind: :method, name: "addAlarm", is_optional: false },
    :add_post_hook => { kind: :method, name: "addPostHook", is_optional: false },
    :add_pre_hook => { kind: :method, name: "addPreHook", is_optional: false },
    :grant_put_lifecycle_event_hook_execution_status => { kind: :method, name: "grantPutLifecycleEventHookExecutionStatus", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


108
109
110
 
# File 'code_deploy/lambda_deployment_group.rb', line 108

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

Instance Method Details

#add_alarm(alarm) ⇒ void

This method returns an undefined value.

Associates an additional alarm with this Deployment Group.

Parameters:



255
256
257
258
 
# File 'code_deploy/lambda_deployment_group.rb', line 255

def add_alarm(alarm)
  Jsii::Type.check_type(alarm, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jbG91ZHdhdGNoLklBbGFybVJlZiJ9")), "alarm")
  jsii_call_method("addAlarm", [alarm])
end

#add_post_hook(post_hook) ⇒ void

This method returns an undefined value.

Associate a function to run after deployment completes.

Parameters:



264
265
266
267
 
# File 'code_deploy/lambda_deployment_group.rb', line 264

def add_post_hook(post_hook)
  Jsii::Type.check_type(post_hook, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "postHook")
  jsii_call_method("addPostHook", [post_hook])
end

#add_pre_hook(pre_hook) ⇒ void

This method returns an undefined value.

Associate a function to run before deployment begins.

Parameters:



273
274
275
276
 
# File 'code_deploy/lambda_deployment_group.rb', line 273

def add_pre_hook(pre_hook)
  Jsii::Type.check_type(pre_hook, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "preHook")
  jsii_call_method("addPreHook", [pre_hook])
end

#application ⇒ AWSCDK::CodeDeploy::ILambdaApplication

The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to.

Returns:



115
116
117
 
# File 'code_deploy/lambda_deployment_group.rb', line 115

def application()
  jsii_get_property("application")
end

#application_name ⇒ String

The name of the Application.

Returns:

  • (String) 


122
123
124
 
# File 'code_deploy/lambda_deployment_group.rb', line 122

def application_name()
  jsii_get_property("applicationName")
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:



194
195
196
197
 
# File 'code_deploy/lambda_deployment_group.rb', line 194

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:



211
212
213
214
 
# File 'code_deploy/lambda_deployment_group.rb', line 211

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

#deployment_config ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentConfig

The Deployment Configuration this Group uses.

Returns:



129
130
131
 
# File 'code_deploy/lambda_deployment_group.rb', line 129

def deployment_config()
  jsii_get_property("deploymentConfig")
end

#deployment_group_arn ⇒ String

The ARN of the Deployment Group.

Returns:

  • (String) 


136
137
138
 
# File 'code_deploy/lambda_deployment_group.rb', line 136

def deployment_group_arn()
  jsii_get_property("deploymentGroupArn")
end

#deployment_group_name ⇒ String

The name of the Deployment Group.

Returns:

  • (String) 


143
144
145
 
# File 'code_deploy/lambda_deployment_group.rb', line 143

def deployment_group_name()
  jsii_get_property("deploymentGroupName")
end

#deployment_group_ref ⇒ AWSCDK::Interfaces::AWSCodedeploy::DeploymentGroupReference

A reference to a DeploymentGroup resource.

Returns:



150
151
152
 
# File 'code_deploy/lambda_deployment_group.rb', line 150

def deployment_group_ref()
  jsii_get_property("deploymentGroupRef")
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:



80
81
82
 
# File 'code_deploy/lambda_deployment_group.rb', line 80

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


217
218
219
 
# File 'code_deploy/lambda_deployment_group.rb', line 217

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) 


231
232
233
234
235
236
 
# File 'code_deploy/lambda_deployment_group.rb', line 231

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) 


246
247
248
249
 
# File 'code_deploy/lambda_deployment_group.rb', line 246

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

#grant_put_lifecycle_event_hook_execution_status(grantee) ⇒ AWSCDK::IAM::Grant

Grant a principal permission to codedeploy:PutLifecycleEventHookExecutionStatus on this deployment group resource.

[disable-awslint:no-grants]

Parameters:

Returns:



284
285
286
287
 
# File 'code_deploy/lambda_deployment_group.rb', line 284

def grant_put_lifecycle_event_hook_execution_status(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantPutLifecycleEventHookExecutionStatus", [grantee])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


65
66
67
 
# File 'code_deploy/lambda_deployment_group.rb', line 65

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) 


94
95
96
 
# File 'code_deploy/lambda_deployment_group.rb', line 94

def physical_name()
  jsii_get_property("physicalName")
end

#role ⇒ AWSCDK::IAM::IRole

The service Role of this Deployment Group.

Returns:



157
158
159
 
# File 'code_deploy/lambda_deployment_group.rb', line 157

def role()
  jsii_get_property("role")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



101
102
103
 
# File 'code_deploy/lambda_deployment_group.rb', line 101

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


164
165
166
 
# File 'code_deploy/lambda_deployment_group.rb', line 164

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) 


177
178
179
180
181
182
 
# File 'code_deploy/lambda_deployment_group.rb', line 177

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