Configuring a DB instance for Amazon RDS Custom for Oracle

To create an RDS Custom for Oracle DB instance

1. Sign in to the Amazon Web Services Management Console and open the Amazon RDS console at https://console.amazonaws.cn/rds/.

2. In the navigation pane, choose Databases.

3. Choose Create database.

4. In Choose a database creation method, select Standard create.

5. In the Engine options section, do the following:

   1. For Engine type, choose Oracle.

   2. For Database management type, choose Amazon RDS Custom.

   3. For Architecture settings, do one of the following:

      • Select Multitenant architecture to create a container database (CDB). At creation, your CDB contains one PDB seed and one initial PDB.

        Note

        The Multitenant architecture setting is supported only for Oracle Database 19c.

      • Clear Multitenant architecture to create a non-CDB. A non-CDB can't contain PDBs.

   4. For Edition, choose Oracle Enterprise Edition or Oracle Standard Edition 2.

   5. For Custom engine version, choose an existing RDS Custom custom engine version (CEV). A CEV has the following format: major-engine-version.customized_string. An example identifier is 19.cdb_cev1.

      If you chose Multitenant architecture in the previous step, you can only specify a CEV that uses the custom-oracle-ee-cdb or custom-oracle-se2-cdb engine type. The console filters out CEVs that were created with different engine types.

6. In Templates, choose Production.

7. In the Settings section, do the following:

   1. For DB instance identifier, enter a unique name for your DB instance.

   2. For Master username, enter a username. You can retrieve this value from the console later.

      When you connect to a non-CDB, the master user is the user for the non-CDB. When you connect to a CDB, the master user is the user for the PDB. To connect to the CDB root, log in to the host, start a SQL client, and create an administrative user with SQL commands.

   3. Clear Auto generate a password.

8. Choose a DB instance class.

   For supported classes, see DB instance class support for RDS Custom for Oracle.

9. In the Storage section, do the following:

   1. For Storage type, choose an SSD type: io1, gp2, or gp3. You have the following additional options:

      • For io1 or gp3, choose a rate for Provisioned IOPS. The default is 1000 for io1 and 12000 for gp3.

      • For gp3, choose a rate for Storage throughput. The default is 500 MiBps.

   2. For Allocated storage, choose a storage size. The default is 40 GiB.

10. For Connectivity, specify your Virtual private cloud (VPC), DB subnet group, and VPC security group (firewall).

11. For RDS Custom security, do the following:

    1. For IAM instance profile, choose the instance profile for your RDS Custom for Oracle DB instance.

       The IAM instance profile must begin with AWSRDSCustom, for example AWSRDSCustomInstanceProfileForRdsCustomInstance.

    2. For Encryption, choose Enter a key ARN to list the available Amazon KMS keys. Then choose your key from the list.

       An Amazon KMS key is required for RDS Custom. For more information, see Step 1: Create or reuse a symmetric encryption Amazon KMS key.

12. For Database options, do the following:

    1. (Optional) For System ID (SID), enter a value for the Oracle SID, which is also the name of your CDB. The SID is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB.

    2. (Optional) For Initial database name, enter a name. The default value is ORCL. In the multitenant architecture, the initial database name is the PDB name.

       Note

       The SID and PDB name must be different.

    3. For Option group, choose an option group or accept the default.

       Note

       The only supported option for RDS Custom for Oracle is Timezone. For more information, see Oracle time zone.

    4. For Backup retention period choose a value. You can't choose 0 days.

    5. For the remaining sections, specify your preferred RDS Custom DB instance settings. For information about each setting, see Settings for DB instances. The following settings don't appear in the console and aren't supported:

       • Processor features

       • Storage autoscaling

       • Password and Kerberos authentication option in Database authentication (only Password authentication is supported)

       • Performance Insights

       • Log exports

       • Enable auto minor version upgrade

       • Deletion protection

13. Choose Create database.

    Important

    When you create an RDS Custom for Oracle DB instance, you might receive the following error: The service-linked role is in the process of being created. Try again later. If you do, wait a few minutes and then try again to create the DB instance.

    The View credential details button appears on the Databases page.

    To view the master user name and password for the RDS Custom DB instance, choose View credential details.

    To connect to the DB instance as the master user, use the user name and password that appear.

    Important

    You can't view the master user password again in the console. If you don't record it, you might have to change it. To change the master user password after the RDS Custom DB instance is available, log in to the database and run an ALTER USER command. You can't reset the password using the Modify option in the console.

14. Choose Databases to view the list of RDS Custom DB instances.

15. Choose the RDS Custom DB instance that you just created.

    On the RDS console, the details for the new RDS Custom DB instance appear:

    • The DB instance has a status of creating until the RDS Custom DB instance is created and ready for use. When the state changes to available, you can connect to the DB instance. Depending on the instance class and storage allocated, it can take several minutes for the new DB instance to be available.

    • Role has the value Instance (RDS Custom).

    • RDS Custom automation mode has the value Full automation. This setting means that the DB instance provides automatic monitoring and instance recovery.

To connect to your DB instance using Session Manager

1. Sign in to the Amazon Web Services Management Console and open the Amazon RDS console at https://console.amazonaws.cn/rds/.

2. In the navigation pane, choose Databases, and then choose the RDS Custom DB instance to which you want to connect.

3. Choose Configuration.

4. Note the Resource ID for your DB instance. For example, the resource ID might be db-ABCDEFGHIJKLMNOPQRS0123456.

5. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/.

6. In the navigation pane, choose Instances.

7. Look for the name of your EC2 instance, and then click the instance ID associated with it. For example, the instance ID might be i-abcdefghijklm01234.

8. Choose Connect.

9. Choose Session Manager.

10. Choose Connect.

    A window opens for your session.

To retrieve the secret SSH key

1. Sign in to the Amazon Web Services Management Console and open the Amazon RDS console at https://console.amazonaws.cn/rds/.

2. In the navigation pane, choose Databases, and then choose the RDS Custom DB instance to which you want to connect.

3. Choose Configuration.

4. Note the Resource ID value. For example, the DB instance resource ID might be db-ABCDEFGHIJKLMNOPQRS0123456.

5. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/.

6. In the navigation pane, choose Instances.

7. Find the name of your EC2 instance, and choose the instance ID associated with it. For example, the EC2 instance ID might be i-abcdefghijklm01234.

8. In Details, find Key pair name. The pair name includes the DB instance resource ID. For example, the pair name might be do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c.

9. If your EC2 instance is public, note the Public IPv4 DNS. For the example, the public Domain Name System (DNS) address might be ec2-12-345-678-901.us-east-2.compute.amazonaws.com.

10. Open the Amazon Secrets Manager console at https://console.aws.amazon.com/secretsmanager/.

11. Choose the secret that has the same name as your key pair.

12. Choose Retrieve secret value.

13. Copy the SSH private key into a text file, and then save the file with the .pem extension. For example, save the file as /tmp/do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c.pem.

1. Find the DB resource ID of your RDS Custom DB instance using aws rds describe-db-instances.

   aws rds describe-db-instances \
       --query 'DBInstances[*].[DBInstanceIdentifier,DbiResourceId]' \
       --output text

   The following sample output shows the resource ID for your RDS Custom instance. The prefix is db-.

   db-ABCDEFGHIJKLMNOPQRS0123456

2. Find the EC2 instance ID of your DB instance using aws ec2 describe-instances. The following example uses db-ABCDEFGHIJKLMNOPQRS0123456 for the resource ID.

   aws ec2 describe-instances \
       --filters "Name=tag:Name,Values=db-ABCDEFGHIJKLMNOPQRS0123456" \
       --output text \
       --query 'Reservations[*].Instances[*].InstanceId'

   The following sample output shows the EC2 instance ID.

   i-abcdefghijklm01234

3. To find the key name, specify the EC2 instance ID. The following example describes EC2 instance i-0bdc4219e66944afa.

   aws ec2 describe-instances \
       --instance-ids i-0bdc4219e66944afa \
       --output text \
       --query 'Reservations[*].Instances[*].KeyName'

   The following sample output shows the key name, which uses the prefix do-not-delete-rds-custom-ssh-privatekey-.

   do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c

4. Save the private key in a .pem file named after the key using aws secretsmanager. The following example saves the file in your /tmp directory.

   aws secretsmanager get-secret-value \
       --secret-id do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c \
       --query SecretString \
       --output text >/tmp/do-not-delete-rds-custom-ssh-privatekey-db-ABCDEFGHIJKLMNOPQRS0123456-0d726c.pem

To find the SYS password for your database in Secrets Manager

1. Sign in to the Amazon Web Services Management Console and open the Amazon RDS console at https://console.amazonaws.cn/rds/.

2. In the RDS console, complete the following steps:

   1. In the navigation pane, choose Databases.

   2. Choose the name of your RDS Custom for Oracle DB instance.

   3. Choose Configuration.

   4. Copy the value underneath Resource ID. For example, you resource ID might be db-ABC12CDE3FGH4I5JKLMNO6PQR7.

3. Open the Secrets Manager console at https://console.aws.amazon.com/secretsmanager/.

4. In the Secrets Manager console, complete the following steps:

   1. In the left navigation pane, choose Secrets.

   2. Filter the secrets by the resource ID that you copied in step 5.

   3. Choose the secret named do-not-delete-rds-custom-resource_id-uuid, where resource_id is the resource ID that you copied in step 5. For example, if your resource ID is db-ABC12CDE3FGH4I5JKLMNO6PQR7, your secret will be named do-not-delete-rds-custom-db-ABC12CDE3FGH4I5JKLMNO6PQR7.

   4. In Secret value, choose Retrieve secret value.

   5. In Key/value, copy the value for password.

5. Install SQL*Plus on your DB instance and log in to your database as SYS. For more information, see Step 3: Connect your SQL client to an Oracle DB instance.