Package software.amazon.awscdk.services.rds

Interface CfnDBInstance.AdditionalStorageVolumeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBInstance.AdditionalStorageVolumeProperty.Jsii$Proxy

Enclosing class:

CfnDBInstance

@Stability(Stable)
public static interface CfnDBInstance.AdditionalStorageVolumeProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rds.*;
 AdditionalStorageVolumeProperty additionalStorageVolumeProperty = AdditionalStorageVolumeProperty.builder()
         .allocatedStorage("allocatedStorage")
         .iops(123)
         .maxAllocatedStorage(123)
         .storageThroughput(123)
         .storageType("storageType")
         .volumeName("volumeName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-additionalstoragevolume.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDBInstance.AdditionalStorageVolumeProperty.Builder	A builder for CfnDBInstance.AdditionalStorageVolumeProperty
static final class	CfnDBInstance.AdditionalStorageVolumeProperty.Jsii$Proxy	An implementation for CfnDBInstance.AdditionalStorageVolumeProperty

Method Summary

Modifier and Type	Method	Description
static CfnDBInstance.AdditionalStorageVolumeProperty.Builder	builder()
default String	getAllocatedStorage()	The amount of storage allocated for the additional storage volume, in gibibytes (GiB).
default Number	getIops()	The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
default Number	getMaxAllocatedStorage()	The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
default Number	getStorageThroughput()	The storage throughput value for the additional storage volume, in mebibytes per second (MiBps).
default String	getStorageType()	The storage type for the additional storage volume.
default String	getVolumeName()	The name of the additional storage volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllocatedStorage

@Stability(Stable)
@Nullable
default String getAllocatedStorage()

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).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-additionalstoragevolume.html#cfn-rds-dbinstance-additionalstoragevolume-allocatedstorage

getIops

@Stability(Stable)
@Nullable
default Number getIops()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-additionalstoragevolume.html#cfn-rds-dbinstance-additionalstoragevolume-iops

getMaxAllocatedStorage

@Stability(Stable)
@Nullable
default Number getMaxAllocatedStorage()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-additionalstoragevolume.html#cfn-rds-dbinstance-additionalstoragevolume-maxallocatedstorage

getStorageThroughput

@Stability(Stable)
@Nullable
default Number getStorageThroughput()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-additionalstoragevolume.html#cfn-rds-dbinstance-additionalstoragevolume-storagethroughput

getStorageType

@Stability(Stable)
@Nullable
default String getStorageType()

The storage type for the additional storage volume.

Valid Values: GP3 | IO2

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-additionalstoragevolume.html#cfn-rds-dbinstance-additionalstoragevolume-storagetype

getVolumeName

@Stability(Stable)
@Nullable
default String getVolumeName()

The name of the additional storage volume.

Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-additionalstoragevolume.html#cfn-rds-dbinstance-additionalstoragevolume-volumename

builder

@Stability(Stable)
static CfnDBInstance.AdditionalStorageVolumeProperty.Builder builder()

Returns:

a CfnDBInstance.AdditionalStorageVolumeProperty.Builder of CfnDBInstance.AdditionalStorageVolumeProperty