Class: AWSCDK::CodeDeploy::ECSDeploymentGroup

Inherits:
Resource
  • Object
show all
Includes:
IECSDeploymentGroup
Defined in:
code_deploy/ecs_deployment_group.rb

Overview

A CodeDeploy deployment group that orchestrates ECS blue-green deployments.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ ECSDeploymentGroup

Returns a new instance of ECSDeploymentGroup.

Parameters:



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

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

Class Method Details

.from_ecs_deployment_group_attributes(scope, id, attrs) ⇒ AWSCDK::CodeDeploy::IECSDeploymentGroup

Reference an ECS Deployment Group defined outside the CDK app.

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

Parameters:

  • scope (Constructs::Construct) —

    the parent Construct for this new Construct.

  • id (String) —

    the logical ID of this new Construct.

  • attrs (AWSCDK::CodeDeploy::ECSDeploymentGroupAttributes) —

    the properties of the referenced Deployment Group.

Returns:



52
53
54
55
56
57
58
 
# File 'code_deploy/ecs_deployment_group.rb', line 52

def self.from_ecs_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::ECSDeploymentGroupAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWRlcGxveS5FY3NEZXBsb3ltZW50R3JvdXBBdHRyaWJ1dGVzIn0=")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codedeploy.EcsDeploymentGroup", "fromEcsDeploymentGroupAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'code_deploy/ecs_deployment_group.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 => { 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 },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


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

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



253
254
255
256
 
# File 'code_deploy/ecs_deployment_group.rb', line 253

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

#application ⇒ AWSCDK::CodeDeploy::IECSApplication

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

Returns:



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

def application()
  jsii_get_property("application")
end

#application_name ⇒ String

The name of the Application.

Returns:

  • (String) 


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

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:



192
193
194
195
 
# File 'code_deploy/ecs_deployment_group.rb', line 192

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:



209
210
211
212
 
# File 'code_deploy/ecs_deployment_group.rb', line 209

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

The Deployment Configuration this Group uses.

Returns:



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

def deployment_config()
  jsii_get_property("deploymentConfig")
end

#deployment_group_arn ⇒ String

The ARN of the Deployment Group.

Returns:

  • (String) 


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

def deployment_group_arn()
  jsii_get_property("deploymentGroupArn")
end

#deployment_group_name ⇒ String

The name of the Deployment Group.

Returns:

  • (String) 


141
142
143
 
# File 'code_deploy/ecs_deployment_group.rb', line 141

def deployment_group_name()
  jsii_get_property("deploymentGroupName")
end

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

A reference to a DeploymentGroup resource.

Returns:



148
149
150
 
# File 'code_deploy/ecs_deployment_group.rb', line 148

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:



78
79
80
 
# File 'code_deploy/ecs_deployment_group.rb', line 78

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


215
216
217
 
# File 'code_deploy/ecs_deployment_group.rb', line 215

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) 


229
230
231
232
233
234
 
# File 'code_deploy/ecs_deployment_group.rb', line 229

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) 


244
245
246
247
 
# File 'code_deploy/ecs_deployment_group.rb', line 244

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) 


63
64
65
 
# File 'code_deploy/ecs_deployment_group.rb', line 63

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) 


92
93
94
 
# File 'code_deploy/ecs_deployment_group.rb', line 92

def physical_name()
  jsii_get_property("physicalName")
end

#role ⇒ AWSCDK::IAM::IRole

The service Role of this Deployment Group.

Returns:



155
156
157
 
# File 'code_deploy/ecs_deployment_group.rb', line 155

def role()
  jsii_get_property("role")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



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

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


162
163
164
 
# File 'code_deploy/ecs_deployment_group.rb', line 162

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) 


175
176
177
178
179
180
 
# File 'code_deploy/ecs_deployment_group.rb', line 175

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