10.2.1 Amazon S3

Parent topic: Object Storage

10.2.1.1 About Amazon S3 Connections

An Amazon S3 connection is a named connection definition that stores the authentication and connectivity information required to connect Oracle GoldenGate for Distributed Applications and Analytics (GG DAA) to Amazon S3.

The connection definition includes:

  • AWS Access Key ID
  • AWS Secret Access Key
  • AWS Region
  • Common Settings
  • Proxy Settings (when required)

Each connection is identified by a unique connection alias. During Replicat creation, the selected connection alias supplies the generated connection reference that is used by the Replicat configuration.

In previous releases, Amazon S3 connection information was specified directly in the Replicat properties file. With Connection Config, the connection credential is securely stored in Oracle GoldenGate for Distributed Applications and Analytics, managed separately from the Replicat configuration and can be reused across multiple Replicat processes.

Note:

An Amazon S3 connection stores only the information required to establish the connection. Configure Amazon S3-specific handler properties separately.

Parent topic: Amazon S3

10.2.1.2 Before You Begin

Before creating an Amazon S3 connection, create an AWS IAM user (or obtain temporary IAM credentials) with permissions to access the target Amazon S3 bucket. For instructions on creating and managing AWS access keys, see, AWS IAM User Guide. For Amazon S3 connection configuration, ensure that you have the following:

  • AWS Access Key ID: The access key ID used to authenticate to Amazon S3.
  • AWS Secret Access Key:The secret access key associated with the AWS Access Key ID.
  • AWS Region: The AWS Region where the target Amazon S3 resources are located.
  • Common Settings (Optional): Common connection properties, such as the runtime classpath, if required by the deployment.
  • Network Connectivity:Network connectivity from the Oracle GoldenGate deployment to Amazon S3.
  • Proxy Information (Optional): Proxy configuration details if the deployment accesses Amazon S3 through an HTTP proxy.

Parent topic: Amazon S3

10.2.1.3 Create and Validate an Amazon S3 Connection

Use the Add Connection page to create an Amazon S3 connection.

Procedure

  1. In the navigation menu, select DB Connections.
  2. Click Add Connection.
  3. In Connection Alias, enter a unique name for the connection.
  4. From Technology Type, select Amazon S3.
  5. In the Technology Settings section, provide the Amazon S3 connection information.
    • Access Key ID: Enter the AWS Access Key ID used to authenticate to Amazon S3. The Access Key ID supports 16 to 128 characters.
    • Secret Access Key: Enter the AWS Secret Access Key associated with the Access Key ID. This field is treated as sensitive information and is displayed as a password field.
    • Region:Enter the AWS Region where the target Amazon S3 resources are located.
  6. Configure Common Settings if additional runtime configuration is required.

    Classpath: (Required) Specify the full path to client libraries are required by the replicat type. You can use Dependency Downloader to download client libraries.

  7. (Optional) In the Proxy Settings section, configure proxy information only if the Oracle GoldenGate deployment accesses Amazon S3 through an HTTP proxy.
    • Proxy URL – Specifies the URL or host name of the proxy server used to access Amazon S3.
    • Proxy Port – Specifies the port number of the proxy server.
    • Proxy Username – Specifies the user name for proxy authentication, if required.
    • Proxy Password – Specifies the password for proxy authentication. This field is treated as sensitive information.
    • Truststore – Specifies the Java truststore file that contains the certificate authority (CA) certificates used to validate the proxy server certificate, when required.
    • Truststore Password – Specifies the password associated with the truststore.
    • Keystore – Specifies the Java keystore file containing the client certificate and private key used for client authentication, when required.
    • Keystore Password – Specifies the password associated with the keystore.
    • SSL Key Password – Specifies the password protecting the private key stored in the keystore when it differs from the keystore password.

    Note:

    If your deployment has direct network connectivity to Amazon S3, leave the Proxy Settings blank.
  8. Click Submit to create the connection.
  9. On the DB Connections page, run DB Login to validate the connection. Verify that the connection is successfully validated.

    Note:

    A successful DB Login validates only the saved connection information. It does not validate the Replicat configuration or Amazon S3 handler configuration.
  10. After a successful validation, the connection is displayed in the DB Connections table and is available for selection during Replicat creation.

    Note:

    The generated Connection ID is automatically derived from the technology type and the connection alias. A successful DB Login validates the connection information only. It does not validate the Replicat configuration or Amazon S3 handler configuration.

Parent topic: Amazon S3

10.2.1.4 Use an Amazon S3 Connection in Replicat

After the Amazon S3 connection has been successfully validated, you can associate it with a Replicat.

  1. Start the Create Replicat workflow.
  2. Select Amazon S3 as the target technology.
  3. Select the validated Amazon S3 target alias.
  4. Review the generated connection reference.
  5. Complete the remaining Replicat configuration.
  6. Create the Replicat.

The selected connection alias supplies the generated connection reference in the Replicat configuration.

For example:

gg.handler.<handler>.connectionId=<GENERATED_CONNECTION_ID>
gg.handler.<handler>.connectionAlias=<S3_CONNECTION_ALIAS>

Note:

  • Do not change the connection Id and connection alias.
  • After creating the Replicat, continue with Configure the S3 Event Handler to configure Amazon S3-specific handler properties.

Related Topics

Parent topic: Amazon S3