com.cloudera.director.aws.rds

Class RDSInstanceTemplate

java.lang.Object

com.cloudera.director.spi.v1.model.util.AbstractConfigured

com.cloudera.director.spi.v1.model.util.SimpleResourceTemplate

com.cloudera.director.spi.v1.model.InstanceTemplate

com.cloudera.director.spi.v1.database.DatabaseServerInstanceTemplate

com.cloudera.director.aws.rds.RDSInstanceTemplate

All Implemented Interfaces:

com.cloudera.director.spi.v1.model.Configured, com.cloudera.director.spi.v1.model.ResourceTemplate

public class RDSInstanceTemplate
extends com.cloudera.director.spi.v1.database.DatabaseServerInstanceTemplate

Represents a template for constructing RDS database server instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RDSInstanceTemplate.RDSInstanceTemplateConfigurationPropertyToken RDS compute instance configuration properties.

Nested classes/interfaces inherited from class com.cloudera.director.spi.v1.database.DatabaseServerInstanceTemplate

com.cloudera.director.spi.v1.database.DatabaseServerInstanceTemplate.DatabaseServerInstanceTemplateConfigurationPropertyToken

Nested classes/interfaces inherited from class com.cloudera.director.spi.v1.model.InstanceTemplate

com.cloudera.director.spi.v1.model.InstanceTemplate.InstanceTemplateConfigurationPropertyToken

Nested classes/interfaces inherited from class com.cloudera.director.spi.v1.model.util.SimpleResourceTemplate

com.cloudera.director.spi.v1.model.util.SimpleResourceTemplate.SimpleResourceTemplateConfigurationPropertyToken

Constructor Summary

Constructors

Constructor and Description
RDSInstanceTemplate(String name, com.cloudera.director.spi.v1.model.Configured configuration, Map<String,String> tags, com.cloudera.director.spi.v1.model.LocalizationContext providerLocalizationContext) Creates an RDS instance template with the specified parameters.

Method Summary

Modifier and Type	Method and Description
int	getAllocatedStorage() Returns the optional amount of storage (in gigabytes) to be initially allocated for the database instance.
com.google.common.base.Optional<Boolean>	getAutoMinorVersionUpgrade() Returns whether minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
com.google.common.base.Optional<String>	getAvailabilityZone() Returns the optional availability zone.
com.google.common.base.Optional<Integer>	getBackupRetentionPeriod() Returns the optional number of days for which automated backups are retained.
static List<com.cloudera.director.spi.v1.model.ConfigurationProperty>	getConfigurationProperties() Returns the list of configuration properties for creating an RDS instance template, including inherited properties.
com.google.common.base.Optional<String>	getDbName() Returns the optional database name (meaning varies by database engine).
com.google.common.base.Optional<String>	getDbParameterGroupName() Returns the optional name of the DB parameter group to associate with this DB instance.
String	getDbSubnetGroupName() Returns the optional DB subnet group to associate with this DB instance.
String	getEngine() Returns the name of the database engine to be used for this instance.
com.google.common.base.Optional<String>	getEngineVersion() Returns the optional version number of the database engine to use.
String	getInstanceClass() Returns the optional instance class, which represents the compute and memory capacity of the DB instance.
com.google.common.base.Optional<String>	getLicenseModel() Returns the optional license model information for this DB instance.
com.google.common.base.Optional<String>	getMasterUsername() Returns the optional name of master user for the client DB instance.
com.google.common.base.Optional<String>	getMasterUserPassword() Returns the optional password for the master database user.
protected com.google.common.base.Optional<Boolean>	getOptionalBooleanConfigurationValue(com.cloudera.director.spi.v1.model.ConfigurationPropertyToken configurationPropertyToken, com.cloudera.director.spi.v1.model.LocalizationContext localizationContext) Returns the optional boolean value of the specified configuration property.
protected com.google.common.base.Optional<Integer>	getOptionalIntegerConfigurationParameterValue(com.cloudera.director.spi.v1.model.ConfigurationPropertyToken configurationPropertyToken, com.cloudera.director.spi.v1.model.LocalizationContext localizationContext) Returns the optional integer value of the specified configuration property.
protected com.google.common.base.Optional<List<String>>	getOptionalListConfigurationParameterValue(com.cloudera.director.spi.v1.model.ConfigurationPropertyToken configurationPropertyToken, com.cloudera.director.spi.v1.model.LocalizationContext localizationContext) Returns the optional string list value of the specified configuration property.
com.google.common.base.Optional<String>	getOptionGroupName() Returns the optional option group with which the DB instance should be associated.
com.google.common.base.Optional<Integer>	getPort() Returns the port number on which the database accepts connections.
com.google.common.base.Optional<String>	getPreferredBackupWindow() Returns the optional daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
com.google.common.base.Optional<String>	getPreferredMaintenanceWindow() Returns the optional weekly time range (in UTC) during which system maintenance can occur.
List<String>	getVpcSecurityGroupIds() Returns the comma-separated list of EC2 VPC security groups to associate with this DB instance.
com.google.common.base.Optional<Boolean>	isMultiAZ() Returns whether the DB instance is Multi-AZ.
com.google.common.base.Optional<Boolean>	isPubliclyAccessible() Returns whether the DB instance is publicly accessible.
com.google.common.base.Optional<Boolean>	isSkipFinalSnapshot() Returns whether to skip a final snapshot before the DB instance is deleted.

Methods inherited from class com.cloudera.director.spi.v1.database.DatabaseServerInstanceTemplate

getAdminPassword, getAdminUser, getDatabaseType

Methods inherited from class com.cloudera.director.spi.v1.model.InstanceTemplate

getInstanceNamePrefix

Methods inherited from class com.cloudera.director.spi.v1.model.util.SimpleResourceTemplate

getLocalizationContext, getName, getTags, getTemplateLocalizationContext, unwrap

Methods inherited from class com.cloudera.director.spi.v1.model.util.AbstractConfigured

getConfiguration, getConfigurationValue, getConfigurationValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.cloudera.director.spi.v1.model.Configured

getConfiguration, getConfigurationValue, getConfigurationValue

Constructor Detail

RDSInstanceTemplate

public RDSInstanceTemplate(String name,
                           com.cloudera.director.spi.v1.model.Configured configuration,
                           Map<String,String> tags,
                           com.cloudera.director.spi.v1.model.LocalizationContext providerLocalizationContext)

Creates an RDS instance template with the specified parameters.

Parameters:

name - the name of the template

configuration - the source of configuration

tags - the map of tags to be applied to resources created from the template

providerLocalizationContext - the parent provider localization context

Method Detail

getConfigurationProperties

public static List<com.cloudera.director.spi.v1.model.ConfigurationProperty> getConfigurationProperties()

Returns the list of configuration properties for creating an RDS instance template, including inherited properties.

Returns:

the list of configuration properties for creating an RDS instance template, including inherited properties

getAllocatedStorage

public int getAllocatedStorage()

Returns the optional amount of storage (in gigabytes) to be initially allocated for the database instance.

Returns:

the optional amount of storage (in gigabytes) to be initially allocated for the database instance.

getAutoMinorVersionUpgrade

public com.google.common.base.Optional<Boolean> getAutoMinorVersionUpgrade()

Returns whether minor engine upgrades will be applied automatically to the DB instance during the maintenance window.

Returns:

whether minor engine upgrades will be applied automatically to the DB instance during the maintenance window.

getAvailabilityZone

public com.google.common.base.Optional<String> getAvailabilityZone()

Returns the optional availability zone.

Returns:

the optional availability zone.

getBackupRetentionPeriod

public com.google.common.base.Optional<Integer> getBackupRetentionPeriod()

Returns the optional number of days for which automated backups are retained.

Returns:

the optional number of days for which automated backups are retained.

getInstanceClass

public String getInstanceClass()

Returns the optional instance class, which represents the compute and memory capacity of the DB instance.

Returns:

the optional instance class, which represents the compute and memory capacity of the DB instance.

getDbName

public com.google.common.base.Optional<String> getDbName()

Returns the optional database name (meaning varies by database engine).

Returns:

the optional database name (meaning varies by database engine).

getDbParameterGroupName

public com.google.common.base.Optional<String> getDbParameterGroupName()

Returns the optional name of the DB parameter group to associate with this DB instance.

Returns:

the optional name of the DB parameter group to associate with this DB instance.

getDbSubnetGroupName

public String getDbSubnetGroupName()

Returns the optional DB subnet group to associate with this DB instance.

Returns:

the optional DB subnet group to associate with this DB instance.

getEngine

public String getEngine()

Returns the name of the database engine to be used for this instance.

Returns:

the name of the database engine to be used for this instance.

getEngineVersion

public com.google.common.base.Optional<String> getEngineVersion()

Returns the optional version number of the database engine to use.

Returns:

the optional version number of the database engine to use.

getLicenseModel

public com.google.common.base.Optional<String> getLicenseModel()

Returns the optional license model information for this DB instance.

Returns:

the optional license model information for this DB instance.

getMasterUsername

public com.google.common.base.Optional<String> getMasterUsername()

Returns the optional name of master user for the client DB instance.

Returns:

the optional name of master user for the client DB instance.

getMasterUserPassword

public com.google.common.base.Optional<String> getMasterUserPassword()

Returns the optional password for the master database user.

Returns:

the optional password for the master database user.

isMultiAZ

public com.google.common.base.Optional<Boolean> isMultiAZ()

Returns whether the DB instance is Multi-AZ.

Returns:

whether the DB instance is Multi-AZ.

getOptionGroupName

public com.google.common.base.Optional<String> getOptionGroupName()

Returns the optional option group with which the DB instance should be associated.

Returns:

the optional option group with which the DB instance should be associated.

getPort

public com.google.common.base.Optional<Integer> getPort()

Returns the port number on which the database accepts connections.

Returns:

the port number on which the database accepts connections.

getPreferredBackupWindow

public com.google.common.base.Optional<String> getPreferredBackupWindow()

Returns the optional daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Returns:

the optional daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

getPreferredMaintenanceWindow

public com.google.common.base.Optional<String> getPreferredMaintenanceWindow()

Returns the optional weekly time range (in UTC) during which system maintenance can occur.

Returns:

the optional weekly time range (in UTC) during which system maintenance can occur.

isPubliclyAccessible

public com.google.common.base.Optional<Boolean> isPubliclyAccessible()

Returns whether the DB instance is publicly accessible.

Returns:

whether the DB instance is publicly accessible.

isSkipFinalSnapshot

public com.google.common.base.Optional<Boolean> isSkipFinalSnapshot()

Returns whether to skip a final snapshot before the DB instance is deleted.

Returns:

whether to skip a final snapshot before the DB instance is deleted.

getVpcSecurityGroupIds

public List<String> getVpcSecurityGroupIds()

Returns the comma-separated list of EC2 VPC security groups to associate with this DB instance.

Returns:

the comma-separated list of EC2 VPC security groups to associate with this DB instance.

getOptionalIntegerConfigurationParameterValue

protected com.google.common.base.Optional<Integer> getOptionalIntegerConfigurationParameterValue(com.cloudera.director.spi.v1.model.ConfigurationPropertyToken configurationPropertyToken,
                                                                                                 com.cloudera.director.spi.v1.model.LocalizationContext localizationContext)

Returns the optional integer value of the specified configuration property.

Parameters:

configurationPropertyToken - the configuration property

localizationContext - the localization context

Returns:

the optional integer value of the specified configuration property

getOptionalBooleanConfigurationValue

protected com.google.common.base.Optional<Boolean> getOptionalBooleanConfigurationValue(com.cloudera.director.spi.v1.model.ConfigurationPropertyToken configurationPropertyToken,
                                                                                        com.cloudera.director.spi.v1.model.LocalizationContext localizationContext)

Returns the optional boolean value of the specified configuration property.

Parameters:

configurationPropertyToken - the configuration property

localizationContext - the localization context

Returns:

the optional boolean value of the specified configuration property

getOptionalListConfigurationParameterValue

protected com.google.common.base.Optional<List<String>> getOptionalListConfigurationParameterValue(com.cloudera.director.spi.v1.model.ConfigurationPropertyToken configurationPropertyToken,
                                                                                                   com.cloudera.director.spi.v1.model.LocalizationContext localizationContext)

Returns the optional string list value of the specified configuration property.

Parameters:

configurationPropertyToken - the configuration property

localizationContext - the localization context

Returns:

the optional string list value of the specified configuration property