org.mule.extension.rds.internal.operation

Class DBInstanceOperations

java.lang.Object

org.mule.connectors.commons.template.operation.ConnectorOperations<CONFIG,CONNECTION,SERVICE>

org.mule.extension.aws.commons.internal.operation.AWSOperations<RDSConfiguration,RDSConnection,SERVICE>

org.mule.extension.rds.internal.operation.RDSOperations<DBInstanceService>

org.mule.extension.rds.internal.operation.DBInstanceOperations

@Throws(value=RDSErrorTypeProvider.class)
public class DBInstanceOperations
extends RDSOperations<DBInstanceService>

Field Summary

Fields inherited from class org.mule.extension.rds.internal.operation.RDSOperations

MONITORING, SECURITY, STORAGE_AND_MAINTENANCE

Constructor Summary

Constructors

Constructor and Description
DBInstanceOperations()

Method Summary

Modifier and Type	Method and Description
DBInstance	createDbInstance(RDSConfiguration config, RDSConnection client, CreationStorageAndMaintenanceParameterGroup storageAndMaintenanceParameterGroup, CreationSecurityParameterGroup securityParameterGroup, MonitoringParameterGroup monitoringParameterGroup, CreationDBInstanceParameterGroup dbInstanceParameterGroup) Creates a new DB instance.
DBInstance	createDbInstanceReadReplica(RDSConfiguration config, RDSConnection connection, StorageParameterGroup storageParameterGroup, boolean publiclyAccessible, String dbSubnetGroupName, String kmsKeyId, String preSignedUrl, boolean enableIamDatabaseAuthentication, MonitoringParameterGroup monitoringParameterGroup, String dbInstanceIdentifier, String sourceDbInstanceIdentifier, String dbInstanceClass, String availabilityZone, Integer port, Integer iops, String optionGroupName, List<Tag> tags, String sourceRegion) Creates a new DB instance that acts as a Read Replica for an existing source DB instance.
DBInstance	deleteDbInstance(RDSConfiguration config, RDSConnection client, String dbInstanceIdentifier, String finalDbSnapshotIdentifier, boolean skipFinalSnapshot) The DeleteDBInstance action deletes a previously provisioned DB instance.
org.mule.runtime.extension.api.runtime.streaming.PagingProvider<RDSConnection,org.mule.runtime.extension.api.runtime.operation.Result<DBInstance,RequestIDAttribute>>	describeDbInstances(String dbInstanceIdentifier, Collection<Filter> filters) Returns information about provisioned RDS instances.
DBInstance	modifyDbInstance(RDSConfiguration config, RDSConnection client, ModificationStorageAndMaintenanceParameterGroup storageAndMaintenanceParameterGroup, ModificationSecurityParameterGroup securityParameterGroup, MonitoringParameterGroup monitoringParameterGroup, ModificationDBInstanceParameterGroup dbInstanceParameterGroup) Modifies settings for a DB instance.
DBInstance	rebootDbInstance(RDSConfiguration config, RDSConnection client, String dbInstanceIdentifier, boolean forceFailover) Rebooting a DB instance restarts the database engine service.
DBInstance	restoreDbInstanceFromDbSnapshot(RDSConfiguration config, RDSConnection connection, StorageParameterGroup storageParameterGroup, SecurityParameterGroup securityParameterGroup, String availabilityZone, String dbInstanceClass, String dbInstanceIdentifier, String dbSnapshotIdentifier, String dbName, String domain, String engine, Integer iops, boolean multiAZ, String optionGroupName, Integer port, List<Tag> tags) Creates a new DB instance from a DB snapshot.
DBInstance	restoreDbInstanceToPointInTime(RDSConfiguration config, RDSConnection connection, StorageParameterGroup storageParameterGroup, SecurityParameterGroup securityParameterGroup, String availabilityZone, String dbInstanceClass, String dbName, String domain, String engine, Integer iops, boolean multiAZ, String optionGroupName, Integer port, LocalDateTime restoreTime, String sourceDbInstanceIdentifier, List<Tag> tags, String targetDbInstanceIdentifier, boolean useLatestRestorableTime) Restores a DB instance to an arbitrary point in time.
DBInstance	startDbInstance(RDSConfiguration config, RDSConnection client, String dbInstanceIdentifier) Starts a DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action
DBInstance	stopDbInstance(RDSConfiguration config, RDSConnection client, String dbInstanceIdentifier, String dbSnapshotIdentifier) Stops a DB instance.

Methods inherited from class org.mule.extension.aws.commons.internal.operation.AWSOperations

newExecutionBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

DBInstanceOperations

public DBInstanceOperations()

Method Detail

createDbInstance

public DBInstance createDbInstance(@Config
                                   RDSConfiguration config,
                                   @Connection
                                   RDSConnection client,
                                   @ParameterGroup(name="Storage and Maintenance")
                                   CreationStorageAndMaintenanceParameterGroup storageAndMaintenanceParameterGroup,
                                   @ParameterGroup(name="Security")
                                   CreationSecurityParameterGroup securityParameterGroup,
                                   @ParameterGroup(name="Monitoring")
                                   MonitoringParameterGroup monitoringParameterGroup,
                                   @ParameterGroup(name="DB Instance")
                                   CreationDBInstanceParameterGroup dbInstanceParameterGroup)

Creates a new DB instance.

API Reference

Parameters:

config - Configuration for RDS connector.

client - Amazon RDS Client connection instance.

storageAndMaintenanceParameterGroup - Group of parameters for setting up storage and maintenance for DB instance.

securityParameterGroup - Group of parameters for setting up subnet group for DB instance, name of the IAM role to be used when making API calls to the Directory Service, flag to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, license model information for the restored DB instance, accessibility options for the DB instance and TDE encryption credentials.

monitoringParameterGroup - Group of parameters for setting up the monitoring interval (in seconds) and ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs

dbInstanceParameterGroup - Group of parameters for setting up the port number on which the database accepts connections and new DB instance identifier and others DB instance parameters.

Returns:

DBInstance

modifyDbInstance

public DBInstance modifyDbInstance(@Config
                                   RDSConfiguration config,
                                   @Connection
                                   RDSConnection client,
                                   @ParameterGroup(name="Storage and Maintenance")
                                   ModificationStorageAndMaintenanceParameterGroup storageAndMaintenanceParameterGroup,
                                   @ParameterGroup(name="Security")
                                   ModificationSecurityParameterGroup securityParameterGroup,
                                   @ParameterGroup(name="Monitoring")
                                   MonitoringParameterGroup monitoringParameterGroup,
                                   @ParameterGroup(name="DB Instance")
                                   ModificationDBInstanceParameterGroup dbInstanceParameterGroup)

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

API Reference

Parameters:

config - Configuration for RDS connector.

client - Amazon RDS Client connection instance.

storageAndMaintenanceParameterGroup - Group of parameters for setting up storage and maintenance for DB instance.

securityParameterGroup - Group of parameters for setting up subnet group for DB instance, name of the IAM role to be used when making API calls to the Directory Service, flag to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, license model information for the restored DB instance, accessibility options for the DB instance and TDE encryption credentials.

monitoringParameterGroup - Group of parameters for setting up the monitoring interval (in seconds) and ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs

dbInstanceParameterGroup - Group of parameters for setting up the port number on which the database accepts connections and new DB instance identifier and others DB instance parameters.

Returns:

DBInstance

deleteDbInstance

public DBInstance deleteDbInstance(@Config
                                   RDSConfiguration config,
                                   @Connection
                                   RDSConnection client,
                                   @DisplayName(value="DB Instance Identifier")
                                   String dbInstanceIdentifier,
                                   @DisplayName(value="Final DB Snapshot Identifier") @Optional
                                   String finalDbSnapshotIdentifier,
                                   @DisplayName(value="Skip Final Snapshot") @Optional
                                   boolean skipFinalSnapshot)

The DeleteDBInstance action deletes a previously provisioned DB instance.

API Reference

Parameters:

config - Configuration for RDS connector.

client - Amazon RDS Client connection instance.

dbInstanceIdentifier - The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

finalDbSnapshotIdentifier - The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

skipFinalSnapshot - Determines whether a final DB snapshot is created before the DB instance is deleted.

Returns:

DBInstance

startDbInstance

public DBInstance startDbInstance(@Config
                                  RDSConfiguration config,
                                  @Connection
                                  RDSConnection client,
                                  @DisplayName(value="DB Instance Identifier")
                                  String dbInstanceIdentifier)

Starts a DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action

API Reference

Parameters:

config - Configuration for RDS connector.

client - Amazon RDS Client connection instance.

dbInstanceIdentifier - The user-supplied instance identifier.

Returns:

DBInstance

stopDbInstance

public DBInstance stopDbInstance(@Config
                                 RDSConfiguration config,
                                 @Connection
                                 RDSConnection client,
                                 @DisplayName(value="DB Instance Identifier")
                                 String dbInstanceIdentifier,
                                 @DisplayName(value="DB Snapshot Identifier") @Optional
                                 String dbSnapshotIdentifier)

Stops a DB instance.

API Reference

Parameters:

config - Configuration for RDS connector.

client - Amazon RDS Client connection instance.

dbInstanceIdentifier - The user-supplied instance identifier.

dbSnapshotIdentifier - The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

Returns:

DBInstance

rebootDbInstance

public DBInstance rebootDbInstance(@Config
                                   RDSConfiguration config,
                                   @Connection
                                   RDSConnection client,
                                   @DisplayName(value="DB Instance Identifier")
                                   String dbInstanceIdentifier,
                                   @DisplayName(value="Force Failover") @Optional
                                   boolean forceFailover)

Rebooting a DB instance restarts the database engine service.

API Reference

Parameters:

config - Configuration for RDS connector.

client - Amazon RDS Client connection instance.

dbInstanceIdentifier - The DB instance identifier.

forceFailover - When true, the reboot will be conducted through a MultiAZ failover.

Returns:

DBInstance

describeDbInstances

public org.mule.runtime.extension.api.runtime.streaming.PagingProvider<RDSConnection,org.mule.runtime.extension.api.runtime.operation.Result<DBInstance,RequestIDAttribute>> describeDbInstances(@DisplayName(value="DB Instance Identifier") @Optional
                                                                                                                                                                                                 String dbInstanceIdentifier,
                                                                                                                                                                                                 @Optional
                                                                                                                                                                                                 Collection<Filter> filters)

Returns information about provisioned RDS instances. This API supports pagination.

API Reference

Parameters:

dbInstanceIdentifier - The user-supplied instance identifier.

filters - A filter that specifies one or more DB instances to describe.

Returns:

DescribeDBInstancesResult

restoreDbInstanceFromDbSnapshot

public DBInstance restoreDbInstanceFromDbSnapshot(@Config
                                                  RDSConfiguration config,
                                                  @Connection
                                                  RDSConnection connection,
                                                  @ParameterGroup(name="Storage and Maintenance")
                                                  StorageParameterGroup storageParameterGroup,
                                                  @ParameterGroup(name="Security")
                                                  SecurityParameterGroup securityParameterGroup,
                                                  @DisplayName(value="Availability Zone") @Placement(order=1) @Optional
                                                  String availabilityZone,
                                                  @DisplayName(value="DB Instance Class") @Placement(order=2) @Optional
                                                  String dbInstanceClass,
                                                  @DisplayName(value="DB Instance Identifier") @Placement(order=3)
                                                  String dbInstanceIdentifier,
                                                  @DisplayName(value="DB Snapshot Identifier") @Placement(order=4)
                                                  String dbSnapshotIdentifier,
                                                  @DisplayName(value="DB Name") @Placement(order=5) @Optional
                                                  String dbName,
                                                  @Placement(order=6) @Optional
                                                  String domain,
                                                  @Placement(order=7) @Optional
                                                  String engine,
                                                  @DisplayName(value="IOPS") @Placement(order=8) @Optional
                                                  Integer iops,
                                                  @DisplayName(value="Multi AZ") @Placement(order=9) @Optional(defaultValue="false")
                                                  boolean multiAZ,
                                                  @DisplayName(value="Option Group Name") @Placement(order=10) @Optional
                                                  String optionGroupName,
                                                  @Placement(order=11) @Optional
                                                  Integer port,
                                                  @Placement(order=12) @Optional
                                                  List<Tag> tags)

Creates a new DB instance from a DB snapshot.

API Reference

Parameters:

config - Configuration for RDS connector.

connection - Amazon RDS Client connection instance.

storageParameterGroup - Group of parameters for setting up auto minor version upgrade, storage type for read replica and a flag indicating whether to copy tags to read replica snapshots

securityParameterGroup - Group of parameters for setting up subnet group for DB instance, name of the IAM role to be used when making API calls to the Directory Service, flag to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, license model information for the restored DB instance, accessibility options for the DB instance and TDE encryption credentials.

availabilityZone - The EC2 Availability Zone that the database instance will be created in.

dbInstanceClass - The compute and memory capacity of the Amazon RDS DB instance.

dbInstanceIdentifier - Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

dbSnapshotIdentifier - The identifier for the DB snapshot to restore from.

dbName - The database name for the restored DB instance.

domain - Specify the Active Directory Domain to restore the instance in.

engine - The database engine to use for the new instance.

iops - Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.

multiAZ - Specifies if the DB instance is a Multi-AZ deployment.

optionGroupName - The name of the option group to be used for the restored DB instance.

port - The port number on which the database accepts connections.

tags - A list of tags.

Returns:

DBInstance

restoreDbInstanceToPointInTime

public DBInstance restoreDbInstanceToPointInTime(@Config
                                                 RDSConfiguration config,
                                                 @Connection
                                                 RDSConnection connection,
                                                 @ParameterGroup(name="Storage and Maintenance")
                                                 StorageParameterGroup storageParameterGroup,
                                                 @ParameterGroup(name="Security")
                                                 SecurityParameterGroup securityParameterGroup,
                                                 @DisplayName(value="Availability Zone") @Placement(order=1) @Optional
                                                 String availabilityZone,
                                                 @DisplayName(value="DB Instance Class") @Placement(order=2) @Optional
                                                 String dbInstanceClass,
                                                 @DisplayName(value="DB Name") @Placement(order=3) @Optional
                                                 String dbName,
                                                 @Placement(order=4) @Optional
                                                 String domain,
                                                 @Placement(order=5) @Optional
                                                 String engine,
                                                 @DisplayName(value="IOPS") @Placement(order=6) @Optional
                                                 Integer iops,
                                                 @DisplayName(value="Multi AZ") @Placement(order=7) @Optional(defaultValue="false")
                                                 boolean multiAZ,
                                                 @DisplayName(value="Option Group Name") @Placement(order=8) @Optional
                                                 String optionGroupName,
                                                 @Placement(order=9) @Optional
                                                 Integer port,
                                                 @DisplayName(value="Restore Time") @Placement(order=10) @Optional
                                                 LocalDateTime restoreTime,
                                                 @DisplayName(value="Source DB Instance Identifier") @Placement(order=11)
                                                 String sourceDbInstanceIdentifier,
                                                 @Placement(order=12) @Optional
                                                 List<Tag> tags,
                                                 @DisplayName(value="Target DB Instance Identifier") @Placement(order=13)
                                                 String targetDbInstanceIdentifier,
                                                 @DisplayName(value="Use Latest Restorable Time") @Placement(order=14) @Optional
                                                 boolean useLatestRestorableTime)

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

API Reference

Parameters:

config - Configuration for RDS connector.

connection - Amazon RDS Client connection instance.

storageParameterGroup - Group of parameters for setting up auto minor version upgrade, storage type for read replica and a flag indicating whether to copy tags to read replica snapshots

securityParameterGroup - Group of parameters for setting up subnet group for DB instance, name of the IAM role to be used when making API calls to the Directory Service, flag to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, license model information for the restored DB instance, accessibility options for the DB instance and TDE encryption credentials.

availabilityZone - The EC2 Availability Zone that the database instance will be created in.

dbInstanceClass - The compute and memory capacity of the Amazon RDS DB instance.

dbName - The database name for the restored DB instance.

domain - Specify the Active Directory Domain to restore the instance in.

engine - The database engine to use for the new instance.

iops - The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

multiAZ - Specifies if the DB instance is a Multi-AZ deployment.

optionGroupName - The name of the option group to be used for the restored DB instance.

port - The port number on which the database accepts connections.

restoreTime - The date and time to restore from.

sourceDbInstanceIdentifier - The identifier of the source DB instance from which to restore.

tags - A list of tags.

targetDbInstanceIdentifier - The name of the new database instance to be created.

useLatestRestorableTime - Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

Returns:

DBInstance

createDbInstanceReadReplica

public DBInstance createDbInstanceReadReplica(@Config
                                              RDSConfiguration config,
                                              @Connection
                                              RDSConnection connection,
                                              @ParameterGroup(name="Storage and Maintenance")
                                              StorageParameterGroup storageParameterGroup,
                                              @DisplayName(value="Publicly Accessible") @Placement(tab="Security",order=1) @Optional(defaultValue="false")
                                              boolean publiclyAccessible,
                                              @DisplayName(value="DB Subnet Group Name") @Placement(tab="Security",order=2) @Optional
                                              String dbSubnetGroupName,
                                              @DisplayName(value="KMS Key ID") @Placement(tab="Security",order=3) @Optional
                                              String kmsKeyId,
                                              @DisplayName(value="Pre-Signed URL") @Placement(tab="Security",order=4) @Optional
                                              String preSignedUrl,
                                              @DisplayName(value="Enable IAM Database Authentication") @Placement(tab="Security",order=5) @Optional(defaultValue="false")
                                              boolean enableIamDatabaseAuthentication,
                                              @ParameterGroup(name="Monitoring")
                                              MonitoringParameterGroup monitoringParameterGroup,
                                              @DisplayName(value="DB Instance Identifier")
                                              String dbInstanceIdentifier,
                                              @DisplayName(value="Source DB Instance Identifier")
                                              String sourceDbInstanceIdentifier,
                                              @DisplayName(value="DB Instance Class") @Placement(order=1) @Optional
                                              String dbInstanceClass,
                                              @DisplayName(value="Availability Zone") @Placement(order=2) @Optional
                                              String availabilityZone,
                                              @Placement(order=3) @Optional
                                              Integer port,
                                              @DisplayName(value="IOPS") @Placement(order=4) @Optional
                                              Integer iops,
                                              @DisplayName(value="Option Group Name") @Placement(order=5) @Optional
                                              String optionGroupName,
                                              @Placement(order=6) @Optional
                                              List<Tag> tags,
                                              @DisplayName(value="Source Region") @Placement(order=7) @Optional
                                              String sourceRegion)

Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL. Amazon Aurora does not support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.

API Reference

Parameters:

config - Configuration for RDS connector.

connection - Amazon RDS Client connection instance.

storageParameterGroup - Group of parameters for setting up auto minor version upgrade, storage type for read replica and a flag indicating whether to copy tags to read replica snapshots

publiclyAccessible - Specifies the accessibility options for the DB instance.

dbSubnetGroupName - Specifies a DB subnet group for the DB instance.

kmsKeyId - The AWS KMS key ID for an encrypted Read Replica.

preSignedUrl - The URL that contains a Signature Version 4 signed request for the create-db-instance-read-replica API action in the source AWS Region that contains the source DB instance

enableIamDatabaseAuthentication - True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.

monitoringParameterGroup - Group of parameters for setting up the monitoring interval (in seconds) and ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs

dbInstanceIdentifier - The DB instance identifier of the Read Replica.

sourceDbInstanceIdentifier - The identifier of the DB instance that will act as the source for the Read Replica.

dbInstanceClass - The compute and memory capacity of the Read Replica.

availabilityZone - The Amazon EC2 Availability Zone that the Read Replica will be created in.

port - The port number that the DB instance uses for connections.

iops - The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

optionGroupName - The option group the DB instance will be associated with.

tags - A list of tags.

sourceRegion - The ID of the region that contains the source for the read replica.

Returns:

DBInstance