Class: AWSCDK::Batch::CfnJobDefinition::EKSPersistentVolumeClaimProperty

Inherits:

Jsii::Struct

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

Defined in:

batch/cfn_job_definition.rb

Overview

A persistentVolumeClaim volume is used to mount a PersistentVolume into a Pod. PersistentVolumeClaims are a way for users to "claim" durable storage without knowing the details of the particular cloud environment. See the information about PersistentVolumes in the Kubernetes documentation .

See Also:

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

Instance Attribute Summary

• #claim_name ⇒ String readonly

  The name of the persistentVolumeClaim bounded to a persistentVolume .

• #read_only ⇒ Boolean, ... readonly

  An optional boolean value indicating if the mount is read only.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(claim_name:, read_only: nil) ⇒ EKSPersistentVolumeClaimProperty constructor

  A new instance of EKSPersistentVolumeClaimProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(claim_name:, read_only: nil) ⇒ EKSPersistentVolumeClaimProperty

Returns a new instance of EKSPersistentVolumeClaimProperty.

Parameters:

• claim_name (String) —

  The name of the persistentVolumeClaim bounded to a persistentVolume .

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

  An optional boolean value indicating if the mount is read only.

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

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

Instance Attribute Details

#claim_name ⇒ String (readonly)

The name of the persistentVolumeClaim bounded to a persistentVolume .

For more information, see Persistent Volume Claims in the Kubernetes documentation .

Returns:

• (String)

See Also:

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

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

def claim_name
  @claim_name
end

#read_only ⇒ Boolean, ... (readonly)

An optional boolean value indicating if the mount is read only.

Default is false. For more information, see Read Only Mounts in the Kubernetes documentation .

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

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

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

def read_only
  @read_only
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :claim_name => "claimName",
    :read_only => "readOnly",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "claimName" => @claim_name,
    "readOnly" => @read_only,
  })
  result.compact
end