config_aws | Teradata DSA Commands - 17.20 - config_aws - BAR - Data Stream Architecture

Teradata® DSA User Guide

Product
BAR
Data Stream Architecture
Release Number
17.20
Release Date
October 2021
Content Type
User Guide
Publication ID
B035-3150-101K
Language
English (United States)

Purpose

The config_aws command configures the Amazon S3 Server in the DSA repository based on parameter files.

Syntax

config_aws -f|-file filename

Example

config_aws -f file1.xml

Parameters

f|file filename
The full path and name of the file containing the necessary configuration parameters.
u|user_authentication User
Required when security management is enabled. Supplies the command with the Viewpoint user, and triggers a password prompt for authentication.

Permissions required: Administrator role

Usage Notes

role_name is required. This is the IAM role (see http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html). When roles are used, all DSA components must be running in the AWS cloud and assigned to this role.

You will need to enter an AWS account ID (access id) and IAM user access key for the Amazon S3 application. See http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey.

dsc config_aws -f aws.xml

Data Stream Controller Command Line 17.00.00.00
Command parameters:
-file : aws.xml
Enter access id for account "acctName".

AKIAJYGWLNCJDDZ35AXQ

Enter access key for account "acctName".

*******

Connected to DSC version 17.00.00.00
Saving AWS Backup Application configuration...

XML File Example

A representative XML file is shown below. Note the following:
<?xml version="1.0" encoding="UTF-8"?>

             <!--****The command below must be on one line.****-->
<dscConfigAmzS3 dscVersion="" xmlns="http://schemas.teradata.com/v2012/DSC"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://schemas.teradata.com/v2012/DSC DSC.xsd">

<config_aws_list>
 <!-- character must be alphanumeric, - Required, max characters 32 -->
 <account_name>acctName</account_name>

 <!-- character must be alphanueric, - Required, max characters 64 -->
 <role_name>roleName</role_name>

 <!-- must be region enum -->
 <buckets_by_region>
    <!-- valid regions: us-east-1, us-west-1, us-west-2, eu-west-1,eu-central-1, 
      ap-southeast-1, ap-southeast-2,ap-northeast-1, ap-northeast-2, sa-east-1 -->
     <region>us-east-1</region>
   
       <buckets>
        <!-- character must be alphanumeric, - Required, max characters 512 -->
         <bucket_name>bucketName</bucket_name>

         <prefix_list>
            <!-- character must be alphanumeric, - Required, max characters 256 -->
             <prefix_name>prefix</prefix_name>

            <!-- Required, Integer, min value is 1, max value is 999 --> 
          <storage_devices>1</storage_devices>
         </prefix_list>
       </buckets>
    </buckets_by_region>
    </config_aws_list>
</dscConfigAmzS3>