AWS Access Credentials CLI Configuration

You can add an AWS Access Credentials target application and connector using the CLI. This topic contains the parameters for target applications and target accounts:
capam32
You can add an AWS Access Credentials target application and connector using the CLI. This topic contains the parameters for target applications and target accounts:

AWS Access Credentials Target Application CLI Parameters

To add a target application that uses the AWS Access credentials, use the addTargetApplication command and the following parameters:
TargetApplication.type
The target application connector type.
Required
Default Value
Valid Values
yes
N/A
AwsAccessCredentials
Attribute.extensionType
Required
Default Value
Valid Values
yes
N/A
AwsAccessCredentials

AWS Access Credentials Target Account CLI Parameters

To add a target account that uses the AWS Access Credentials, use the addTargetAccount command and the following command parameters:
Attribute.awsCredentialType
The AWS access credential type.
Required
Default Value
Valid Values
yes
EC2_PRIVATE_KEY
  • SECRET_ACCESS_KEY
  • EC2_PRIVATE_KEY
X509_CERT_PRIVATE_KEY and CLOUDFRONT_PRIVATE_KEY are not supported.
Attribute.passphrase
The EC2 key passphrase.
Required
Default Value
Valid Values
no
N/A
A string consisting of alphanumeric characters (a-z, A-Z, 0-9)
Attribute.awsKeyPairName
The EC2 key pair name.
Required
Default Value
Valid Values
Yes when credential type is
EC2_PRIVATE_KEY
N/A
A string consisting of any character except @
Attribute.accountFriendlyName
NOTE: This attribute is deprecated
.
See Attribute.awsAccessKeyAlias.
The access key user-friendly name.
Required
Default Value
Valid Values
Yes when credential type is
SECRET_ACCESS_KEY
N/A
A user-friendly account name string
Attribute.awsAccessKeyAlias
The access key user-friendly name.
Required
Default Value
Valid Values
Yes when credential type is
SECRET_ACCESS_KEY
N/A
A user-friendly account name string
Attribute.awsAccessRole
The user defined AWS access role.
Optional
Default Value
Valid Values
When credential type is
SECRET_ACCESS_KEY
N/A
A string of up to 64 alphanumeric characters. The string can also include '+=,.@-'
Attribute.awsCloudType
The AWS cloud environment type.
Required
Default Value
Valid Values
yes when credential type is
SECRET_ACCESS_KEY
commercial
  • commercial
  • government

AWS Access Credentials CLI Example

cmdName=addTargetApplication TargetServer.hostName=myhostname.mydomain.com
TargetApplication.name=My_AWS_Access_Credentials TargetApplication.type=AwsAccessCredentials
Attribute.extensionType=AwsAccessCredentials cmdName=addTargetAccount
TargetServer.hostName=myhostname.mydomain.com TargetApplication.name=My_AWS_Access_Credentials
TargetAccount.userName=admin TargetAccount.password=ASJKNSKKA9FJJSFS
Attribute.extensionType=AwsAccessCredentials Attribute.awsMasterAccount=1001
Attribute.awsCredentialType=SECRET_ACCESS_KEY Attribute.accountFriendlyName=xceediumAWS
Attribute.awsAccessRole=Admin Attribute.awsCloudType=commercial