Class: AWSCDK::EC2::PlacementGroup

Inherits:
Resource
  • Object
show all
Includes:
IPlacementGroup
Defined in:
ec2/placement_group.rb

Overview

Defines a placement group.

Placement groups give you fine-grained control over where your instances are provisioned.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of PlacementGroup.

Parameters:



15
16
17
18
19
20
21
 
# File 'ec2/placement_group.rb', line 15

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

Class Method Details

.from_placement_group_name(scope, id, placement_group_name) ⇒ AWSCDK::EC2::IPlacementGroup

Import a PlacementGroup by its arn.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • placement_group_name (String)

Returns:



50
51
52
53
54
55
 
# File 'ec2/placement_group.rb', line 50

def self.from_placement_group_name(scope, id, placement_group_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(placement_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "placementGroupName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.PlacementGroup", "fromPlacementGroupName", [scope, id, placement_group_name])
end

.jsii_overridable_methods ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'ec2/placement_group.rb', line 23

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 },
    :placement_group_name => { kind: :property, name: "placementGroupName", is_optional: false },
    :placement_group_ref => { kind: :property, name: "placementGroupRef", is_optional: false },
    :partitions => { kind: :property, name: "partitions", is_optional: true },
    :spread_level => { kind: :property, name: "spreadLevel", is_optional: true },
    :strategy => { kind: :property, name: "strategy", is_optional: true },
    :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

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


103
104
105
 
# File 'ec2/placement_group.rb', line 103

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



189
190
191
192
 
# File 'ec2/placement_group.rb', line 189

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:



206
207
208
209
 
# File 'ec2/placement_group.rb', line 206

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
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:



75
76
77
 
# File 'ec2/placement_group.rb', line 75

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


212
213
214
 
# File 'ec2/placement_group.rb', line 212

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) 


226
227
228
229
230
231
 
# File 'ec2/placement_group.rb', line 226

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) 


241
242
243
244
 
# File 'ec2/placement_group.rb', line 241

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) 


60
61
62
 
# File 'ec2/placement_group.rb', line 60

def node()
  jsii_get_property("node")
end

#partitions ⇒ Numeric?

The number of partitions.

Valid only when Strategy is set to PARTITION.

Returns:

  • (Numeric, nil) 


126
127
128
 
# File 'ec2/placement_group.rb', line 126

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


89
90
91
 
# File 'ec2/placement_group.rb', line 89

def physical_name()
  jsii_get_property("physicalName")
end

#placement_group_name ⇒ String

The name of this placement group.

Returns:

  • (String) 


110
111
112
 
# File 'ec2/placement_group.rb', line 110

def placement_group_name()
  jsii_get_property("placementGroupName")
end

#placement_group_ref ⇒ AWSCDK::Interfaces::AWSEC2::PlacementGroupReference

A reference to a PlacementGroup resource.

Returns:



117
118
119
 
# File 'ec2/placement_group.rb', line 117

def placement_group_ref()
  jsii_get_property("placementGroupRef")
end

#spread_level ⇒ AWSCDK::EC2::PlacementGroupSpreadLevel?

Places instances on distinct hardware.

Spread placement groups are recommended for applications that have a small number of critical instances that should be kept separate from each other. Launching instances in a spread level placement group reduces the risk of simultaneous failures that might occur when instances share the same equipment. Spread level placement groups provide access to distinct hardware, and are therefore suitable for mixing instance types or launching instances over time. If you start or launch an instance in a spread placement group and there is insufficient unique hardware to fulfill the request, the request fails. Amazon EC2 makes more distinct hardware available over time, so you can try your request again later. Placement groups can spread instances across racks or hosts. You can use host level spread placement groups only with AWS Outposts.

Returns:



145
146
147
 
# File 'ec2/placement_group.rb', line 145

def spread_level()
  jsii_get_property("spreadLevel")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



96
97
98
 
# File 'ec2/placement_group.rb', line 96

def stack()
  jsii_get_property("stack")
end

#strategy ⇒ AWSCDK::EC2::PlacementGroupStrategy?

Which strategy to use when launching instances.

Returns:



152
153
154
 
# File 'ec2/placement_group.rb', line 152

def strategy()
  jsii_get_property("strategy")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


159
160
161
 
# File 'ec2/placement_group.rb', line 159

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) 


172
173
174
175
176
177
 
# File 'ec2/placement_group.rb', line 172

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