Appearance
aws.rds.restore_db_instance_from_db_snapshot ​
Call AWS RDS RestoreDBInstanceFromDBSnapshot using a CloudConnection UUID.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | Base-aws |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Authenticated organization UUID used for field resolution and connection scoping. |
connection_uuid | uuid | Yes | — | AWS CloudConnection UUID for the target RDS account, scoped to the caller organization. |
workflow_run_id | string | No | — | Engine DAG run ID stamped onto child steps. |
region | string | No | — | AWS API endpoint region override; omit to use the connection or SDK default. |
db_instance_identifier | string | Yes | — | The name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 numbers, letters, or hyphens. First character must be a lette... |
db_snapshot_identifier | string | No | — | The identifier for the DB snapshot to restore from. Constraints: Must match the identifier of an existing DB snapshot. Can't be specified when DBClusterSnapshotIdentifier is specified. Must be spec... |
db_instance_class | string | No | — | The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. Fo... |
port | integer | No | — | The port number on which the database accepts connections. Default: The same port as the original DB instance Constraints: Value must be 1150-65535 |
availability_zone | string | No | — | The Availability Zone (AZ) where the DB instance will be created. Default: A random, system-chosen Availability Zone. Constraint: You can't specify the AvailabilityZone parameter if the DB instance... |
db_subnet_group_name | string | No | — | The name of the DB subnet group to use for the new instance. Constraints: If supplied, must match the name of an existing DB subnet group. Example: mydbsubnetgroup |
multi_az | boolean | No | — | Specifies whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ d... |
publicly_accessible | boolean | No | — | Specifies whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB in... |
auto_minor_version_upgrade | boolean | No | — | Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window. If you restore an RDS Custom DB instance, you must disable this parameter. For more... |
license_model | string | No | — | License model information for the restored DB instance. License models for RDS for Db2 require additional configuration. The bring your own license (BYOL) model requires a custom parameter group an... |
db_name | string | No | — | The name of the database for the restored DB instance. This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS Custom DB i... |
engine | string | No | — | The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you... |
iops | integer | No | — | Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter i... |
storage_throughput | integer | No | — | Specifies the storage throughput value for the DB instance. This setting doesn't apply to RDS Custom or Amazon Aurora. |
option_group_name | string | No | — | The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that opt... |
tags | list | No | — | A list of tags. For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide. |
storage_type | string | No | — | Specifies the storage type to be associated with the DB instance. Valid Values: gp2 |
tde_credential_arn | string | No | — | The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom. |
tde_credential_password | string | No | — | The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom. |
vpc_security_group_ids | list | No | — | A list of EC2 VPC security groups to associate with this DB instance. Default: The default EC2 VPC security group for the DB subnet group's VPC. |
domain | string | No | — | The Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and Po... |
domain_fqdn | string | No | — | The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: Can't be longer than 64 characters. Example: mymanagedADtest.mymanagedAD.mydomain |
domain_ou | string | No | — | The Active Directory organizational unit for your DB instance to join. Constraints: Must be in the distinguished name format. Can't be longer than 64 characters. Example: OU=mymanagedADtestOU,DC=my... |
domain_auth_secret_arn | string | No | — | The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Constraints: Can't be longer than 64 characters. Example: arn:aws:secretsmanager:region:account-number:s... |
domain_dns_ips | list | No | — | The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP... |
copy_tags_to_snapshot | boolean | No | — | Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB sna... |
domain_iam_role_name | string | No | — | The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to RDS Custom DB instances. |
enable_iam_database_authentication | boolean | No | — | Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information about IAM databa... |
enable_cloudwatch_logs_exports | list | No | — | The list of logs for the restored DB instance to export to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch L... |
processor_features | list | No | — | The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom. |
use_default_processor_features | boolean | No | — | Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom. |
db_parameter_group_name | string | No | — | The name of the DB parameter group to associate with this DB instance. If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.... |
deletion_protection | boolean | No | — | Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more infor... |
enable_customer_owned_ip | boolean | No | — | Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your o... |
network_type | string | No | — | The network type of the DB instance. Valid Values: IPV4 DUAL The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or... |
backup_target | string | No | — | Specifies where automated backups and manual snapshots are stored for the restored DB instance. Possible values are local (Dedicated Local Zone), outposts (Amazon Web Services Outposts), and region... |
custom_iam_instance_profile | string | No | — | The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: The profile must exist in your accou... |
allocated_storage | integer | No | — | The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance. This setting isn't valid for RDS for SQL Server. Be sure t... |
db_cluster_snapshot_identifier | string | No | — | The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: Mus... |
backup_retention_period | integer | No | — | The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Enabling and disabling backups c... |
preferred_backup_window | string | No | — | The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an... |
dedicated_log_volume | boolean | No | — | Specifies whether to enable a dedicated log volume (DLV) for the DB instance. |
ca_certificate_identifier | string | No | — | The CA certificate identifier to use for the DB instance's server certificate. This setting doesn't apply to RDS Custom DB instances. For more information, see Using SSL/TLS to encrypt a connection... |
engine_lifecycle_support | string | No | — | The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard... |
additional_storage_volumes | list | No | — | A list of additional storage volumes to create for the DB instance. You can create up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage... |
tag_specifications | list | No | — | Tags to assign to resources associated with the DB instance. Valid Values: auto-backup - The DB instance's automated backup. |
manage_master_user_password | boolean | No | — | Specifies whether to manage the master user password with Amazon Web Services Secrets Manager in the restored DB instance. For more information, see Password management with Amazon Web Services Sec... |
master_user_secret_kms_key_id | string | No | — | The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user pass... |
provider_native_request | json | No | — | Optional provider-native request overrides for AWS parameters not yet promoted to first-class fields. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | Organization UUID echoed from input. |
connection_uuid | uuid | No | — | AWS CloudConnection UUID echoed from input. |
region | string | No | — | AWS API endpoint region used. |
service | string | No | — | AWS boto3 service/client name. |
operation | string | No | — | AWS API operation invoked. |
request_id | string | No | — | AWS request ID when available. |
response | json | No | — | Sanitized provider response object. |
items | list | No | — | Primary response item list when the API returns a collection. |
result_count | integer | No | — | Count of primary response items. |
next_page_token | string | No | — | Pagination token for the next page. |
failure_reason | string | No | — | Human-readable failure reason. |
failed_step | string | No | — | Failed logical step. |
failed_layer | json | No | — | Failed DAG layer if engine supplies one. |
failed_at_state | string | No | — | State where failure occurred. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
failed_at | string | No | — | ISO failure timestamp. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "aws.rds.restore_db_instance_from_db_snapshot",
"initial_data": {
"organization_uuid": "value",
"connection_uuid": "value",
"db_instance_identifier": "value"
}
}