Directory Server Documentation Index
Configuration Reference Home

Amazon Aws External Server

Amazon Aws External Servers are used to provide information needed to connect and interact with components of the Amazon Web Service.

Authentication to AWS may be performed using either an access key or an IAM role. In the case of an access key, both the aws-access-key-id and aws-secret-access-key properties must be provided. In the case of an IAM role, neither of the aws-access-key-id and aws-secret-access-key properties may be provided, and the server must be running in an EC2 instance that is configured with the desired IAM role that has permission to perform the necessary operations.

↓Parent Component
↓Relations to This Component
↓Properties
↓dsconfig Usage

Parent Component

The Amazon Aws External Server component inherits from the External Server

Relations to This Component

The following components have a direct aggregation relation to Amazon Aws External Servers:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ aws-access-key-id
↓ aws-secret-access-key
↓ aws-region-name

Basic Properties

description

Description
A description for this External Server
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

aws-access-key-id

Description
The access key ID that will be used if authentication should use an access key. If this is provided, then an aws-secret-access-key must also be provided. If this is not provided, then no aws-secret-access-key may be configured, and the server must be running in an EC2 instance that is configured with an IAM role with permission to perform the necessary operations.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

aws-secret-access-key

Description
The secret access key that will be used if authentication should use an access key. If this is provided, then an aws-access-key-id must also be provided. If this is not provided, then no aws-access-key-id may be configured, and the server must be running in an EC2 instance that is configured with an IAM role with permission to perform the necessary operations.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

aws-region-name

Description
The name of the AWS region containing the resources that will be accessed.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured External Servers:

dsconfig list-external-servers
     [--property {propertyName}] ...

To view the configuration for an existing External Server:

dsconfig get-external-server-prop
     --server-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing External Server:

dsconfig set-external-server-prop
     --server-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Amazon Aws External Server:

dsconfig create-external-server
     --server-name {name}
     --type amazon-aws
     --set aws-region-name:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing External Server:

dsconfig delete-external-server
     --server-name {name}