RDS

Bases: DuploTenantResourceV3

Resource for managing RDS instances.

`apply`

Apply a RDS

Create or Update a RDS resource with Duplocloud cli.

CLI Usage

duploctl rds apply -f 'rds.yaml'

Contents of the rds.yaml file

Identifier: mydb01
MasterUsername: fuzlletonnian
MasterPassword: superstrongpassword
Engine: 0
EngineVersion: 8.0.36
AllocatedStorage: 30
Cloud: 0
StorageType: gp3
SizeEx: db.t3.small

Parameters:

Name	Type	Description	Default
`body`	`BODY`	The resource to apply.	required
`wait`	`WAIT`	Wait for the resource to be created.	`False`
`patches`	`PATCHES`	The patches to apply to the resource.	`None`

Returns:

Name	Type	Description
`message`	`dict`	Success message.

`change_password`

Change the password of a DB instance.

Parameters:

Name	Type	Description	Default
`name`	`str`	The name of the DB instance to update.	required
`password`	`str`	The new password to use for the DB instance.	required

`create`

Create a DB instance.

Parameters:

Name	Type	Description	Default
`body`	`dict`	The body of the request.	required

`delete`

Delete a RDS resource by name.

cli usage

duploctl rds delete <name>

Parameters:

Name	Type	Description	Default
`name`	`NAME`	The name of the RDS resource to delete.	required

Returns:

Name	Type	Description
`message`	`dict`	A success message.

Raises:

Type	Description
`DuploError`	If the {{kind}} resource could not be found or deleted.

`final_snapshot`

Toggle IAM authentication for a DB instance.

`find`

Find RDS resources by name.

cli usage

duploctl rds find <name>

Parameters:

Name	Type	Description	Default
`name`	`NAME`	The name of the RDS resource to find.	required

Returns:

Name	Type	Description
`resource`	`dict`	The RDS object.

Raises:

Type	Description
`DuploError`	If the {{kind}} could not be found.

`find_cluster`

Find a DB instance by name.

Parameters:

Name	Type	Description	Default
`name`	`str`	The name of the DB instance to find.	required

Returns: The DB instance object. Raises: DuploError: If the DB instance could not be found.

`iam_auth`

Toggle IAM authentication for a DB instance.

`list`

Retrieve a List of RDS resources

cli usage

duploctl rds list

Returns:

Name	Type	Description
`list`	`list`	A list of RDS.

`logging`

Enable or disable logging for a DB instance.

`reboot`

Reboot a DB instance.

`restore`

Restore a DB instance from a snapshot.

`retention_period`

Set the retention period for a DB instance.

`set_instance_size`

Set the size of a DB instance.

Parameters:

Name	Type	Description	Default
`name`	`str`	The name of the DB instance to update.	required
`size`	`str`	The new size to use for the DB instance.	required

`set_monitor_interval`

Set the monitoring interval for a DB instance.

Parameters:

Name	Type	Description	Default
`name`	`str`	The name of the DB instance to update.	required
`interval`	`str`	The new monitoring interval to use for the DB instance.	required

`snapshot`

Take a snapshot of a DB instance.

`start`

Start a DB instance.

`stop`

Stop a DB instance.

`update`

Update a V3 resource by name.

Parameters:

Name	Type	Description	Default
`name`	`NAME`	The name of the resource to update.	`None`
`body`	`BODY`	The resource to update.	`None`
`patches`	`PATCHES`	The patches to apply to the resource.	`None`

Returns:

Name	Type	Description
`message`		Success message.

Raises:

Type	Description
`DuploError`	If the resource could not be created.