Class: CDK8sPlus25::SshAuthSecretProps

Inherits:
CommonSecretProps
  • Object
show all
Defined in:
ssh_auth_secret_props.rb

Overview

Options for SshAuthSecret.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metadata: nil, immutable: nil, ssh_private_key:) ⇒ SshAuthSecretProps

Returns a new instance of SshAuthSecretProps.

Parameters:

  • metadata (CDK8s::APIObjectMetadata, nil) (defaults to: nil) —

    Metadata that all persisted resources must have, which includes all objects users must create.

  • immutable (Boolean, nil) (defaults to: nil) —

    If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).

  • ssh_private_key (String) —

    The SSH private key to use.



10
11
12
13
14
15
16
17
 
# File 'ssh_auth_secret_props.rb', line 10

def initialize(metadata: nil, immutable: nil, ssh_private_key:)
  @metadata = metadata.is_a?(Hash) ? ::CDK8s::APIObjectMetadata.new(**metadata.transform_keys(&:to_sym)) : metadata
  Jsii::Type.check_type(@metadata, "eyJmcW4iOiJjZGs4cy5BcGlPYmplY3RNZXRhZGF0YSJ9", "metadata") unless @metadata.nil?
  @immutable = immutable
  Jsii::Type.check_type(@immutable, "eyJwcmltaXRpdmUiOiJib29sZWFuIn0=", "immutable") unless @immutable.nil?
  @ssh_private_key = ssh_private_key
  Jsii::Type.check_type(@ssh_private_key, "eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==", "sshPrivateKey")
end

Instance Attribute Details

#immutable ⇒ Boolean? (readonly)

Note:

Default: false

If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).

If not set to true, the field can be modified at any time.

Returns:

  • (Boolean, nil) 


29
30
31
 
# File 'ssh_auth_secret_props.rb', line 29

def immutable
  @immutable
end

#metadata ⇒ CDK8s::APIObjectMetadata? (readonly)

Metadata that all persisted resources must have, which includes all objects users must create.

Returns:



22
23
24
 
# File 'ssh_auth_secret_props.rb', line 22

def metadata
  @metadata
end

#ssh_private_key ⇒ String (readonly)

The SSH private key to use.

Returns:

  • (String) 


33
34
35
 
# File 'ssh_auth_secret_props.rb', line 33

def ssh_private_key
  @ssh_private_key
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
41
 
# File 'ssh_auth_secret_props.rb', line 35

def self.jsii_properties
  {
    :metadata => "metadata",
    :immutable => "immutable",
    :ssh_private_key => "sshPrivateKey",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



43
44
45
46
47
48
49
50
51
52
 
# File 'ssh_auth_secret_props.rb', line 43

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "metadata" => @metadata,
    "immutable" => @immutable,
    "sshPrivateKey" => @ssh_private_key,
  })
  result.compact
end