Class: AWSCDK::EKS::CfnCapability

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSEKS::ICapabilityRef
Defined in:
eks/cfn_capability.rb

Overview

An object representing a managed capability in an Amazon EKS cluster.

This includes all configuration, status, and health information for the capability.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCapability

Create a new AWS::EKS::Capability.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::EKS::CfnCapabilityProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'eks/cfn_capability.rb', line 20

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

Class Method Details

.arn_for_capability(resource) ⇒ String

Parameters:

Returns:

  • (String) 


86
87
88
89
 
# File 'eks/cfn_capability.rb', line 86

def self.arn_for_capability(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19la3MuSUNhcGFiaWxpdHlSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_eks.CfnCapability", "arnForCapability", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


193
194
195
 
# File 'eks/cfn_capability.rb', line 193

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

.is_cfn_capability(x) ⇒ Boolean

Checks whether the given object is a CfnCapability.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


95
96
97
98
 
# File 'eks/cfn_capability.rb', line 95

def self.is_cfn_capability(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_eks.CfnCapability", "isCfnCapability", [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
 
# File 'eks/cfn_capability.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_configuration_argo_cd_aws_idc_idc_managed_application_arn => { kind: :property, name: "attrConfigurationArgoCdAwsIdcIdcManagedApplicationArn", is_optional: false },
    :attr_configuration_argo_cd_server_url => { kind: :property, name: "attrConfigurationArgoCdServerUrl", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_modified_at => { kind: :property, name: "attrModifiedAt", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_version => { kind: :property, name: "attrVersion", is_optional: false },
    :capability_ref => { kind: :property, name: "capabilityRef", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :capability_name => { kind: :property, name: "capabilityName", is_optional: false },
    :cluster_name => { kind: :property, name: "clusterName", is_optional: false },
    :delete_propagation_policy => { kind: :property, name: "deletePropagationPolicy", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :configuration => { kind: :property, name: "configuration", 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.



394
395
396
397
 
# File 'eks/cfn_capability.rb', line 394

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:



406
407
408
409
 
# File 'eks/cfn_capability.rb', line 406

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:



416
417
418
419
 
# File 'eks/cfn_capability.rb', line 416

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:



427
428
429
430
431
 
# File 'eks/cfn_capability.rb', line 427

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.


484
485
486
487
488
 
# File 'eks/cfn_capability.rb', line 484

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.



494
495
496
497
 
# File 'eks/cfn_capability.rb', line 494

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.



506
507
508
509
510
 
# File 'eks/cfn_capability.rb', line 506

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

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



519
520
521
522
 
# File 'eks/cfn_capability.rb', line 519

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:



541
542
543
544
545
546
 
# File 'eks/cfn_capability.rb', line 541

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 Amazon Resource Name (ARN) of the capability.

Returns:

  • (String) 


200
201
202
 
# File 'eks/cfn_capability.rb', line 200

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_configuration_argo_cd_aws_idc_idc_managed_application_arn ⇒ String

The ARN of the managed application created in IAM Identity Center for this Argo CD capability.

This application is automatically created and managed by EKS.

Returns:

  • (String) 


209
210
211
 
# File 'eks/cfn_capability.rb', line 209

def attr_configuration_argo_cd_aws_idc_idc_managed_application_arn()
  jsii_get_property("attrConfigurationArgoCdAwsIdcIdcManagedApplicationArn")
end

#attr_configuration_argo_cd_server_url ⇒ String

The URL of the Argo CD server.

Use this URL to access the Argo CD web interface and API.

Returns:

  • (String) 


218
219
220
 
# File 'eks/cfn_capability.rb', line 218

def attr_configuration_argo_cd_server_url()
  jsii_get_property("attrConfigurationArgoCdServerUrl")
end

#attr_created_at ⇒ String

The Unix epoch timestamp in seconds for when the capability was created.

Returns:

  • (String) 


225
226
227
 
# File 'eks/cfn_capability.rb', line 225

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_modified_at ⇒ String

The Unix epoch timestamp in seconds for when the capability was last modified.

Returns:

  • (String) 


232
233
234
 
# File 'eks/cfn_capability.rb', line 232

def attr_modified_at()
  jsii_get_property("attrModifiedAt")
end

#attr_status ⇒ String

The current status of the capability. Valid values include:.

  • CREATING – The capability is being created.
  • ACTIVE – The capability is running and available.
  • UPDATING – The capability is being updated.
  • DELETING – The capability is being deleted.
  • CREATE_FAILED – The capability creation failed.
  • UPDATE_FAILED – The capability update failed.
  • DELETE_FAILED – The capability deletion failed.

Returns:

  • (String) 


247
248
249
 
# File 'eks/cfn_capability.rb', line 247

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_version ⇒ String

The version of the capability software that is currently running.

Returns:

  • (String) 


254
255
256
 
# File 'eks/cfn_capability.rb', line 254

def attr_version()
  jsii_get_property("attrVersion")
end

#capability_name ⇒ String

The unique name of the capability within the cluster.

Returns:

  • (String) 


275
276
277
 
# File 'eks/cfn_capability.rb', line 275

def capability_name()
  jsii_get_property("capabilityName")
end

#capability_name=(value) ⇒ Object 



279
280
281
282
 
# File 'eks/cfn_capability.rb', line 279

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

#capability_ref ⇒ AWSCDK::Interfaces::AWSEKS::CapabilityReference

A reference to a Capability resource.

Returns:



261
262
263
 
# File 'eks/cfn_capability.rb', line 261

def capability_ref()
  jsii_get_property("capabilityRef")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



268
269
270
 
# File 'eks/cfn_capability.rb', line 268

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



146
147
148
 
# File 'eks/cfn_capability.rb', line 146

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


151
152
153
 
# File 'eks/cfn_capability.rb', line 151

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


550
551
552
553
 
# File 'eks/cfn_capability.rb', line 550

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}) 


156
157
158
 
# File 'eks/cfn_capability.rb', line 156

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


163
164
165
 
# File 'eks/cfn_capability.rb', line 163

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cluster_name ⇒ String

The name of the Amazon EKS cluster that contains this capability.

Returns:

  • (String) 


287
288
289
 
# File 'eks/cfn_capability.rb', line 287

def cluster_name()
  jsii_get_property("clusterName")
end

#cluster_name=(value) ⇒ Object 



291
292
293
294
 
# File 'eks/cfn_capability.rb', line 291

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

#configuration ⇒ AWSCDK::IResolvable, ...

The configuration settings for the capability.

Returns:



335
336
337
 
# File 'eks/cfn_capability.rb', line 335

def configuration()
  jsii_get_property("configuration")
end

#configuration=(value) ⇒ Object 



339
340
341
342
343
 
# File 'eks/cfn_capability.rb', line 339

def configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnCapability::CapabilityConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2FwYWJpbGl0eS5DYXBhYmlsaXR5Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "configuration") unless value.nil?
  jsii_set_property("configuration", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


108
109
110
 
# File 'eks/cfn_capability.rb', line 108

def creation_stack()
  jsii_get_property("creationStack")
end

#delete_propagation_policy ⇒ String

The delete propagation policy for the capability.

Returns:

  • (String) 


299
300
301
 
# File 'eks/cfn_capability.rb', line 299

def delete_propagation_policy()
  jsii_get_property("deletePropagationPolicy")
end

#delete_propagation_policy=(value) ⇒ Object 



303
304
305
306
 
# File 'eks/cfn_capability.rb', line 303

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



168
169
170
 
# File 'eks/cfn_capability.rb', line 168

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:



563
564
565
566
567
 
# File 'eks/cfn_capability.rb', line 563

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:



574
575
576
577
 
# File 'eks/cfn_capability.rb', line 574

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



644
645
646
647
 
# File 'eks/cfn_capability.rb', line 644

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


120
121
122
 
# File 'eks/cfn_capability.rb', line 120

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


103
104
105
 
# File 'eks/cfn_capability.rb', line 103

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:



585
586
587
 
# File 'eks/cfn_capability.rb', line 585

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:



592
593
594
 
# File 'eks/cfn_capability.rb', line 592

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.



385
386
387
388
 
# File 'eks/cfn_capability.rb', line 385

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

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


139
140
141
 
# File 'eks/cfn_capability.rb', line 139

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:



603
604
605
606
 
# File 'eks/cfn_capability.rb', line 603

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}) 


610
611
612
613
 
# File 'eks/cfn_capability.rb', line 610

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:



620
621
622
623
624
 
# File 'eks/cfn_capability.rb', line 620

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

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services.

Returns:

  • (String) 


311
312
313
 
# File 'eks/cfn_capability.rb', line 311

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



315
316
317
318
 
# File 'eks/cfn_capability.rb', line 315

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", 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.



629
630
631
 
# File 'eks/cfn_capability.rb', line 629

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



129
130
131
 
# File 'eks/cfn_capability.rb', line 129

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs to apply to this resource.

Returns:



348
349
350
 
# File 'eks/cfn_capability.rb', line 348

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



352
353
354
355
356
 
# File 'eks/cfn_capability.rb', line 352

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "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



361
362
363
 
# File 'eks/cfn_capability.rb', line 361

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

#type ⇒ String

The type of capability.

Returns:

  • (String) 


323
324
325
 
# File 'eks/cfn_capability.rb', line 323

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



327
328
329
330
 
# File 'eks/cfn_capability.rb', line 327

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  jsii_set_property("type", value)
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}) 


176
177
178
 
# File 'eks/cfn_capability.rb', line 176

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}) 


186
187
188
 
# File 'eks/cfn_capability.rb', line 186

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


635
636
637
638
 
# File 'eks/cfn_capability.rb', line 635

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) 


374
375
376
377
378
379
 
# File 'eks/cfn_capability.rb', line 374

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