Class: AWSCDK::EKS::CfnCapabilityProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
eks/cfn_capability_props.rb

Overview

Properties for defining a CfnCapability.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(capability_name:, cluster_name:, delete_propagation_policy:, role_arn:, type:, configuration: nil, tags: nil) ⇒ CfnCapabilityProps

Returns a new instance of CfnCapabilityProps.

Parameters:

  • capability_name (String) —

    The unique name of the capability within the cluster.

  • cluster_name (String) —

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

  • delete_propagation_policy (String) —

    The delete propagation policy for the capability.

  • role_arn (String) —

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

  • type (String) —

    The type of capability.

  • configuration (AWSCDK::IResolvable, AWSCDK::EKS::CfnCapability::CapabilityConfigurationProperty, nil) (defaults to: nil) —

    The configuration settings for the capability.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

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



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'eks/cfn_capability_props.rb', line 16

def initialize(capability_name:, cluster_name:, delete_propagation_policy:, role_arn:, type:, configuration: nil, tags: nil)
  @capability_name = capability_name
  Jsii::Type.check_type(@capability_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "capabilityName")
  @cluster_name = cluster_name
  Jsii::Type.check_type(@cluster_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterName")
  @delete_propagation_policy = delete_propagation_policy
  Jsii::Type.check_type(@delete_propagation_policy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deletePropagationPolicy")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @configuration = configuration.is_a?(Hash) ? ::AWSCDK::EKS::CfnCapability::CapabilityConfigurationProperty.new(**configuration.transform_keys(&:to_sym)) : configuration
  Jsii::Type.check_type(@configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2FwYWJpbGl0eS5DYXBhYmlsaXR5Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "configuration") unless @configuration.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#capability_name ⇒ String (readonly)

The unique name of the capability within the cluster.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'eks/cfn_capability_props.rb', line 37

def capability_name
  @capability_name
end

#cluster_name ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



42
43
44
 
# File 'eks/cfn_capability_props.rb', line 42

def cluster_name
  @cluster_name
end

#configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration settings for the capability.

The structure varies depending on the capability type.

Returns:

See Also:



68
69
70
 
# File 'eks/cfn_capability_props.rb', line 68

def configuration
  @configuration
end

#delete_propagation_policy ⇒ String (readonly)

The delete propagation policy for the capability.

Currently, the only supported value is RETAIN , which keeps all resources managed by the capability when the capability is deleted.

Returns:

  • (String)

See Also:



49
50
51
 
# File 'eks/cfn_capability_props.rb', line 49

def delete_propagation_policy
  @delete_propagation_policy
end

#role_arn ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



54
55
56
 
# File 'eks/cfn_capability_props.rb', line 54

def role_arn
  @role_arn
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

Returns:

See Also:



73
74
75
 
# File 'eks/cfn_capability_props.rb', line 73

def tags
  @tags
end

#type ⇒ String (readonly)

The type of capability.

Valid values are ACK , ARGOCD , or KRO .

Returns:

  • (String)

See Also:



61
62
63
 
# File 'eks/cfn_capability_props.rb', line 61

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
 
# File 'eks/cfn_capability_props.rb', line 75

def self.jsii_properties
  {
    :capability_name => "capabilityName",
    :cluster_name => "clusterName",
    :delete_propagation_policy => "deletePropagationPolicy",
    :role_arn => "roleArn",
    :type => "type",
    :configuration => "configuration",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'eks/cfn_capability_props.rb', line 87

def to_jsii
  result = {}
  result.merge!({
    "capabilityName" => @capability_name,
    "clusterName" => @cluster_name,
    "deletePropagationPolicy" => @delete_propagation_policy,
    "roleArn" => @role_arn,
    "type" => @type,
    "configuration" => @configuration,
    "tags" => @tags,
  })
  result.compact
end