Class: AWSCDK::RDS::CfnDBInstance::AdditionalStorageVolumeProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/cfn_db_instance.rb

Overview

Contains details about an additional storage volume for a DB instance.

RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allocated_storage: nil, iops: nil, max_allocated_storage: nil, storage_throughput: nil, storage_type: nil, volume_name: nil) ⇒ AdditionalStorageVolumeProperty

Returns a new instance of AdditionalStorageVolumeProperty.

Parameters:

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

    The amount of storage allocated for the additional storage volume, in gibibytes (GiB).

  • iops (Numeric, nil) (defaults to: nil) —

    The number of I/O operations per second (IOPS) provisioned for the additional storage volume.

  • max_allocated_storage (Numeric, nil) (defaults to: nil) —

    The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.

  • storage_throughput (Numeric, nil) (defaults to: nil) —

    The storage throughput value for the additional storage volume, in mebibytes per second (MiBps).

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

    The storage type for the additional storage volume.

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

    The name of the additional storage volume.



1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
 
# File 'rds/cfn_db_instance.rb', line 1862

def initialize(allocated_storage: nil, iops: nil, max_allocated_storage: nil, storage_throughput: nil, storage_type: nil, volume_name: nil)
  @allocated_storage = allocated_storage
  Jsii::Type.check_type(@allocated_storage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "allocatedStorage") unless @allocated_storage.nil?
  @iops = iops
  Jsii::Type.check_type(@iops, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "iops") unless @iops.nil?
  @max_allocated_storage = max_allocated_storage
  Jsii::Type.check_type(@max_allocated_storage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxAllocatedStorage") unless @max_allocated_storage.nil?
  @storage_throughput = storage_throughput
  Jsii::Type.check_type(@storage_throughput, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "storageThroughput") unless @storage_throughput.nil?
  @storage_type = storage_type
  Jsii::Type.check_type(@storage_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "storageType") unless @storage_type.nil?
  @volume_name = volume_name
  Jsii::Type.check_type(@volume_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "volumeName") unless @volume_name.nil?
end

Instance Attribute Details

#allocated_storage ⇒ String? (readonly)

The amount of storage allocated for the additional storage volume, in gibibytes (GiB).

The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).

Returns:

  • (String, nil)

See Also:



1883
1884
1885
 
# File 'rds/cfn_db_instance.rb', line 1883

def allocated_storage
  @allocated_storage
end

#iops ⇒ Numeric? (readonly)

The number of I/O operations per second (IOPS) provisioned for the additional storage volume.

Returns:

  • (Numeric, nil)

See Also:



1888
1889
1890
 
# File 'rds/cfn_db_instance.rb', line 1888

def iops
  @iops
end

#max_allocated_storage ⇒ Numeric? (readonly)

The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.

Returns:

  • (Numeric, nil)

See Also:



1893
1894
1895
 
# File 'rds/cfn_db_instance.rb', line 1893

def max_allocated_storage
  @max_allocated_storage
end

#storage_throughput ⇒ Numeric? (readonly)

The storage throughput value for the additional storage volume, in mebibytes per second (MiBps).

This setting applies only to the General Purpose SSD (gp3) storage type.

Returns:

  • (Numeric, nil)

See Also:



1900
1901
1902
 
# File 'rds/cfn_db_instance.rb', line 1900

def storage_throughput
  @storage_throughput
end

#storage_type ⇒ String? (readonly)

The storage type for the additional storage volume.

Valid Values: GP3 | IO2

Returns:

  • (String, nil)

See Also:



1907
1908
1909
 
# File 'rds/cfn_db_instance.rb', line 1907

def storage_type
  @storage_type
end

#volume_name ⇒ String? (readonly)

The name of the additional storage volume.

Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4

Returns:

  • (String, nil)

See Also:



1914
1915
1916
 
# File 'rds/cfn_db_instance.rb', line 1914

def volume_name
  @volume_name
end

Class Method Details

.jsii_properties ⇒ Object 



1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
 
# File 'rds/cfn_db_instance.rb', line 1916

def self.jsii_properties
  {
    :allocated_storage => "allocatedStorage",
    :iops => "iops",
    :max_allocated_storage => "maxAllocatedStorage",
    :storage_throughput => "storageThroughput",
    :storage_type => "storageType",
    :volume_name => "volumeName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
 
# File 'rds/cfn_db_instance.rb', line 1927

def to_jsii
  result = {}
  result.merge!({
    "allocatedStorage" => @allocated_storage,
    "iops" => @iops,
    "maxAllocatedStorage" => @max_allocated_storage,
    "storageThroughput" => @storage_throughput,
    "storageType" => @storage_type,
    "volumeName" => @volume_name,
  })
  result.compact
end