Module: AWSCDK::ECS::ICluster

Includes:
IResource, Interfaces::AWSECS::IClusterRef
Included in:
Cluster
Defined in:
ecs/i_cluster.rb

Overview

A regional grouping of one or more container instances on which you can run tasks and services.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'ecs/i_cluster.rb', line 132

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 },
    :cluster_ref => { kind: :property, name: "clusterRef", is_optional: false },
    :cluster_arn => { kind: :property, name: "clusterArn", is_optional: false },
    :cluster_name => { kind: :property, name: "clusterName", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :has_ec2_capacity => { kind: :property, name: "hasEc2Capacity", is_optional: false },
    :vpc => { kind: :property, name: "vpc", is_optional: false },
    :autoscaling_group => { kind: :property, name: "autoscalingGroup", is_optional: true },
    :default_cloud_map_namespace => { kind: :property, name: "defaultCloudMapNamespace", is_optional: true },
    :execute_command_configuration => { kind: :property, name: "executeCommandConfiguration", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

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



127
128
129
130
 
# File 'ecs/i_cluster.rb', line 127

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#autoscaling_group ⇒ AWSCDK::Autoscaling::IAutoScalingGroup?

The autoscaling group added to the cluster if capacity is associated to the cluster.

Returns:



83
84
85
 
# File 'ecs/i_cluster.rb', line 83

def autoscaling_group()
  jsii_get_property("autoscalingGroup")
end

#cluster_arn ⇒ String

The Amazon Resource Name (ARN) that identifies the cluster.

Returns:

  • (String) 


48
49
50
 
# File 'ecs/i_cluster.rb', line 48

def cluster_arn()
  jsii_get_property("clusterArn")
end

#cluster_name ⇒ String

The name of the cluster.

Returns:

  • (String) 


55
56
57
 
# File 'ecs/i_cluster.rb', line 55

def cluster_name()
  jsii_get_property("clusterName")
end

#cluster_ref ⇒ AWSCDK::Interfaces::AWSECS::ClusterReference

A reference to a Cluster resource.

Returns:



41
42
43
 
# File 'ecs/i_cluster.rb', line 41

def cluster_ref()
  jsii_get_property("clusterRef")
end

#connections ⇒ AWSCDK::EC2::Connections

Manage the allowed network connections for the cluster with Security Groups.

Returns:



62
63
64
 
# File 'ecs/i_cluster.rb', line 62

def connections()
  jsii_get_property("connections")
end

#default_cloud_map_namespace ⇒ AWSCDK::ServiceDiscovery::INamespace?

The AWS Cloud Map namespace to associate with the cluster.

Returns:



90
91
92
 
# File 'ecs/i_cluster.rb', line 90

def default_cloud_map_namespace()
  jsii_get_property("defaultCloudMapNamespace")
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 'ecs/i_cluster.rb', line 27

def env()
  jsii_get_property("env")
end

#execute_command_configuration ⇒ AWSCDK::ECS::ExecuteCommandConfiguration?

The execute command configuration for the cluster.

Returns:



97
98
99
 
# File 'ecs/i_cluster.rb', line 97

def execute_command_configuration()
  jsii_get_property("executeCommandConfiguration")
end

#has_ec2_capacity ⇒ Boolean

Specifies whether the cluster has EC2 instance capacity.

Returns:

  • (Boolean) 


69
70
71
 
# File 'ecs/i_cluster.rb', line 69

def has_ec2_capacity()
  jsii_get_property("hasEc2Capacity")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'ecs/i_cluster.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 'ecs/i_cluster.rb', line 34

def stack()
  jsii_get_property("stack")
end

#vpc ⇒ AWSCDK::EC2::IVPC

The VPC associated with the cluster.

Returns:



76
77
78
 
# File 'ecs/i_cluster.rb', line 76

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



108
109
110
111
112
113
 
# File 'ecs/i_cluster.rb', line 108

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