Class: AWSCDK::CodeDeploy::LambdaDeploymentConfig

Inherits:
BaseDeploymentConfig
  • Object
show all
Includes:
ILambdaDeploymentConfig
Defined in:
code_deploy/lambda_deployment_config.rb

Overview

A custom Deployment Configuration for a Lambda Deployment Group.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of LambdaDeploymentConfig.

Parameters:



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

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

Class Method Details

.ALL_AT_ONCE ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentConfig

CodeDeploy predefined deployment configuration that shifts all traffic to the updated Lambda function at once.

Returns:



134
135
136
 
# File 'code_deploy/lambda_deployment_config.rb', line 134

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

.CANARY_10_PERCENT_10_MINUTES ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentConfig

CodeDeploy predefined deployment configuration that shifts 10 percent of traffic in the first increment.

The remaining 90 percent is deployed 10 minutes later.

Returns:



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

def self.CANARY_10_PERCENT_10_MINUTES()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codedeploy.LambdaDeploymentConfig", "CANARY_10PERCENT_10MINUTES")
end

.CANARY_10_PERCENT_15_MINUTES ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentConfig

CodeDeploy predefined deployment configuration that shifts 10 percent of traffic in the first increment.

The remaining 90 percent is deployed 15 minutes later.

Returns:



152
153
154
 
# File 'code_deploy/lambda_deployment_config.rb', line 152

def self.CANARY_10_PERCENT_15_MINUTES()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codedeploy.LambdaDeploymentConfig", "CANARY_10PERCENT_15MINUTES")
end

.CANARY_10_PERCENT_30_MINUTES ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentConfig

CodeDeploy predefined deployment configuration that shifts 10 percent of traffic in the first increment.

The remaining 90 percent is deployed 30 minutes later.

Returns:



161
162
163
 
# File 'code_deploy/lambda_deployment_config.rb', line 161

def self.CANARY_10_PERCENT_30_MINUTES()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codedeploy.LambdaDeploymentConfig", "CANARY_10PERCENT_30MINUTES")
end

.CANARY_10_PERCENT_5_MINUTES ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentConfig

CodeDeploy predefined deployment configuration that shifts 10 percent of traffic in the first increment.

The remaining 90 percent is deployed five minutes later.

Returns:



170
171
172
 
# File 'code_deploy/lambda_deployment_config.rb', line 170

def self.CANARY_10_PERCENT_5_MINUTES()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codedeploy.LambdaDeploymentConfig", "CANARY_10PERCENT_5MINUTES")
end

.from_lambda_deployment_config_name(scope, id, lambda_deployment_config_name) ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentConfig

Import a Deployment Configuration for a Lambda Deployment Group defined outside the CDK.

Parameters:

  • scope (Constructs::Construct) —

    the parent Construct for this new Construct.

  • id (String) —

    the logical ID of this new Construct.

  • lambda_deployment_config_name (String) —

    the name of the Lambda Deployment Configuration to import.

Returns:



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

def self.from_lambda_deployment_config_name(scope, id, lambda_deployment_config_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_deployment_config_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lambdaDeploymentConfigName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codedeploy.LambdaDeploymentConfig", "fromLambdaDeploymentConfigName", [scope, id, lambda_deployment_config_name])
end

.import(_scope, _id, props) ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentConfig

Deprecated.

use fromLambdaDeploymentConfigName

Import a Deployment Configuration for a Lambda Deployment Group defined outside the CDK.

Parameters:

  • _scope (Constructs::Construct) —

    the parent Construct for this new Construct.

  • _id (String) —

    the logical ID of this new Construct.

  • props (AWSCDK::CodeDeploy::LambdaDeploymentConfigImportProps) —

    the properties of the referenced custom Deployment Configuration.

Returns:



59
60
61
62
63
64
65
 
# File 'code_deploy/lambda_deployment_config.rb', line 59

def self.import(_scope, _id, 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")
  props = props.is_a?(Hash) ? ::AWSCDK::CodeDeploy::LambdaDeploymentConfigImportProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWRlcGxveS5MYW1iZGFEZXBsb3ltZW50Q29uZmlnSW1wb3J0UHJvcHMifQ==")), "props")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codedeploy.LambdaDeploymentConfig", "import", [_scope, _id, props])
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_deployment_config.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 },
    :deployment_config_arn => { kind: :property, name: "deploymentConfigArn", is_optional: false },
    :deployment_config_name => { kind: :property, name: "deploymentConfigName", is_optional: false },
    :deployment_config_ref => { kind: :property, name: "deploymentConfigRef", 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

.LINEAR_10_PERCENT_EVERY_10_MINUTES ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentConfig

CodeDeploy predefined deployment configuration that shifts 10 percent of traffic every 10 minutes until all traffic is shifted.

Returns:



177
178
179
 
# File 'code_deploy/lambda_deployment_config.rb', line 177

def self.LINEAR_10_PERCENT_EVERY_10_MINUTES()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codedeploy.LambdaDeploymentConfig", "LINEAR_10PERCENT_EVERY_10MINUTES")
end

.LINEAR_10_PERCENT_EVERY_1_MINUTE ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentConfig

CodeDeploy predefined deployment configuration that shifts 10 percent of traffic every minute until all traffic is shifted.

Returns:



184
185
186
 
# File 'code_deploy/lambda_deployment_config.rb', line 184

def self.LINEAR_10_PERCENT_EVERY_1_MINUTE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codedeploy.LambdaDeploymentConfig", "LINEAR_10PERCENT_EVERY_1MINUTE")
end

.LINEAR_10_PERCENT_EVERY_2_MINUTES ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentConfig

CodeDeploy predefined deployment configuration that shifts 10 percent of traffic every two minutes until all traffic is shifted.

Returns:



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

def self.LINEAR_10_PERCENT_EVERY_2_MINUTES()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codedeploy.LambdaDeploymentConfig", "LINEAR_10PERCENT_EVERY_2MINUTES")
end

.LINEAR_10_PERCENT_EVERY_3_MINUTES ⇒ AWSCDK::CodeDeploy::ILambdaDeploymentConfig

CodeDeploy predefined deployment configuration that shifts 10 percent of traffic every three minutes until all traffic is shifted.

Returns:



198
199
200
 
# File 'code_deploy/lambda_deployment_config.rb', line 198

def self.LINEAR_10_PERCENT_EVERY_3_MINUTES()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codedeploy.LambdaDeploymentConfig", "LINEAR_10PERCENT_EVERY_3MINUTES")
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


205
206
207
 
# File 'code_deploy/lambda_deployment_config.rb', line 205

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

Instance Method Details

#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:



242
243
244
245
 
# File 'code_deploy/lambda_deployment_config.rb', line 242

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:



259
260
261
262
 
# File 'code_deploy/lambda_deployment_config.rb', line 259

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_arn ⇒ String

The ARN of the Deployment Configuration.

Returns:

  • (String) 


113
114
115
 
# File 'code_deploy/lambda_deployment_config.rb', line 113

def deployment_config_arn()
  jsii_get_property("deploymentConfigArn")
end

#deployment_config_name ⇒ String

The physical, human-readable name of the Deployment Configuration.

Returns:

  • (String) 


120
121
122
 
# File 'code_deploy/lambda_deployment_config.rb', line 120

def deployment_config_name()
  jsii_get_property("deploymentConfigName")
end

#deployment_config_ref ⇒ AWSCDK::Interfaces::AWSCodedeploy::DeploymentConfigReference

A reference to a DeploymentConfig resource.

Returns:



127
128
129
 
# File 'code_deploy/lambda_deployment_config.rb', line 127

def deployment_config_ref()
  jsii_get_property("deploymentConfigRef")
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:



85
86
87
 
# File 'code_deploy/lambda_deployment_config.rb', line 85

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


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

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) 


279
280
281
282
283
284
 
# File 'code_deploy/lambda_deployment_config.rb', line 279

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) 


294
295
296
297
 
# File 'code_deploy/lambda_deployment_config.rb', line 294

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) 


70
71
72
 
# File 'code_deploy/lambda_deployment_config.rb', line 70

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) 


99
100
101
 
# File 'code_deploy/lambda_deployment_config.rb', line 99

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



106
107
108
 
# File 'code_deploy/lambda_deployment_config.rb', line 106

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


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

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) 


225
226
227
228
229
230
 
# File 'code_deploy/lambda_deployment_config.rb', line 225

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