Package org.cdk8s.plus24

Interface ConfigMapVolumeOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ConfigMapVolumeOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-26T02:32:34.751Z")
@Stability(Stable)
public interface ConfigMapVolumeOptions
extends software.amazon.jsii.JsiiSerializable

Options for the ConfigMap-based volume.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ConfigMapVolumeOptions.Builder	A builder for ConfigMapVolumeOptions
static class	ConfigMapVolumeOptions.Jsii$Proxy	An implementation for ConfigMapVolumeOptions

Method Summary

Modifier and Type	Method	Description
static ConfigMapVolumeOptions.Builder	builder()
default Number	getDefaultMode()	Mode bits to use on created files by default.
default Map<String,PathMapping>	getItems()	If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value.
default String	getName()	The volume name.
default Boolean	getOptional()	Specify whether the ConfigMap or its keys must be defined.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDefaultMode

@Stability(Stable)
@Nullable
default Number getDefaultMode()

Mode bits to use on created files by default.

Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

Default: 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

getItems

@Stability(Stable)
@Nullable
default Map<String,PathMapping> getItems()

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value.

If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

Default: - no mapping

getName

@Stability(Stable)
@Nullable
default String getName()

The volume name.

Default: - auto-generated

getOptional

@Stability(Stable)
@Nullable
default Boolean getOptional()

Specify whether the ConfigMap or its keys must be defined.

Default: - undocumented

builder

@Stability(Stable)
static ConfigMapVolumeOptions.Builder builder()

Returns:

a ConfigMapVolumeOptions.Builder of ConfigMapVolumeOptions