Module: AWSCDK::CodeDeploy::IECSDeploymentConfig

Includes:
IBaseDeploymentConfig
Included in:
ECSDeploymentConfig
Defined in:
code_deploy/iecs_deployment_config.rb

Overview

The Deployment Configuration of an ECS Deployment Group.

If you're managing the Deployment Configuration alongside the rest of your CDK resources, use the EcsDeploymentConfig class.

If you want to reference an already existing deployment configuration, or one defined in a different CDK Stack, use the EcsDeploymentConfig#fromEcsDeploymentConfigName method.

The default, pre-defined Configurations are available as constants on the EcsDeploymentConfig class (for example, EcsDeploymentConfig.AllAtOnce).

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



75
76
77
78
79
80
81
82
83
84
 
# File 'code_deploy/iecs_deployment_config.rb', line 75

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :deployment_config_ref => { kind: :property, name: "deploymentConfigRef", is_optional: false },
    :deployment_config_arn => { kind: :property, name: "deploymentConfigArn", is_optional: false },
    :deployment_config_name => { kind: :property, name: "deploymentConfigName", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
  }
end

Instance Method Details

#deployment_config_arn ⇒ String

The ARN of the Deployment Configuration.

Returns:

  • (String) 


50
51
52
 
# File 'code_deploy/iecs_deployment_config.rb', line 50

def deployment_config_arn()
  jsii_get_property("deploymentConfigArn")
end

#deployment_config_name ⇒ String

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

Returns:

  • (String) 


57
58
59
 
# File 'code_deploy/iecs_deployment_config.rb', line 57

def deployment_config_name()
  jsii_get_property("deploymentConfigName")
end

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

A reference to a DeploymentConfig resource.

Returns:



43
44
45
 
# File 'code_deploy/iecs_deployment_config.rb', line 43

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:



36
37
38
 
# File 'code_deploy/iecs_deployment_config.rb', line 36

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


21
22
23
 
# File 'code_deploy/iecs_deployment_config.rb', line 21

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



68
69
70
71
72
73
 
# File 'code_deploy/iecs_deployment_config.rb', line 68

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