5.2.11 Virtual server resources configuration
Function
Change the instance type because this plugin changes the resources (the number of CPUs, memory capacity, and storage) allocated to an instance in an Amazon EC2 environment.
This plugin assumes the following server:
- AWS control server (execution target server)
A server on which AWS Tools for Windows PowerShell (abbreviated hereafter to "AWS Tools") is installed. AWS Tools transfers the plugin to, and executes it on, this server.
- Instance
A standard virtual server, with a virtual host in an Amazon EC2 environment
The script within this plugin executes the following AWS Tools commandlets:
- Edit-EC2InstanceAttribute -InstanceId "Instance ID (AWS.instanceId property value)"
- InstanceType "Instance type (AWS.instanceType property value)"
- Force
After executing these commandlets, verify that the instance type has been changed.
For details about AWS Tools commandlets, see the AWS document "AWS Tools for Windows PowerShell Cmdlet Reference".
Use situation
This plugin can be used to change instance resources in an Amazon EC2 environment to an instance type that meets the needs of these resources.
Prerequisites
For the latest support information about [Required product for the system], [Required products for the service template execution server], [Prerequisite OS for the required products for the service template execution server], and [Required products for the service template execution system], see the Release Notes.
[Required product for the system]
- JP1/Automatic Operation 11-00 or later
[Required products for the service template execution server]
- AWS Tools for Windows PowerShell
- Microsoft .Net Framework 3.5 or later
[Prerequisite OS for the required products for the service template execution server]
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
Note that this does not apply to environments in which Server Core is installed.
[Required products for the service template execution system]
(1) Required OS for an instance
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
- Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
- Red Hat Enterprise Linux Server 7 (64-bit x86_64)
- Red Hat Enterprise Linux Server 8 (64-bit x86_64)
[Operating conditions for required products for the service template execution system]
(1) Instance conditions
The state of the instance to be changed must be "stopped".
Cautions
(1) Do not specify character strings containing double quotation marks (") or single quotation marks (') in the properties of this plugin.
(2) For other notes, see the notes in the AWS document "AWS Tools for Windows PowerShell Cmdlet Reference".
Execution privilege
(1) Policies must be set up so that IAM users logging in to AWS can perform the following action:
- Changing instance attributes
Version
02.01.00
Plug-in tags
Modify VM,AWS
Plug-in name displayed in the task log
awsChangeVmResource
Return code
0: Normal
23: Error (Invalid environment) Required environment is invalid
27: Error (Check task logs for the nature of error)
41: Error (Error detected in plugin) Missing property (Error detected in plugin script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
AWS.accessKeyId |
Access key ID |
Specify the access key ID for connecting to AWS. |
-- |
Input |
R |
|
AWS.secretAccessKey |
Secret access key |
Specify the secret access key for connecting to AWS. |
-- |
Input |
R |
|
AWS.region |
Region |
Specify an AWS region that is a connection destination. |
-- |
Input |
R |
|
AWS.instanceId |
Instance ID |
Specify the ID of the instance. |
-- |
Input |
R |
|
AWS.instanceType |
Instance type |
Specifies the instance type after a change |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |