RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken (Cloudera Director :: Plugins :: AWS

java.lang.Object
- java.lang.Enum<RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken>
- - com.cloudera.director.aws.rds.RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken

All Implemented Interfaces:

com.cloudera.director.spi.v1.model.ConfigurationPropertyToken, Serializable, Comparable<RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken>

Enclosing class:

RDSInstanceTemplate
```
public static enum RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken
extends Enum<RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken>
implements com.cloudera.director.spi.v1.model.ConfigurationPropertyToken
```
RDS compute instance configuration properties.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALLOCATED_STORAGE` The amount of storage (in gigabytes) to be initially allocated for the database instance.
`AUTO_MINOR_VERSION_UPGRADE` Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
`AVAILABILITY_ZONE` The availability zone.
`BACKUP_RETENTION_PERIOD` The number of days for which automated backups are retained.
`DB_NAME` The database name (meaning varies by database engine).
`DB_PARAMETER_GROUP_NAME` The name of the DB parameter group to associate with this DB instance.
`DB_SUBNET_GROUP_NAME` The DB subnet group to associate with this DB instance.
`ENGINE` The name of the database engine to be used for this instance.
`ENGINE_VERSION` The version number of the database engine to use.
`INSTANCE_CLASS` The instance class, which represents the compute and memory capacity of the DB instance.
`IOPS` The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
`KMS_KEY_ID` The KMS key identifier for an encrypted DB instance.
`LICENSE_MODEL` The license model information for this DB instance.
`MASTER_USER_PASSWORD` The password for the master database user.
`MASTER_USERNAME` The name of master user for the client DB instance.
`MULTI_AZ` Whether the DB instance is Multi-AZ.
`OPTION_GROUP_NAME` The option group with which the DB instance should be associated.
`PORT` The port number on which the database accepts connections.
`PREFERRED_BACKUP_WINDOW` The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
`PREFERRED_MAINTENANCE_WINDOW` The weekly time range (in UTC) during which system maintenance can occur.
`PUBLICLY_ACCESSIBLE` Whether the DB instance is publicly accessible.
`SKIP_FINAL_SNAPSHOT` Whether to skip a final snapshot before a DB instance is deleted.
`TYPE` The database type to be used for this instance.
`VPC_SECURITY_GROUP_IDS` The comma-separated list of EC2 VPC security groups to associate with this DB instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.cloudera.director.spi.v1.model.ConfigurationProperty`	`unwrap()`
`static RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ALLOCATED_STORAGE
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken ALLOCATED_STORAGE
```
    The amount of storage (in gigabytes) to be initially allocated for the database instance.
  - AUTO_MINOR_VERSION_UPGRADE
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken AUTO_MINOR_VERSION_UPGRADE
```
    Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
  - AVAILABILITY_ZONE
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken AVAILABILITY_ZONE
```
    The availability zone.
    
    Multiple availability zones are linked together by high speed low latency connections. Each zone is a distinct failure domain.
    
    See Also:
    
    Regions and Availability Zones
  - BACKUP_RETENTION_PERIOD
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken BACKUP_RETENTION_PERIOD
```
    The number of days for which automated backups are retained.
  - INSTANCE_CLASS
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken INSTANCE_CLASS
```
    The instance class, which represents the compute and memory capacity of the DB instance.
  - DB_NAME
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken DB_NAME
```
    The database name (meaning varies by database engine).
  - DB_PARAMETER_GROUP_NAME
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken DB_PARAMETER_GROUP_NAME
```
    The name of the DB parameter group to associate with this DB instance.
  - DB_SUBNET_GROUP_NAME
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken DB_SUBNET_GROUP_NAME
```
    The DB subnet group to associate with this DB instance.
  - TYPE
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken TYPE
```
    The database type to be used for this instance.
    
    Note: in order to avoid SPI changes in Director 2.0 while adding support for MariaDB, the handling of this property and the ENGINE property is not ideal. We expose both properties through the metadata and present them to the user, even though the type can be derived from the engine, because the API for database servers requires the database type to be specified and to come from an enum of types supported by Director.
  - ENGINE
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken ENGINE
```
    The name of the database engine to be used for this instance.
    
    Note: in order to avoid SPI changes in Director 2.0 while adding support for MariaDB, the handling of this property and the TYPE property is not ideal. We expose both properties through the metadata and present them to the user, even though the type can be derived from the engine, because the API for database servers requires the database type to be specified and to come from an enum of types supported by Director.
  - ENGINE_VERSION
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken ENGINE_VERSION
```
    The version number of the database engine to use.
  - IOPS
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken IOPS
```
    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
  - KMS_KEY_ID
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken KMS_KEY_ID
```
    The KMS key identifier for an encrypted DB instance.
  - LICENSE_MODEL
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken LICENSE_MODEL
```
    The license model information for this DB instance.
  - MASTER_USERNAME
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken MASTER_USERNAME
```
    The name of master user for the client DB instance.
  - MASTER_USER_PASSWORD
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken MASTER_USER_PASSWORD
```
    The password for the master database user.
  - MULTI_AZ
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken MULTI_AZ
```
    Whether the DB instance is Multi-AZ.
  - OPTION_GROUP_NAME
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken OPTION_GROUP_NAME
```
    The option group with which the DB instance should be associated.
  - PORT
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken PORT
```
    The port number on which the database accepts connections.
  - PREFERRED_BACKUP_WINDOW
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken PREFERRED_BACKUP_WINDOW
```
    The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
  - PREFERRED_MAINTENANCE_WINDOW
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken PREFERRED_MAINTENANCE_WINDOW
```
    The weekly time range (in UTC) during which system maintenance can occur.
  - PUBLICLY_ACCESSIBLE
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken PUBLICLY_ACCESSIBLE
```
    Whether the DB instance is publicly accessible.
  - SKIP_FINAL_SNAPSHOT
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken SKIP_FINAL_SNAPSHOT
```
    Whether to skip a final snapshot before a DB instance is deleted.
  - VPC_SECURITY_GROUP_IDS
```
public static final RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken VPC_SECURITY_GROUP_IDS
```
    The comma-separated list of EC2 VPC security groups to associate with this DB instance.
- Method Detail
  - values
```
public static RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken c : RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - unwrap
```
public com.cloudera.director.spi.v1.model.ConfigurationProperty unwrap()
```
    Specified by:
    
    unwrap in interface com.cloudera.director.spi.v1.model.ConfigurationPropertyToken

Enum RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ALLOCATED_STORAGE

AUTO_MINOR_VERSION_UPGRADE

AVAILABILITY_ZONE

BACKUP_RETENTION_PERIOD

INSTANCE_CLASS

DB_NAME

DB_PARAMETER_GROUP_NAME

DB_SUBNET_GROUP_NAME

TYPE

ENGINE

ENGINE_VERSION

IOPS

KMS_KEY_ID

LICENSE_MODEL

MASTER_USERNAME

MASTER_USER_PASSWORD

MULTI_AZ

OPTION_GROUP_NAME

PORT

PREFERRED_BACKUP_WINDOW

PREFERRED_MAINTENANCE_WINDOW

PUBLICLY_ACCESSIBLE

SKIP_FINAL_SNAPSHOT

VPC_SECURITY_GROUP_IDS

Method Detail

values

valueOf

unwrap