Class: AWSCDK::Batch::CfnJobDefinition::MountPointProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
batch/cfn_job_definition.rb

Overview

Details for a Docker volume mount point that's used in a job's container properties.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(container_path: nil, read_only: nil, source_volume: nil) ⇒ MountPointProperty

Returns a new instance of MountPointProperty.

Parameters:

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

    The path on the container where the host volume is mounted.

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

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

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

    The name of the volume to mount.



2529
2530
2531
2532
2533
2534
2535
2536
 
# File 'batch/cfn_job_definition.rb', line 2529

def initialize(container_path: nil, read_only: nil, source_volume: nil)
  @container_path = container_path
  Jsii::Type.check_type(@container_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "containerPath") unless @container_path.nil?
  @read_only = read_only
  Jsii::Type.check_type(@read_only, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "readOnly") unless @read_only.nil?
  @source_volume = source_volume
  Jsii::Type.check_type(@source_volume, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceVolume") unless @source_volume.nil?
end

Instance Attribute Details

#container_path ⇒ String? (readonly)

The path on the container where the host volume is mounted.

Returns:

  • (String, nil)

See Also:



2542
2543
2544
 
# File 'batch/cfn_job_definition.rb', line 2542

def container_path
  @container_path
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:

See Also:



2549
2550
2551
 
# File 'batch/cfn_job_definition.rb', line 2549

def read_only
  @read_only
end

#source_volume ⇒ String? (readonly)

The name of the volume to mount.

Returns:

  • (String, nil)

See Also:



2554
2555
2556
 
# File 'batch/cfn_job_definition.rb', line 2554

def source_volume
  @source_volume
end

Class Method Details

.jsii_properties ⇒ Object 



2556
2557
2558
2559
2560
2561
2562
 
# File 'batch/cfn_job_definition.rb', line 2556

def self.jsii_properties
  {
    :container_path => "containerPath",
    :read_only => "readOnly",
    :source_volume => "sourceVolume",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2564
2565
2566
2567
2568
2569
2570
2571
2572
 
# File 'batch/cfn_job_definition.rb', line 2564

def to_jsii
  result = {}
  result.merge!({
    "containerPath" => @container_path,
    "readOnly" => @read_only,
    "sourceVolume" => @source_volume,
  })
  result.compact
end