Package software.amazon.awscdk.services.batch

Interface SecretPathVolumeOptions

All Superinterfaces:

EksVolumeOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SecretPathVolumeOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:57.767Z")
@Stability(Stable)
public interface SecretPathVolumeOptions
extends software.amazon.jsii.JsiiSerializable, EksVolumeOptions

Options for a Kubernetes SecretPath Volume.

Example:

 EksJobDefinition jobDefn;
 jobDefn.container.addVolume(EksVolume.emptyDir(EmptyDirVolumeOptions.builder()
         .name("emptyDir")
         .mountPath("/Volumes/emptyDir")
         .build()));
 jobDefn.container.addVolume(EksVolume.hostPath(HostPathVolumeOptions.builder()
         .name("hostPath")
         .hostPath("/sys")
         .mountPath("/Volumes/hostPath")
         .build()));
 jobDefn.container.addVolume(EksVolume.secret(SecretPathVolumeOptions.builder()
         .name("secret")
         .optional(true)
         .mountPath("/Volumes/secret")
         .secretName("mySecret")
         .build()));
 

See Also:

• https://kubernetes.io/docs/concepts/storage/volumes/#secret

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SecretPathVolumeOptions.Builder	builder()
default Boolean	getOptional()	Specifies whether the secret or the secret's keys must be defined.
String	getSecretName()	The name of the secret.

Methods inherited from interface software.amazon.awscdk.services.batch.EksVolumeOptions

getMountPath, getName, getReadonly

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSecretName

@Stability(Stable)
@NotNull
String getSecretName()

The name of the secret.

Must be a valid DNS subdomain name.

See Also:

• https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names

getOptional

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

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

Default: true

builder

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

Returns:

a SecretPathVolumeOptions.Builder of SecretPathVolumeOptions