org.mule.extension.rds.internal.operation

Class ReservedDBInstanceOperations

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<ReservedDBInstanceService>

org.mule.extension.rds.internal.operation.ReservedDBInstanceOperations

@Throws(value=RDSErrorTypeProvider.class)
public class ReservedDBInstanceOperations
extends RDSOperations<ReservedDBInstanceService>

Field Summary

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

MONITORING, SECURITY, STORAGE_AND_MAINTENANCE

Constructor Summary

Constructors

Constructor and Description
ReservedDBInstanceOperations()

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.extension.api.runtime.streaming.PagingProvider<RDSConnection,org.mule.runtime.extension.api.runtime.operation.Result<ReservedDBInstance,RequestIDAttribute>>	describeReservedDbInstances(String reservedDbInstanceId, String reservedDbInstancesOfferingId, String dbInstanceClass, String duration, String productDescription, String offeringType, boolean multiAZ) Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
org.mule.runtime.extension.api.runtime.streaming.PagingProvider<RDSConnection,org.mule.runtime.extension.api.runtime.operation.Result<ReservedDBInstancesOffering,RequestIDAttribute>>	describeReservedDbInstancesOfferings(String dbInstanceClass, String duration, boolean multiAZ, String offeringType, String productDescription, String reservedDbInstancesOfferingId) Lists available reserved DB instance offerings.
ReservedDBInstance	purchaseReservedDbInstancesOffering(RDSConfiguration config, RDSConnection connection, String reservedDbInstancesOfferingId, Integer dbInstanceCount, String reservedDbInstanceId, List<Tag> tags) Purchases a reserved DB instance offering.

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

ReservedDBInstanceOperations

public ReservedDBInstanceOperations()

Method Detail

describeReservedDbInstances

public org.mule.runtime.extension.api.runtime.streaming.PagingProvider<RDSConnection,org.mule.runtime.extension.api.runtime.operation.Result<ReservedDBInstance,RequestIDAttribute>> describeReservedDbInstances(@DisplayName(value="Reserved DB Instance ID") @Optional
                                                                                                                                                                                                                 String reservedDbInstanceId,
                                                                                                                                                                                                                 @DisplayName(value="Reserved DB Instances Offering ID") @Optional
                                                                                                                                                                                                                 String reservedDbInstancesOfferingId,
                                                                                                                                                                                                                 @DisplayName(value="DB Instance Class") @Optional
                                                                                                                                                                                                                 String dbInstanceClass,
                                                                                                                                                                                                                 @Optional
                                                                                                                                                                                                                 String duration,
                                                                                                                                                                                                                 @DisplayName(value="Product Description") @Optional
                                                                                                                                                                                                                 String productDescription,
                                                                                                                                                                                                                 @DisplayName(value="Offering Type") @Optional
                                                                                                                                                                                                                 String offeringType,
                                                                                                                                                                                                                 @DisplayName(value="Multi AZ") @Optional(defaultValue="false")
                                                                                                                                                                                                                 boolean multiAZ)

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

API Reference

Parameters:

reservedDbInstanceId - The reserved DB instance identifier filter value.

reservedDbInstancesOfferingId - The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

dbInstanceClass - The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

duration - The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

productDescription - The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

offeringType - The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

multiAZ - The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

Returns:

DescribeReservedDBInstancesResult

describeReservedDbInstancesOfferings

public org.mule.runtime.extension.api.runtime.streaming.PagingProvider<RDSConnection,org.mule.runtime.extension.api.runtime.operation.Result<ReservedDBInstancesOffering,RequestIDAttribute>> describeReservedDbInstancesOfferings(@DisplayName(value="DB Instance Class") @Optional
                                                                                                                                                                                                                                   String dbInstanceClass,
                                                                                                                                                                                                                                   @Optional
                                                                                                                                                                                                                                   String duration,
                                                                                                                                                                                                                                   @DisplayName(value="Multi AZ") @Optional(defaultValue="false")
                                                                                                                                                                                                                                   boolean multiAZ,
                                                                                                                                                                                                                                   @DisplayName(value="Offering Type") @Optional
                                                                                                                                                                                                                                   String offeringType,
                                                                                                                                                                                                                                   @DisplayName(value="Product Description") @Optional
                                                                                                                                                                                                                                   String productDescription,
                                                                                                                                                                                                                                   @DisplayName(value="Reserved DB Instances Offering ID") @Optional
                                                                                                                                                                                                                                   String reservedDbInstancesOfferingId)

Lists available reserved DB instance offerings.

API Reference

Parameters:

dbInstanceClass - The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

duration - Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

multiAZ - The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

offeringType - The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

productDescription - Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

reservedDbInstancesOfferingId - The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Returns:

DescribeReservedDBInstancesOfferingsResult

purchaseReservedDbInstancesOffering

public ReservedDBInstance purchaseReservedDbInstancesOffering(@Config
                                                              RDSConfiguration config,
                                                              @Connection
                                                              RDSConnection connection,
                                                              @DisplayName(value="Reserved DB Instances Offering ID")
                                                              String reservedDbInstancesOfferingId,
                                                              @DisplayName(value="DB Instance Count") @Optional
                                                              Integer dbInstanceCount,
                                                              @DisplayName(value="Reserved DB Instance ID") @Optional
                                                              String reservedDbInstanceId,
                                                              @Optional
                                                              List<Tag> tags)

Purchases a reserved DB instance offering.

API Reference

Parameters:

config - Configuration for RDS connector.

connection - Amazon RDS Client connection instance.

reservedDbInstancesOfferingId - The ID of the Reserved DB instance offering to purchase.

dbInstanceCount - The number of instances to reserve.

reservedDbInstanceId - Customer-specified identifier to track this reservation.

tags - A list of tags.

Returns:

ReservedDBInstance