Class: AWSCDK::Batch::CfnJobDefinition::EKSContainerVolumeMountProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Batch::CfnJobDefinition::EKSContainerVolumeMountProperty

Defined in:

batch/cfn_job_definition.rb

Overview

The volume mounts for a container for an Amazon EKS job.

For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainervolumemount.html

Instance Attribute Summary

• #mount_path ⇒ String^? readonly

  The path on the container where the volume is mounted.

• #name ⇒ String^? readonly

  The name the volume mount.

• #read_only ⇒ Boolean, ... readonly

  If this value is true , the container has read-only access to the volume.

• #sub_path ⇒ String^? readonly

  A sub-path inside the referenced volume instead of its root.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(mount_path: nil, name: nil, read_only: nil, sub_path: nil) ⇒ EKSContainerVolumeMountProperty constructor

  A new instance of EKSContainerVolumeMountProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(mount_path: nil, name: nil, read_only: nil, sub_path: nil) ⇒ EKSContainerVolumeMountProperty

Returns a new instance of EKSContainerVolumeMountProperty.

Parameters:

• mount_path (String, nil) (defaults to: nil) —

  The path on the container where the volume is mounted.

• name (String, nil) (defaults to: nil) —

  The name the volume mount.

• read_only (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  If this value is true , the container has read-only access to the volume.

• sub_path (String, nil) (defaults to: nil) —

  A sub-path inside the referenced volume instead of its root.

# File 'batch/cfn_job_definition.rb', line 1647

def initialize(mount_path: nil, name: nil, read_only: nil, sub_path: nil)
  @mount_path = mount_path
  Jsii::Type.check_type(@mount_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mountPath") unless @mount_path.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @read_only = read_only
  Jsii::Type.check_type(@read_only, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "readOnly") unless @read_only.nil?
  @sub_path = sub_path
  Jsii::Type.check_type(@sub_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subPath") unless @sub_path.nil?
end

Instance Attribute Details

#mount_path ⇒ String^? (readonly)

The path on the container where the volume is mounted.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainervolumemount.html#cfn-batch-jobdefinition-ekscontainervolumemount-mountpath

# File 'batch/cfn_job_definition.rb', line 1662

def mount_path
  @mount_path
end

#name ⇒ String^? (readonly)

The name the volume mount.

This must match the name of one of the volumes in the pod.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainervolumemount.html#cfn-batch-jobdefinition-ekscontainervolumemount-name

# File 'batch/cfn_job_definition.rb', line 1669

def name
  @name
end

#read_only ⇒ Boolean, ... (readonly)

If this value is true , the container has read-only access to the volume.

Otherwise, the container can write to the volume. The default value is false .

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainervolumemount.html#cfn-batch-jobdefinition-ekscontainervolumemount-readonly

# File 'batch/cfn_job_definition.rb', line 1676

def read_only
  @read_only
end

#sub_path ⇒ String^? (readonly)

A sub-path inside the referenced volume instead of its root.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ekscontainervolumemount.html#cfn-batch-jobdefinition-ekscontainervolumemount-subpath

# File 'batch/cfn_job_definition.rb', line 1681

def sub_path
  @sub_path
end

Class Method Details

.jsii_properties ⇒ Object

# File 'batch/cfn_job_definition.rb', line 1683

def self.jsii_properties
  {
    :mount_path => "mountPath",
    :name => "name",
    :read_only => "readOnly",
    :sub_path => "subPath",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'batch/cfn_job_definition.rb', line 1692

def to_jsii
  result = {}
  result.merge!({
    "mountPath" => @mount_path,
    "name" => @name,
    "readOnly" => @read_only,
    "subPath" => @sub_path,
  })
  result.compact
end