Class: AWSCDK::CodeDeploy::ECSDeploymentConfig

Inherits:
BaseDeploymentConfig
  • Object
show all
Includes:
IECSDeploymentConfig
Defined in:
code_deploy/ecs_deployment_config.rb

Overview

A custom Deployment Configuration for an ECS Deployment Group.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of ECSDeploymentConfig.

Parameters:



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

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

Class Method Details

.ALL_AT_ONCE ⇒ AWSCDK::CodeDeploy::IECSDeploymentConfig

CodeDeploy predefined deployment configuration that shifts all traffic to the updated ECS task set at once.

Returns:



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

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

.CANARY_10_PERCENT_15_MINUTES ⇒ AWSCDK::CodeDeploy::IECSDeploymentConfig

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

The remaining 90 percent is deployed 15 minutes later.

Returns:



128
129
130
 
# File 'code_deploy/ecs_deployment_config.rb', line 128

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

.CANARY_10_PERCENT_5_MINUTES ⇒ AWSCDK::CodeDeploy::IECSDeploymentConfig

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

The remaining 90 percent is deployed five minutes later.

Returns:



137
138
139
 
# File 'code_deploy/ecs_deployment_config.rb', line 137

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

.from_ecs_deployment_config_name(scope, id, ecs_deployment_config_name) ⇒ AWSCDK::CodeDeploy::IECSDeploymentConfig

Import a custom Deployment Configuration for an ECS 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.

  • ecs_deployment_config_name (String) —

    the name of the referenced custom Deployment Configuration.

Returns:



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

def self.from_ecs_deployment_config_name(scope, id, ecs_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(ecs_deployment_config_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ecsDeploymentConfigName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codedeploy.EcsDeploymentConfig", "fromEcsDeploymentConfigName", [scope, id, ecs_deployment_config_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/ecs_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_1_MINUTES ⇒ AWSCDK::CodeDeploy::IECSDeploymentConfig

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

Returns:



144
145
146
 
# File 'code_deploy/ecs_deployment_config.rb', line 144

def self.LINEAR_10_PERCENT_EVERY_1_MINUTES()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codedeploy.EcsDeploymentConfig", "LINEAR_10PERCENT_EVERY_1MINUTES")
end

.LINEAR_10_PERCENT_EVERY_3_MINUTES ⇒ AWSCDK::CodeDeploy::IECSDeploymentConfig

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

Returns:



151
152
153
 
# File 'code_deploy/ecs_deployment_config.rb', line 151

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

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


158
159
160
 
# File 'code_deploy/ecs_deployment_config.rb', line 158

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codedeploy.EcsDeploymentConfig", "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:



195
196
197
198
 
# File 'code_deploy/ecs_deployment_config.rb', line 195

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:



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

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) 


98
99
100
 
# File 'code_deploy/ecs_deployment_config.rb', line 98

def deployment_config_arn()
  jsii_get_property("deploymentConfigArn")
end

#deployment_config_name ⇒ String

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

Returns:

  • (String) 


105
106
107
 
# File 'code_deploy/ecs_deployment_config.rb', line 105

def deployment_config_name()
  jsii_get_property("deploymentConfigName")
end

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

A reference to a DeploymentConfig resource.

Returns:



112
113
114
 
# File 'code_deploy/ecs_deployment_config.rb', line 112

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:



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

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


218
219
220
 
# File 'code_deploy/ecs_deployment_config.rb', line 218

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) 


232
233
234
235
236
237
 
# File 'code_deploy/ecs_deployment_config.rb', line 232

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) 


247
248
249
250
 
# File 'code_deploy/ecs_deployment_config.rb', line 247

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) 


55
56
57
 
# File 'code_deploy/ecs_deployment_config.rb', line 55

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) 


84
85
86
 
# File 'code_deploy/ecs_deployment_config.rb', line 84

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



91
92
93
 
# File 'code_deploy/ecs_deployment_config.rb', line 91

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


165
166
167
 
# File 'code_deploy/ecs_deployment_config.rb', line 165

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) 


178
179
180
181
182
183
 
# File 'code_deploy/ecs_deployment_config.rb', line 178

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