Class: AWSCDK::Batch::SecretPathVolume

Inherits:
EKSVolume
  • Object
show all
Defined in:
batch/secret_path_volume.rb

Overview

Specifies the configuration of a Kubernetes secret volume.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ SecretPathVolume

Returns a new instance of SecretPathVolume.

Parameters:



11
12
13
14
15
 
# File 'batch/secret_path_volume.rb', line 11

def initialize(options)
  options = options.is_a?(Hash) ? ::AWSCDK::Batch::SecretPathVolumeOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmF0Y2guU2VjcmV0UGF0aFZvbHVtZU9wdGlvbnMifQ==")), "options")
  Jsii::Object.instance_method(:initialize).bind(self).call(options)
end

Class Method Details

.is_secret_path_volume(x) ⇒ Boolean

returns true if x is a SecretPathVolume and false otherwise.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


31
32
33
34
 
# File 'batch/secret_path_volume.rb', line 31

def self.is_secret_path_volume(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_batch.SecretPathVolume", "isSecretPathVolume", [x])
end

.jsii_overridable_methods ⇒ Object 



17
18
19
20
21
22
23
24
25
 
# File 'batch/secret_path_volume.rb', line 17

def self.jsii_overridable_methods
  {
    :name => { kind: :property, name: "name", is_optional: false },
    :container_path => { kind: :property, name: "containerPath", is_optional: true },
    :readonly => { kind: :property, name: "readonly", is_optional: true },
    :secret_name => { kind: :property, name: "secretName", is_optional: false },
    :optional => { kind: :property, name: "optional", is_optional: true },
  }
end

Instance Method Details

#container_path ⇒ String?

Note:

Default: - the container is not mounted

The path on the container where the container is mounted.

Returns:

  • (String, nil) 


50
51
52
 
# File 'batch/secret_path_volume.rb', line 50

def container_path()
  jsii_get_property("containerPath")
end

#name ⇒ String

The name of this volume.

The name must be a valid DNS subdomain name.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'batch/secret_path_volume.rb', line 42

def name()
  jsii_get_property("name")
end

#optional ⇒ Boolean?

Note:

Default: true

Specifies whether the secret or the secret's keys must be defined.

Returns:

  • (Boolean, nil) 


78
79
80
 
# File 'batch/secret_path_volume.rb', line 78

def optional()
  jsii_get_property("optional")
end

#readonly ⇒ Boolean?

Note:

Default: false

If specified, the container has readonly access to the volume.

Otherwise, the container has read/write access.

Returns:

  • (Boolean, nil) 


60
61
62
 
# File 'batch/secret_path_volume.rb', line 60

def readonly()
  jsii_get_property("readonly")
end

#secret_name ⇒ String

The name of the secret.

Must be a valid DNS subdomain name.

Returns:

  • (String)

See Also:



70
71
72
 
# File 'batch/secret_path_volume.rb', line 70

def secret_name()
  jsii_get_property("secretName")
end