Class: AWSCDK::ECS::CfnTaskDefinition::HostVolumePropertiesProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ECS::CfnTaskDefinition::HostVolumePropertiesProperty

Defined in:

ecs/cfn_task_definition.rb

Overview

The HostVolumeProperties property specifies details on a container instance bind mount host volume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostvolumeproperties.html

Instance Attribute Summary

• #source_path ⇒ String^? readonly

  When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(source_path: nil) ⇒ HostVolumePropertiesProperty constructor

  A new instance of HostVolumePropertiesProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(source_path: nil) ⇒ HostVolumePropertiesProperty

Returns a new instance of HostVolumePropertiesProperty.

Parameters:

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

  When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container.

# File 'ecs/cfn_task_definition.rb', line 2159

def initialize(source_path: nil)
  @source_path = source_path
  Jsii::Type.check_type(@source_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourcePath") unless @source_path.nil?
end

Instance Attribute Details

#source_path ⇒ String^? (readonly)

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container.

If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a source_path file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source_path value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you're using the Fargate launch type, the source_path parameter is not supported.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostvolumeproperties.html#cfn-ecs-taskdefinition-hostvolumeproperties-sourcepath

# File 'ecs/cfn_task_definition.rb', line 2172

def source_path
  @source_path
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ecs/cfn_task_definition.rb', line 2174

def self.jsii_properties
  {
    :source_path => "sourcePath",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'ecs/cfn_task_definition.rb', line 2180

def to_jsii
  result = {}
  result.merge!({
    "sourcePath" => @source_path,
  })
  result.compact
end