Module: AWSCDK::CodeDeploy::IECSDeploymentGroup

Includes:
IResource, Interfaces::AWSCodedeploy::IDeploymentGroupRef
Included in:
ECSDeploymentGroup
Defined in:
code_deploy/iecs_deployment_group.rb

Overview

Interface for an ECS deployment group.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'code_deploy/iecs_deployment_group.rb', line 104

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :deployment_group_ref => { kind: :property, name: "deploymentGroupRef", is_optional: false },
    :application => { kind: :property, name: "application", 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 },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#application ⇒ AWSCDK::CodeDeploy::IECSApplication

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

Returns:



48
49
50
 
# File 'code_deploy/iecs_deployment_group.rb', line 48

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



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

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:



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

def deployment_config()
  jsii_get_property("deploymentConfig")
end

#deployment_group_arn ⇒ String

The ARN of this Deployment Group.

Returns:

  • (String) 


62
63
64
 
# File 'code_deploy/iecs_deployment_group.rb', line 62

def deployment_group_arn()
  jsii_get_property("deploymentGroupArn")
end

#deployment_group_name ⇒ String

The physical name of the CodeDeploy Deployment Group.

Returns:

  • (String) 


69
70
71
 
# File 'code_deploy/iecs_deployment_group.rb', line 69

def deployment_group_name()
  jsii_get_property("deploymentGroupName")
end

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

A reference to a DeploymentGroup resource.

Returns:



41
42
43
 
# File 'code_deploy/iecs_deployment_group.rb', line 41

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:



27
28
29
 
# File 'code_deploy/iecs_deployment_group.rb', line 27

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'code_deploy/iecs_deployment_group.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'code_deploy/iecs_deployment_group.rb', line 34

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



80
81
82
83
84
85
 
# File 'code_deploy/iecs_deployment_group.rb', line 80

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