org.mule.extension.rds.internal.operation

Class DBSnapshotOperations

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

org.mule.extension.rds.internal.operation.DBSnapshotOperations

@Throws(value=RDSErrorTypeProvider.class)
public class DBSnapshotOperations
extends RDSOperations<DBSnapshotService>

Field Summary

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

MONITORING, SECURITY, STORAGE_AND_MAINTENANCE

Constructor Summary

Constructors

Constructor and Description
DBSnapshotOperations()

Method Summary

Modifier and Type	Method and Description
DBSnapshot	createDbSnapshot(RDSConfiguration config, RDSConnection client, String dbInstanceIdentifier, String dbSnapshotIdentifier, List<Tag> tags) Creates a DBSnapshot.
DBSnapshot	deleteDbSnapshot(RDSConfiguration config, RDSConnection connection, String dbSnapshotIdentifier) Deletes a DBSnapshot.
org.mule.runtime.extension.api.runtime.streaming.PagingProvider<RDSConnection,org.mule.runtime.extension.api.runtime.operation.Result<DBSnapshot,RequestIDAttribute>>	describeDbSnapshots(String dbInstanceIdentifier, String dbSnapshotIdentifier, boolean includePublic, boolean includeShared, String snapshotType, Integer maxRecords, Collection<Filter> filters) Returns information about DB snapshots.
DBSnapshot	modifyDbSnapshot(RDSConfiguration config, RDSConnection connection, String dbSnapshotIdentifier, String engineVersion) Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.

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

DBSnapshotOperations

public DBSnapshotOperations()

Method Detail

createDbSnapshot

public DBSnapshot createDbSnapshot(@Config
                                   RDSConfiguration config,
                                   @Connection
                                   RDSConnection client,
                                   @DisplayName(value="DB Instance Identifier")
                                   String dbInstanceIdentifier,
                                   @DisplayName(value="DB Snapshot Identifier")
                                   String dbSnapshotIdentifier,
                                   @Optional
                                   List<Tag> tags)

Creates a DBSnapshot. The source DBInstance must be in "available" state.

API Reference

Parameters:

config - Configuration for RDS connector.

client - Amazon RDS Client connection instance.

dbInstanceIdentifier - The DB instance identifier. This is the unique key that identifies a DB instance.

dbSnapshotIdentifier - The identifier for the DB snapshot.

tags - A list of tags.

Returns:

DBSnapshot

deleteDbSnapshot

public DBSnapshot deleteDbSnapshot(@Config
                                   RDSConfiguration config,
                                   @Connection
                                   RDSConnection connection,
                                   @DisplayName(value="DB Snapshot Identifier")
                                   String dbSnapshotIdentifier)

Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.

API Refernce

Parameters:

config - Configuration for RDS connector.

connection - Amazon RDS Client connection instance.

dbSnapshotIdentifier - The DBSnapshot identifier.

Returns:

DBSnapshot

modifyDbSnapshot

public DBSnapshot modifyDbSnapshot(@Config
                                   RDSConfiguration config,
                                   @Connection
                                   RDSConnection connection,
                                   @DisplayName(value="DB Snapshot Identifier")
                                   String dbSnapshotIdentifier,
                                   @DisplayName(value="Engine Version") @Optional
                                   String engineVersion)

Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version. You can update the engine version to either a new major or minor engine version.

API Reference

Parameters:

config - Configuration for RDS connector.

connection - Amazon RDS Client connection instance.

dbSnapshotIdentifier - The identifier of the DB snapshot to modify.

engineVersion - The engine version to update the DB snapshot to.

Returns:

DBSnapshot

describeDbSnapshots

public org.mule.runtime.extension.api.runtime.streaming.PagingProvider<RDSConnection,org.mule.runtime.extension.api.runtime.operation.Result<DBSnapshot,RequestIDAttribute>> describeDbSnapshots(@DisplayName(value="DB Instance Identifier") @Optional
                                                                                                                                                                                                 String dbInstanceIdentifier,
                                                                                                                                                                                                 @DisplayName(value="DB Snapshot Identifier") @Optional
                                                                                                                                                                                                 String dbSnapshotIdentifier,
                                                                                                                                                                                                 @DisplayName(value="Include Public") @Optional(defaultValue="false")
                                                                                                                                                                                                 boolean includePublic,
                                                                                                                                                                                                 @DisplayName(value="Include Shared") @Optional(defaultValue="false")
                                                                                                                                                                                                 boolean includeShared,
                                                                                                                                                                                                 @DisplayName(value="Snapshot Type") @Optional
                                                                                                                                                                                                 String snapshotType,
                                                                                                                                                                                                 @DisplayName(value="Max Records") @Optional
                                                                                                                                                                                                 Integer maxRecords,
                                                                                                                                                                                                 @Optional
                                                                                                                                                                                                 Collection<Filter> filters)

Returns information about DB snapshots. This API action supports pagination.

API Reference

Parameters:

dbInstanceIdentifier - The ID of the DB instance to retrieve the list of DB snapshots for.

dbSnapshotIdentifier - A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier.

includePublic - Set this value to true to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false.

includeShared - Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false.

snapshotType - The type of snapshots to be returned.

maxRecords - The maximum number of records to include in the response.

filters - This parameter is not currently supported.

Returns:

DescribeDBSnapshotsResult