AWS Asset Manager Configuration Properties
The following table describes the AWS Asset Manager configuration properties. You must provide values for each property listed as mandatory.
Property | Description | Mandatory? |
---|---|---|
Access Key |
This is required by AWS when calls are made programatically. When a user is created in an AWS account, an Access and Security Key will be downloaded at the user creation time. Save these on your system safely. |
Yes |
Admin User |
The user to connect to the launched VM. (Such as ec2-user for Ubuntu, centOS for CentOS, and so on.) This property is mandatory if the user has provided standard AMI and selected AWS Standard Image. The user can be obtained from AMI information. | Yes when Standard Image is selected. |
Asset Manager Id |
UUID for identifying the Asset Manager. This must be unique. If more than one Asset Managers is configured on the Broker, make sure that UUID is not repeated for them. |
Yes |
Assign Public Ip |
If selected, a public IP is assigned to the launched instances. |
No |
Assign Secondary Private Ips |
If selected, assigns secondary private IP addresses to the specified network interface. Secondary private IPs are assigned only for instances having more than one core. This is available only in EC2-VPC. For non-VPC network, this property will not be used. |
No |
Availability Zone |
There are different zones defined for each region. Make sure that Engine AMI is available in the respective region of that zone to create the instances. Also it should be same as the given network interface (VPC/subnet) zone. |
Yes |
Aws Standard Image |
Select this if the given AMI is a standard AMI and Engine provisioning needs to be done through the Asset Manager. Unselect if the given AMI is a customized AMI where the Engine is already installed. |
No |
Aws Tags |
The tags for the instances. These are represented as key pairs separated by comma, such as Name:ServerTag, Hosts: Test data Restored. |
No |
Broker Options |
Broker options in the form of -s host:port where the EC2 Engine instances should be configured. |
Yes |
Data Nfs Mount |
The mount location used for shared data between components. |
No |
Data Nfs Options |
The location to be exported for mounting for shared data between components. |
No |
Default Engine Ami |
Engine AMI ID. |
Yes |
Default Instance Type |
Different instance types are defined based on the CPUs and memory. Select the Instance type according to the requirement. |
Yes |
Device Name |
Root Device Name of an AMI for which volume size needs to upgraded. |
Yes when Volume Size is provided. |
Ec2 Url |
Endpoints should be configured when the client is created and before any service requests are made. For example: ec2.us-east-1.amazonaws.com. EC2 endpoints for different regions can be found at http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region |
Yes |
Engine Idle Age |
The amount of time an Engine residing on a Broker can be idle before its host engine is considered free. Default value is 900000 milliseconds. |
No |
Engine Startup Timeout |
The amount of time to wait for Engines to start. This value should be long enough to allow for Engine cloning, Engine OS startup, as well as Engine startup and login. The default value is 300000 milliseconds. This has to be considerably higher for a standard image as Engine provisioning takes place at runtime. |
No |
Initial Number of Engines to Provision |
Number of AWS instances to be launched and provisioned on enabling the respective Asset Manager. These instances will be launched with Engine property "Group=initial". Static Pools will have the default value as "initial" so that instances launched initially will not be terminated or stopped even after Engine idle age. |
No |
Key Pair |
The location of the Key Pair. This is required by AWS for connecting to EC2 instances securely. You can create the key pair at and upload it to your Broker at the path given in this value. |
Yes |
Policy Analysis Interval |
The interval at which to analyze the current policy. Default value is 120000 milliseconds. |
No |
Require Policy Rule |
If true, Engines will be allocated only when a Component policy rule is explicitly specified in the current policy. Otherwise, Engine allocation will happen only for Components with no policy rule. |
No |
Resource2 Nfs Mount |
The mount location used for the Failover Broker Grid Library location. |
No |
Resource2 Nfs Options |
Location to be exported for mounting the Failover Broker Grid Library location. |
No |
Resource Nfs Mount |
The mount location used for the Primary Broker Grid Library location. |
No |
Resource Nfs Options |
Location to be exported for mounting the Primary Broker Grid Library location. |
No |
Secret Key |
Secret key for the respective user. |
Yes |
Security Group Ids |
Comma-separated list of Security Group IDs for VPC. You can associate up to 5 security groups per network interface. |
No |
Security Groups |
Comma-separated list of Security Group IDs for non-VPC. Keep this blank if value is provided in Security Group IDs. You can assign up to 500 security groups to an instance. |
No |
Spare Percentage |
The percentage for the extra instances to be created at the time of instance creation request. The default value is 0.0. The value should be a fraction between 0 to 1. This is applicable only for runtime launch requests and not for initial launch requests. For example, if: Initial Number of Engines to Provision = 0 and Spare Percentage = 0.7, and in the Component, Default Min Engines = 2 and Default Max Engines = 3, Then value is calculated as: adjust = Round(Spare percentage * Default Min Engines) which is 0.7 * 2 = 1.4 = 1 Default Min Engines (required) = Default Min Engines + adjust which is 2+1 =3 Number of instances to Launch = min(adjust, Default Max Engines) which is min(3,3) = 3 So, 3 instances are launched. |
No |
Static Pools |
Comma-separated list of group names of Engines which should not be terminated by the Asset Manager. |
No |
Static Public Ip |
If selected and Assign Public Ip is also selected, new elastic IP are associated with the launched EC2 instance. |
No |
Subnet Id |
ID of the VPC subnet. This is required if the value is provided in Security Group IDs. |
No |
Sweep Volumes |
If selected, all detached volumes would be deleted. |
No |
Terminate |
If selected, available nonallocated Engine instances are terminated after Engine idle time is reached. |
No |
Volume Size |
The updated volume size for the root device type. |
No |