Menu
Oracle Database on AWS
Quick Start Reference Deployment Guide

Step 4. Launch the Quick Start

In this section, we’ve provided general instructions for deploying the Quick Start templates in the AWS CloudFormation console.

  1. Choose one of the following options to launch the AWS CloudFormation template into your AWS account. For help choosing an option, see the discussion of deployment scenarios earlier in this guide.

    Scenario 1

    Deploy Oracle Database into a new VPC on AWS

    
                                                    Quick Start launch button for Oracle Database in new VPC

    Scenario 2

    Deploy Oracle Database into an existing VPC

    
                                                    Quick Start launch button for Oracle Database in existing VPC

    Important

    If you’re deploying Oracle Database into an existing VPC, make sure that your VPC has two private subnets in different Availability Zones for the database instances. These subnets require NAT gateways in their route tables, to allow the instances to download packages and software without exposing them to the Internet. You’ll also need the domain name option configured in the DHCP options as explained in the Amazon VPC documentation. You’ll be prompted for your VPC settings when you launch the Quick Start.

    Each deployment takes approximately one hour to complete.

    Note

    You are responsible for the cost of the AWS services used while running this Quick Start reference deployment. There is no additional cost for using this Quick Start. Prices are subject to change. For full details, see the pricing pages for each AWS service you will be using in this Quick Start.

  2. Check the region that’s displayed in the upper-right corner of the navigation bar, and change it if necessary. This is where the network infrastructure for Oracle Database will be built. The template is launched in the US West (Oregon) Region by default. You must choose the same region where you placed the Oracle Database binary files in step 3.

  3. On the Select Template page, keep the default URL for the AWS CloudFormation template, and then choose Next.

  4. On the Specify Details page, change the stack name if needed. Review the parameters for the template. Provide values for the parameters that require input. For all other parameters, review the default settings and customize them as necessary. When you finish reviewing and customizing the parameters, choose Next.

    In the following tables, parameters are listed by category and described separately for the two deployment options:

    Option 1: Parameters for deploying Oracle Database into a new VPC

    View template

    Network Configuration:

    Parameter label Parameter name Default Description
    Availability Zones AvailabilityZones Requires input The list of Availability Zones to use for the subnets in the VPC. The Quick Start uses two Availability Zones from your list and preserves the logical order you specify.
    VPC CIDR VPCCIDR 10.0.0.0/16 CIDR block for the VPC.
    Private Subnet 1 CIDR PrivateSubnet1CIDR 10.0.0.0/19 CIDR block for the private subnet located in Availability Zone 1.
    Private Subnet 2 CIDR PrivateSubnet2CIDR 10.0.32.0/19 CIDR block for the private subnet located in Availability Zone 2.
    Public Subnet 1 CIDR PublicSubnet1CIDR 10.0.128.0/20 CIDR block for the public subnet located in Availability Zone 1.
    Public Subnet 2 CIDR PublicSubnet2CIDR 10.0.144.0/20 CIDR block for the public subnet located in Availability Zone 2.
    Allowed Bastion External Access CIDR RemoteAccessCIDR Requires input CIDR block that’s allowed SSH external access to the bastion hosts. We recommend that you set this value to a trusted CIDR block. For example, you might want to restrict access to your corporate network.

    Amazon EC2 Configuration:

    Parameter label Parameter name Default Description
    Key Pair Name KeyPairName Requires input Public/private key pair, which allows you to connect securely to your instance after it launches. When you created an AWS account, this is the key pair you created in your preferred region.
    Database Operating System OracleAMIOS Red-Hat-Enterprise-Linux-7.2-HVM Operating system and version for master/worker nodes. Make sure that you’ve subscribed to the AMI for the Linux operating system you choose.
    Database Instance Type OracleInstanceType r3.2xlarge EC2 instance type for the Oracle Database instances.
    Primary Database Private IP PrimaryIPAddress 10.0.0.5 IP address for private subnet 1. This must be the valid address.
    Standby Database Private IP StandbyIPAddress 10.0.32.5 IP address for private subnet 2. This must be the valid address.

    Oracle Database Configuration:

    Parameter label Parameter name Default Description
    Oracle Version OracleVersion 12.1.0.2 Version of the Oracle Database software. You can choose 12.2.0.1 or 12.1.0.2.
    Domain Name DomainName dataguard-env The name of the domain for reaching your database endpoint after setup.
    Database Port Number DatabasePort 1525 Port number for the Oracle Database listener.
    Primary Database Name DatabaseName orcl The name of your primary database. Use 3-8 characters (limited by DB_NAME). The primary instance will also be assigned this name.
    Data Guard Configuration DataGuardConfig Data Guard Set to Single for a single database instance. Keep the default setting of Data Guard for two instances (primary and standby).
    Character Set CharacterSet AL32UTF8 Character set for Oracle Database.
    Standby Database Name StandbyName orclsb The name of your standby database (3-12 characters).
    Database Password DatabasePass Requires input Password for accessing Oracle Database. This is a 3-30 character string and may include lowercase letters, uppercase letters, numbers, pound sign (#), underscore (_), and dollar sign ($). This password is used for the SYS, SYSTEM, and DBSNMP users of Oracle Database.
    ASM Password AsmPass Requires input Password for accessing Oracle Automatic Storage Management (ASM). This is a 3-30 character string and may include lowercase letters, uppercase letters, numbers, pound sign (#), underscore (_), and dollar sign ($). This password is used for the SYSASM, ASM Monitor, and ASM EM admin users of Oracle ASM.
    Data Diskgroup GiB/Disk EBSData 20 Gigabytes for each ASM disk (Amazon EBS) for the DATA disk group. A total of 6 volumes, with a maximum of 16,000 GiB each, is allowed. For more information, see Storage Management earlier in this guide.
    Data Diskgroup Volume Type DataVolumeType gp2 Volume type for the Amazon EBS DATA disk group. The two options are gp2 (performance ratio of 3 IOPS : 1 GiB) or io1 (performance ratio up to 50 IOPS : 1 GiB).
    Data – IOPS per EBS Volume DataIOPS 600 IOPS for EBS volumes for io1 volume types. The total IOPS for the DATA disk group will be this value x 6. A maximum of 20,000 IOPS is allowed per volume, and the ratio is limited to 50 IOPS : 1 GiB.
    Recovery (Reco) Diskgroup GiB/Disk EBSReco 6 Gigabytes for each ASM disk (Amazon EBS) for the RECO disk group. A total of 3 volumes, with a maximum of 16,000 GiB each, is allowed. For more information, see Storage Management earlier in this guide.
    Reco Diskgroup Volume Type RecoVolumeType gp2 Volume type for the Amazon EBS RECO disk group. The two options are gp2 (performance ratio of 3 IOPS : 1 GiB) or io1 (performance ratio up to 50 IOPS : 1 GiB).
    Reco – IOPS per EBS Volume RecoIOPS 200 IOPS for EBS volumes for io1 volume types. The total IOPS for the RECO disk group will be this value x 3. A maximum of 20,000 IOPS is allowed per volume, and the ratio is limited to 50 IOPS : 1 GiB.
    Binaries Bucket Name InstallBucketName Requires input The name of the S3 bucket with your Oracle binaries from step 3 in the format bucket-name/key/prefix.

    Oracle Secure Backup Cloud Module (Optional):

    Parameter label Parameter name Default Description
    Install Oracle Secure Backup OSBInstall false Set to true to install Oracle Secure Backup (OSB) Cloud Module. For more information, see Backup Options earlier in this guide. If this parameter is true, all fields in this parameter group are mandatory.
    OTN Account Email/Login OSBOTN Optional Your Oracle Technology Network (OTN) account login. For more information, see the OTN website.
    OTN Account Password OSBPass Optional Your Oracle Technology Network (OTN) password.
    S3 Bucket for Backups OSBBucketName Optional Name of your S3 bucket for storing Oracle Database backups.
    AWS Access Key ID OSBKey Optional The AWS access key for accessing your backup bucket. For more information, see the AWS documentation.
    AWS Secret Access Key OSBSecret Optional The AWS secret key for accessing your backup bucket. For more information, see the AWS documentation.

    Linux Bastion Configuration:

    Parameter label Parameter name Default Description
    Bastion AMI Operating System BastionAMIOS Amazon-Linux-HVM The Linux distribution for the AMI to be used for the bastion host instances. If you choose CentOS, make sure that you have a subscription to the CentOS AMI in AWS Marketplace.
    Bastion Instance Type BastionInstanceType t2.micro EC2 instance type for the bastion host instance.
    Enable Banner EnableBanner true Includes or suppresses the banner that is displayed when you connect to the bastion host via SSH. To disable the banner, set this parameter to false.
    Bastion Banner BastionBanner Default URL URL for the ASCII text file that contains the banner text to display upon login. (See section on customizing the banner in the Quick Start for Linux bastion hosts.)

    AWS Quick Start Configuration:

    Parameter label Parameter name Default Description
    Quick Start S3 Bucket Name QSS3BucketName quickstart-reference S3 bucket where the Quick Start templates and scripts are installed. Use this parameter to specify the S3 bucket name you’ve created for your copy of Quick Start assets, if you decide to customize or extend the Quick Start for your own use. The bucket name can include numbers, lowercase letters, uppercase letters, and hyphens (-), but should not start or end with a hyphen.
    Quick Start S3 Key Prefix QSS3KeyPrefix oracle/database/latest/ The S3 key name prefix used to simulate a folder for your copy of Quick Start assets, if you decide to customize or extend the Quick Start for your own use. This prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/).

    Option 2: Parameters for deploying Oracle Database into an existing VPC

    View the template for existing VPC

    Network Configuration:

    Parameter label Parameter name Default Description
    VPC ID VPCID Requires input ID of your existing VPC (e.g., vpc-0343606e).
    Private Subnet 1 ID PrivateSubnet1ID Requires input ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
    Private Subnet 2 ID PrivateSubnet2ID Requires input ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
    Bastion Security Group ID BastionSecurityGroupID Requires input ID of the bastion security group in your existing VPC (e.g., sg-7f16e910).

    Amazon EC2 Configuration:

    Parameter label Parameter name Default Description
    Key Pair Name KeyPairName Requires input Public/private key pair, which allows you to connect securely to your instance after it launches. When you created an AWS account, this is the key pair you created in your preferred region.
    Database Operating System OracleAMIOS Red-Hat-Enterprise-Linux-7.2-HVM Operating system and version for master/worker nodes. Make sure that you’ve subscribed to the AMI for the Linux operating system you choose.
    Database Instance Type OracleInstanceType r3.2xlarge EC2 instance type for the Oracle Database instances.
    Primary Database Private IP PrimaryIPAddress 10.0.0.5 IP address for private subnet 1. This must be the valid address.
    Standby Database Private IP StandbyIPAddress 10.0.32.5 IP address for private subnet 2. This must be the valid address.

    Oracle Database Configuration:

    Parameter label Parameter name Default Description
    Oracle Version OracleVersion 12.1.0.2 Version of the Oracle Database software. You can choose 12.2.0.1 or 12.1.0.2.
    Domain Name DomainName dataguard-env The name of the domain for reaching your database endpoint after setup.
    Database Port Number DatabasePort 1525 Port number for the Oracle Database listener.
    Primary Database Name DatabaseName orcl The name of your primary database. Use 3-8 characters (limited by DB_NAME). The primary instance will also be assigned this name.
    Data Guard Configuration DataGuardConfig Data Guard Set to Single for a single database instance. Keep the default setting of Data Guard for two instances (primary and standby).
    Character Set CharacterSet AL32UTF8 Character set for Oracle Database.
    Standby Database Name StandbyName orclsb The name of your standby database (3-12 characters).
    Database Password DatabasePass Requires input Password for accessing Oracle Database. This is a 3-30 character string and may include lowercase letters, uppercase letters, numbers, pound sign (#), underscore (_), and dollar sign ($). This password is used for the SYS, SYSTEM, and DBSNMP users of Oracle Database.
    ASM Password AsmPass Requires input Password for accessing Oracle Automatic Storage Management (ASM). This is a 3-30 character string and may include lowercase letters, uppercase letters, numbers, pound sign (#), underscore (_), and dollar sign ($). This password is used for the SYSASM, ASM Monitor, and ASM EM admin users of Oracle ASM.
    Data Diskgroup GiB/Disk EBSData 20 Gigabytes for each ASM disk (Amazon EBS) for the DATA disk group. A total of 6 volumes, with a maximum of 16,000 GiB each, is allowed. For more information, see Storage Management earlier in this guide.
    Data Diskgroup Volume Type DataVolumeType gp2 Volume type for the Amazon EBS DATA disk group. The two options are gp2 (performance ratio of 3 IOPS : 1 GiB) or io1 (performance ratio up to 50 IOPS : 1 GiB).
    Data – IOPS per EBS Volume DataIOPS 600 IOPS for EBS volumes for io1 volume types. The total IOPS for the DATA disk group will be this value x 6. A maximum of 20,000 IOPS is allowed per volume, and the ratio is limited to 50 IOPS : 1 GiB.
    Recovery (Reco) Diskgroup GiB/Disk EBSReco 6 Gigabytes for each ASM disk (Amazon EBS) for the RECO disk group. A total of 3 volumes, with a maximum of 16,000 GiB each, is allowed. For more information, see Storage Management earlier in this guide.
    Reco Diskgroup Volume Type RecoVolumeType gp2 Volume type for the Amazon EBS RECO disk group. The two options are gp2 (performance ratio of 3 IOPS : 1 GiB) or io1 (performance ratio up to 50 IOPS : 1 GiB).
    Reco – IOPS per EBS Volume RecoIOPS 200 IOPS for EBS volumes for io1 volume types. The total IOPS for the RECO disk group will be this value x 3. A maximum of 20,000 IOPS is allowed per volume, and the ratio is limited to 50 IOPS : 1 GiB.
    Binaries Bucket Name InstallBucketName Requires input The name of the S3 bucket with your Oracle binaries from step 3 in the format bucket-name/key/prefix.

    Oracle Secure Backup Cloud Module (Optional):

    Parameter label Parameter name Default Description
    Install Oracle Secure Backup OSBInstall false Set to true to install Oracle Secure Backup (OSB) Cloud Module. For more information, see Backup Options earlier in this guide. If this parameter is true, all fields in this parameter group are mandatory.
    OTN Account Email/Login OSBOTN Optional Your Oracle Technology Network (OTN) account login. For more information, see the OTN website.
    OTN Account Password OSBPass Optional Your Oracle Technology Network (OTN) password.
    S3 Bucket for Backups OSBBucketName Optional Name of your S3 bucket for storing Oracle Database backups.
    AWS Access Key ID OSBKey Optional The AWS access key for accessing your backup bucket. For more information, see the AWS documentation.
    AWS Secret Access Key OSBSecret Optional The AWS secret key for accessing your backup bucket. For more information, see the AWS documentation.

    AWS Quick Start Configuration:

    Parameter label Parameter name Default Description
    Quick Start S3 Bucket Name QSS3BucketName quickstart-reference S3 bucket where the Quick Start templates and scripts are installed. Use this parameter to specify the S3 bucket name you’ve created for your copy of Quick Start assets, if you decide to customize or extend the Quick Start for your own use. The bucket name can include numbers, lowercase letters, uppercase letters, and hyphens (-), but should not start or end with a hyphen.
    Quick Start S3 Key Prefix QSS3KeyPrefix oracle/database/latest/ The S3 key name prefix used to simulate a folder for your copy of Quick Start assets, if you decide to customize or extend the Quick Start for your own use. This prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/).
  5. On the Options page, you can specify tags (key-value pairs) for resources in your stack and set additional options. When you're done, choose Next.

  6. On the Review page, review and confirm the template settings. Under Capabilities, select the checkbox to acknowledge that the template will create IAM resources.

  7. Choose Create to deploy the stack.

  8. Monitor the status of the stack. When the status is CREATE_COMPLETE, the Oracle Database cluster is ready.

Outputs

You can use the information displayed in the AWS CloudFormation Outputs tab to access and maintain your instances.

Files and Directories

Installation files are downloaded from your S3 bucket to the /u01/install directory. Logs and some temporary configuration files are created in /tmp. Files exchanged between the primary database instance and the standby database instance are placed in an NFS /shared file system. Oracle home directories are in:

  • /u01/app/oracle/product/12.c/db_1 for Oracle Database

  • /u01/app/oracle/product/12.c/grid for Oracle Grid Infrastructure