Class: AWSCDK::PCS::CfnComputeNodeGroup

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSPCS::IComputeNodeGroupRef
Defined in:
pcs/cfn_compute_node_group.rb

Overview

Creates an AWS PCS compute node group resource.

For more information, see Creating a compute node group in AWS PCS in the AWS PCS User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnComputeNodeGroup

Create a new AWS::PCS::ComputeNodeGroup.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::PCS::CfnComputeNodeGroupProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'pcs/cfn_compute_node_group.rb', line 20

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

Class Method Details

.arn_for_compute_node_group(resource) ⇒ String

Parameters:

Returns:

  • (String) 


88
89
90
91
 
# File 'pcs/cfn_compute_node_group.rb', line 88

def self.arn_for_compute_node_group(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19wY3MuSUNvbXB1dGVOb2RlR3JvdXBSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_pcs.CfnComputeNodeGroup", "arnForComputeNodeGroup", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


195
196
197
 
# File 'pcs/cfn_compute_node_group.rb', line 195

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_pcs.CfnComputeNodeGroup", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_compute_node_group(x) ⇒ Boolean

Checks whether the given object is a CfnComputeNodeGroup.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'pcs/cfn_compute_node_group.rb', line 97

def self.is_cfn_compute_node_group(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_pcs.CfnComputeNodeGroup", "isCfnComputeNodeGroup", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'pcs/cfn_compute_node_group.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_error_info => { kind: :property, name: "attrErrorInfo", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :compute_node_group_ref => { kind: :property, name: "computeNodeGroupRef", is_optional: false },
    :cluster_id => { kind: :property, name: "clusterId", is_optional: false },
    :custom_launch_template => { kind: :property, name: "customLaunchTemplate", is_optional: false },
    :iam_instance_profile_arn => { kind: :property, name: "iamInstanceProfileArn", is_optional: false },
    :instance_configs => { kind: :property, name: "instanceConfigs", is_optional: false },
    :scaling_configuration => { kind: :property, name: "scalingConfiguration", is_optional: false },
    :subnet_ids => { kind: :property, name: "subnetIds", is_optional: false },
    :ami_id => { kind: :property, name: "amiId", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :purchase_option => { kind: :property, name: "purchaseOption", is_optional: true },
    :slurm_configuration => { kind: :property, name: "slurmConfiguration", is_optional: true },
    :spot_options => { kind: :property, name: "spotOptions", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



427
428
429
430
 
# File 'pcs/cfn_compute_node_group.rb', line 427

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



439
440
441
442
 
# File 'pcs/cfn_compute_node_group.rb', line 439

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



449
450
451
452
 
# File 'pcs/cfn_compute_node_group.rb', line 449

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



460
461
462
463
464
 
# File 'pcs/cfn_compute_node_group.rb', line 460

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


517
518
519
520
521
 
# File 'pcs/cfn_compute_node_group.rb', line 517

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



527
528
529
530
 
# File 'pcs/cfn_compute_node_group.rb', line 527

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



539
540
541
542
543
 
# File 'pcs/cfn_compute_node_group.rb', line 539

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#ami_id ⇒ String?

The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances.

Returns:

  • (String, nil) 


320
321
322
 
# File 'pcs/cfn_compute_node_group.rb', line 320

def ami_id()
  jsii_get_property("amiId")
end

#ami_id=(value) ⇒ Object 



324
325
326
327
 
# File 'pcs/cfn_compute_node_group.rb', line 324

def ami_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "amiId") unless value.nil?
  jsii_set_property("amiId", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



552
553
554
555
 
# File 'pcs/cfn_compute_node_group.rb', line 552

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



574
575
576
577
578
579
 
# File 'pcs/cfn_compute_node_group.rb', line 574

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The unique Amazon Resource Name (ARN) of the compute node group.

Returns:

  • (String) 


202
203
204
 
# File 'pcs/cfn_compute_node_group.rb', line 202

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_error_info ⇒ AWSCDK::IResolvable

The list of errors that occurred during compute node group provisioning.

Returns:



209
210
211
 
# File 'pcs/cfn_compute_node_group.rb', line 209

def attr_error_info()
  jsii_get_property("attrErrorInfo")
end

#attr_id ⇒ String

The generated unique ID of the compute node group.

Returns:

  • (String) 


216
217
218
 
# File 'pcs/cfn_compute_node_group.rb', line 216

def attr_id()
  jsii_get_property("attrId")
end

#attr_status ⇒ String

The provisioning status of the compute node group.

The provisioning status doesn't indicate the overall health of the compute node group. > The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED . For more information, see Frequently asked questions about Slurm versions in AWS PCS in the AWS PCS User Guide .

Returns:

  • (String) 


225
226
227
 
# File 'pcs/cfn_compute_node_group.rb', line 225

def attr_status()
  jsii_get_property("attrStatus")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



232
233
234
 
# File 'pcs/cfn_compute_node_group.rb', line 232

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



148
149
150
 
# File 'pcs/cfn_compute_node_group.rb', line 148

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


153
154
155
 
# File 'pcs/cfn_compute_node_group.rb', line 153

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


583
584
585
586
 
# File 'pcs/cfn_compute_node_group.rb', line 583

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


158
159
160
 
# File 'pcs/cfn_compute_node_group.rb', line 158

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


165
166
167
 
# File 'pcs/cfn_compute_node_group.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cluster_id ⇒ String

The ID of the cluster of the compute node group.

Returns:

  • (String) 


246
247
248
 
# File 'pcs/cfn_compute_node_group.rb', line 246

def cluster_id()
  jsii_get_property("clusterId")
end

#cluster_id=(value) ⇒ Object 



250
251
252
253
 
# File 'pcs/cfn_compute_node_group.rb', line 250

def cluster_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterId")
  jsii_set_property("clusterId", value)
end

#compute_node_group_ref ⇒ AWSCDK::Interfaces::AWSPCS::ComputeNodeGroupReference

A reference to a ComputeNodeGroup resource.

Returns:



239
240
241
 
# File 'pcs/cfn_compute_node_group.rb', line 239

def compute_node_group_ref()
  jsii_get_property("computeNodeGroupRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


110
111
112
 
# File 'pcs/cfn_compute_node_group.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_launch_template ⇒ AWSCDK::IResolvable, AWSCDK::PCS::CfnComputeNodeGroup::CustomLaunchTemplateProperty

An Amazon EC2 launch template AWS PCS uses to launch compute nodes.

Returns:



258
259
260
 
# File 'pcs/cfn_compute_node_group.rb', line 258

def custom_launch_template()
  jsii_get_property("customLaunchTemplate")
end

#custom_launch_template=(value) ⇒ Object 



262
263
264
265
266
 
# File 'pcs/cfn_compute_node_group.rb', line 262

def custom_launch_template=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::PCS::CfnComputeNodeGroup::CustomLaunchTemplateProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19wY3MuQ2ZuQ29tcHV0ZU5vZGVHcm91cC5DdXN0b21MYXVuY2hUZW1wbGF0ZVByb3BlcnR5In1dfX0=")), "customLaunchTemplate")
  jsii_set_property("customLaunchTemplate", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'pcs/cfn_compute_node_group.rb', line 170

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



596
597
598
599
600
 
# File 'pcs/cfn_compute_node_group.rb', line 596

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



607
608
609
610
 
# File 'pcs/cfn_compute_node_group.rb', line 607

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#iam_instance_profile_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.

Returns:

  • (String) 


271
272
273
 
# File 'pcs/cfn_compute_node_group.rb', line 271

def iam_instance_profile_arn()
  jsii_get_property("iamInstanceProfileArn")
end

#iam_instance_profile_arn=(value) ⇒ Object 



275
276
277
278
 
# File 'pcs/cfn_compute_node_group.rb', line 275

def iam_instance_profile_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "iamInstanceProfileArn")
  jsii_set_property("iamInstanceProfileArn", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



677
678
679
680
 
# File 'pcs/cfn_compute_node_group.rb', line 677

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#instance_configs ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::PCS::CfnComputeNodeGroup::InstanceConfigProperty>

A list of EC2 instance configurations that AWS PCS can provision in the compute node group.

Returns:



283
284
285
 
# File 'pcs/cfn_compute_node_group.rb', line 283

def instance_configs()
  jsii_get_property("instanceConfigs")
end

#instance_configs=(value) ⇒ Object 



287
288
289
290
 
# File 'pcs/cfn_compute_node_group.rb', line 287

def instance_configs=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcGNzLkNmbkNvbXB1dGVOb2RlR3JvdXAuSW5zdGFuY2VDb25maWdQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "instanceConfigs")
  jsii_set_property("instanceConfigs", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


122
123
124
 
# File 'pcs/cfn_compute_node_group.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name that identifies the compute node group.

Returns:

  • (String, nil) 


332
333
334
 
# File 'pcs/cfn_compute_node_group.rb', line 332

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



336
337
338
339
 
# File 'pcs/cfn_compute_node_group.rb', line 336

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


105
106
107
 
# File 'pcs/cfn_compute_node_group.rb', line 105

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



618
619
620
 
# File 'pcs/cfn_compute_node_group.rb', line 618

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



625
626
627
 
# File 'pcs/cfn_compute_node_group.rb', line 625

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



418
419
420
421
 
# File 'pcs/cfn_compute_node_group.rb', line 418

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#purchase_option ⇒ String?

Specifies how EC2 instances are purchased on your behalf.

Returns:

  • (String, nil) 


344
345
346
 
# File 'pcs/cfn_compute_node_group.rb', line 344

def purchase_option()
  jsii_get_property("purchaseOption")
end

#purchase_option=(value) ⇒ Object 



348
349
350
351
 
# File 'pcs/cfn_compute_node_group.rb', line 348

def purchase_option=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "purchaseOption") unless value.nil?
  jsii_set_property("purchaseOption", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


141
142
143
 
# File 'pcs/cfn_compute_node_group.rb', line 141

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



636
637
638
639
 
# File 'pcs/cfn_compute_node_group.rb', line 636

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


643
644
645
646
 
# File 'pcs/cfn_compute_node_group.rb', line 643

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



653
654
655
656
657
 
# File 'pcs/cfn_compute_node_group.rb', line 653

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#scaling_configuration ⇒ AWSCDK::IResolvable, AWSCDK::PCS::CfnComputeNodeGroup::ScalingConfigurationProperty

Specifies the boundaries of the compute node group auto scaling.

Returns:



295
296
297
 
# File 'pcs/cfn_compute_node_group.rb', line 295

def scaling_configuration()
  jsii_get_property("scalingConfiguration")
end

#scaling_configuration=(value) ⇒ Object 



299
300
301
302
303
 
# File 'pcs/cfn_compute_node_group.rb', line 299

def scaling_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::PCS::CfnComputeNodeGroup::ScalingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19wY3MuQ2ZuQ29tcHV0ZU5vZGVHcm91cC5TY2FsaW5nQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "scalingConfiguration")
  jsii_set_property("scalingConfiguration", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



662
663
664
 
# File 'pcs/cfn_compute_node_group.rb', line 662

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#slurm_configuration ⇒ AWSCDK::IResolvable, ...

Additional options related to the Slurm scheduler.

Returns:



356
357
358
 
# File 'pcs/cfn_compute_node_group.rb', line 356

def slurm_configuration()
  jsii_get_property("slurmConfiguration")
end

#slurm_configuration=(value) ⇒ Object 



360
361
362
363
364
 
# File 'pcs/cfn_compute_node_group.rb', line 360

def slurm_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::PCS::CfnComputeNodeGroup::SlurmConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19wY3MuQ2ZuQ29tcHV0ZU5vZGVHcm91cC5TbHVybUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "slurmConfiguration") unless value.nil?
  jsii_set_property("slurmConfiguration", value)
end

#spot_options ⇒ AWSCDK::IResolvable, ...

Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.

Returns:



369
370
371
 
# File 'pcs/cfn_compute_node_group.rb', line 369

def spot_options()
  jsii_get_property("spotOptions")
end

#spot_options=(value) ⇒ Object 



373
374
375
376
377
 
# File 'pcs/cfn_compute_node_group.rb', line 373

def spot_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::PCS::CfnComputeNodeGroup::SpotOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19wY3MuQ2ZuQ29tcHV0ZU5vZGVHcm91cC5TcG90T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "spotOptions") unless value.nil?
  jsii_set_property("spotOptions", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



131
132
133
 
# File 'pcs/cfn_compute_node_group.rb', line 131

def stack()
  jsii_get_property("stack")
end

#subnet_ids ⇒ Array<String>

The list of subnet IDs where instances are provisioned by the compute node group.

Returns:

  • (Array<String>) 


308
309
310
 
# File 'pcs/cfn_compute_node_group.rb', line 308

def subnet_ids()
  jsii_get_property("subnetIds")
end

#subnet_ids=(value) ⇒ Object 



312
313
314
315
 
# File 'pcs/cfn_compute_node_group.rb', line 312

def subnet_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnetIds")
  jsii_set_property("subnetIds", value)
end

#tags ⇒ Hash{String => String}?

1 or more tags added to the resource.

Returns:

  • (Hash{String => String}, nil) 


382
383
384
 
# File 'pcs/cfn_compute_node_group.rb', line 382

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



386
387
388
389
 
# File 'pcs/cfn_compute_node_group.rb', line 386

def tags=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



394
395
396
 
# File 'pcs/cfn_compute_node_group.rb', line 394

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


178
179
180
 
# File 'pcs/cfn_compute_node_group.rb', line 178

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


188
189
190
 
# File 'pcs/cfn_compute_node_group.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


668
669
670
671
 
# File 'pcs/cfn_compute_node_group.rb', line 668

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


407
408
409
410
411
412
 
# File 'pcs/cfn_compute_node_group.rb', line 407

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