Configuring the Amazon EC2 adapter

While each adapter must have a unique name, you can create multiple adapters with the same adapter type to allow for different configuration properties.

Note

Before creating an adapter configuration, ensure that the prerequisites are met. The default name for the actor adapter is AmazonEC2ActorAdapter.

To configure the actor adapter

To access the adapters page, click the Manage tab, then click the Adapters tab.
Click Add.
On the Add an Adapter Configuration page, specify the properties for the new Adapter, and click OK.
1. Type a description for the adapter.
2. In Type, select the bmc-adapter-amazon-ec2-actor versionNumber as the adapter type.
3. In Properties, specify the adapter configuration properties in an XML format, including all required elements, indicated in the following table.
  
  If the default value for an optional element is acceptable, omit the element. Do not include empty elements.
  
  To resolve proxy settings errors, enter the proxy settings for the Internet connection. To resolve authentication errors, enter a valid user name and password.

Node elements for configuring the actor adapter

Element	Description	Required
`<wsdl-location>`>	Specifies the target Web Service Description Language (WSDL) URL for Amazon EC2 Examples of WSDL locations that do not use a URL query string: http://ec2.amazonaws.com/doc/2009-11-30/ http://ec2.amazonaws.com/doc/2011-02-28/	Conditional: Required if not specified in the request If specified in the configuration and request, the value in the request overrides the value in the configuration
`<endpoint-address>`	Specifies the web service endpoint for the adapter to use while performing operations on Amazon EC2 instances across different regions The values for the different regions are: http://us-east-1.ec2.amazonaws.com/: Endpoint in the US East region (Northern Virginia) http://us-west-1.ec2.amazonaws.com: Endpoint in the US West region (Northern California) http://eu-west-1.ec2.amazonaws.com/ : Endpoint in the European region (Ireland) Default value: US East region: http://us-east-1.ec2.amazonaws.com/	No
`<time-to-live>`	Specifies the time (in seconds) for which the adapter request is signed as valid Default value: 60 seconds	No
`<signature-properties>`	Specifies the mode for signing the adapter request; contains the `mode` attribute that specifies whether the private-key and certificate file paths or the complete inline data for these values is passed in the configuration for authentication Valid values for the `mode` attribute: `<signature-properties mode="key-files">` `<signature-properties mode="key-data">` Valid formats for the keys: Java Keystore (JKS) Privacy Enhanced Mail (PEM) Definite Encoding Rules (DER) files Base64-encoded PEM	Conditional: Required if not specified in the request If specified in the configuration and request, the value in the request overrides the value in the configuration If `mode="key-files"`, requires `<private-key-file>` and `<certificate-file>` If `mode="key-data"`, requires `<private-key-data>` and `<certificate-data>`
`<private-key-file>`	Specifies the path for the private key file, which is used to sign the HTTP request Valid formats: Base64-encoded PEM DER	Conditional; required if `<signature-properties mode = "key-files">`
`<certificate-file>`	Specifies the file containing the public key (X.509 Certificate) Valid formats: Base64-encoded PEM DER	Conditional; required if `<signature-properties mode = "key-files">`
`<private-key-data>`	Contains the XML data specifying the private key in a Base64-encoded PEM format	Conditional; required if `<signature-properties mode = "key-data">`
`<certificate-data>`	Contains the XML data specifying the public key (X.509 Certificate) in a Base64-encoded PEM format	Conditional; required if `<signature-properties mode = "key-data">`
`<proxy-settings>`	Contains the elements that define the HTTP proxy settings If you specify this element, you must also specify the `<host>` and `<port>` elements. You must specify the `<user-name>` and `<password>` elements only if the proxy server requires this authentication. Note: To configure `<proxy-settings>`, you must switch to XML view as `<proxy-settings>` are not available as fields in a form view.	No
`<host>`	Specifies the host name or the IP address of the destination host for the adapter request	Conditional; required if `<proxy-settings>` is specified
`<port>`	Specifies the destination port for the adapter request	Conditional; required if `<proxy-settings>` is specified
`<user-name>`	Specifies the name of the user on the specified host You must specify this element only if the proxy server requires this authentication.	Conditional; required if `<proxy-settings>` is specified
`<password>`	Specifies the password for the user on the specified host You must specify this element only if the proxy server requires this authentication.	Conditional; required if `<proxy-settings>` is specified
`<use-connection-pooling>`	Specifies whether the connection pooling feature is enabled for the adapter Valid values: true, false (default)	No
`<max-connections>`	If the value of `<use-connection-pooling>` is true, defines the maximum number of objects that can be in circulation in the pool Valid values: Any positive integer Default value: 10	No
`<connection-ttl>`	If the value of `<use-connection-pooling>` is true, specifies the maximum amount of time, in minutes, that a connection can remain idle in the connection pool before it is terminated Valid values: Any positive integer Default value: 60 minutes	No

XML sample for configuring the actor adapter with the key-files mode

<config>
    <wsdl-location>http://ec2.amazonaws.com/doc/2009-11-30/
</wsdl-location>
    <endpoint-address>http://eu-west-1.ec2.amazonaws.com/
</endpoint-address>
    <time-to-live>60</time-to-live>
    <signature-properties mode = "key-files">
        <private-key-file>C:\Security\pk-MJ5GIUNLM2XJ3VRJSY
TKOFDWILELDQHB.PEM</private-key-file>
        <certificate-file>C:\Security\cert-MJ5GIUNLM2XJ3VRJS
YTKOFDWILELDQHB.PEM</certificate-file>
    </signature-properties>
    <proxy-settings>
        <host>10.10.75.120</host>
        <port>3128</port>
        <user-name>jones</user-name>
        <password>bmc1234</password>
    </proxy-settings>
</config>

XML sample for configuring the adapter with the key-data mode

<config>
    <wsdl-location>http://ec2.amazonaws.com/doc/2009-11-30/
</wsdl-location>
    <endpoint-address>http://eu-west-1.ec2.amazonaws.com/
</endpoint-address>
    <time-to-live>60</time-to-live>
    <signature-properties mode = "key-data">
        <private-key-data>-----BEGIN PRIVATE KEY-----
            MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl8wggJbAgEAA
oGBAKomKro6VbW4PeQtUhNzZpSH26vbBTBtH1r4EjnIv4vnhSyyA62ewp
ROVNn0SpvjoBFwE88HcX3tXym/zbVgtdPke9K+SYHP6CWdiLqnkzXde
+e3GX/y+OIRlFvA1FKgpHKF+a0nVMdwxpxPzJqwFSEKgMaqSo73f0HZOY8PN4y9
AgMBAAECgYAtUd0vnToXHOvfSvMBm0tHZKhuLfhD3czsPgccvQvIB/LA5Ol15UOO
nQ6cvyTgQNDx1BhynFjuYbtnM19nYEsNpR8Ndxfv7dSAcqZVHsu8OfShQ/WoRqU5
ZxSHyVGLrteIKjuv/cy/ac2clqlJu6arzc2JquiDZQ9KbEY4ODtPQQJBNC+rSrEP
qHbWp0URMdzjiskO3c4amiyoIlWO4F0GnWHjn/WnjUdVQ9mZrNTter7qUtZEyq839
B6iQ8WHvfU0meMCQQC1vjDoTqEuxFHkc6qBdrjXK6Rqp23smX0mHLqKnjxlbD8t8n
ki65wh5UY8mpoe6t9Ehcnghouhcnhko2/6/IDfAkBP5BNzzjpj0s3TUhYDAb6DovcA
+xElja5UQto7aDcSKGRr6LxJaPzDDlz0ZW0jMs0GK8w8eDRh+ckJkWQa1rvtAkAkhPgs
5gfrbtWJ01gytZmE2ycpq0UiYuFL9D/jtNIsCylS4UNIKhHwmbKYYPSRO97rVPrw2/
hY07iveEv7Ihv/AkAaIoKFbuJhln+tlJdmN16mzl1QnyDi469i2C/yXQEvNkjiDQGHr
MlhA+0eik8+JuL/TEwgrcOYKP5BI0XNL71L
            -----END PRIVATE KEY-----</private-key-data>
        <certificate-data>-----BEGIN CERTIFICATE-----
MIICdzCCAeCgAwIBAgIFXseN2xbnDQYJKoZIhvcNAQEFBQAwUzELMAkGA1UEBhMC
VVMxEzARBgNVBAoTCkFtYXpvbi5jb20xDDAKBgNVBAsTA0FXUzEhMB8GA1UEAxMY
QVdTIExpbWl0ZWQtQXNzdXJhbmNlIENBMB4XDTA5MTExMzA3MDYyMVoXDTEwMTEx
MzA3MDYyMVowUzELMAkGA1UEBhMCVVMxEzARBgNVBAoTCkFtYXpvbi5jb20xFzAV
BgNVBAsTDkFXUy1EZXZlbG9wZXJzMRYwFAYDVQQDEw0xeHVidzR2NmRrY2xlMIGf
MA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqJiq6OlW1uD3kLVITc2aUh9ur2wUw
bR9a+BI5yL+L54UssgOtnsKUTlTZ9Eqb46ARcBPPB3F97V8pv821YLXT5HvSvkmB
z+glnYi6p5M13Xvntxl/8vjiEZRbwNRSoKRyhfmtJ1THcMacT8yasBUhCoDGqkqO
939B2TmPDzeMvQIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww
CgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQUkm3B1OqNA7E6ZWew
RC7GMGfoFd8wDQYJKoZIhvcNAQEFBQADgYEABzTAe7dUsEfR1fGsgHjAt0vhqwAx
+S/V5tLZZXjsnuW6jowOyHqZrZ/9xZlWrK6wfmHoHUBNkMc935EuCiAH0qX6oef/
m/0iDplDR7XkyTxAx0AWo0RF4mstOszPGbpHBKFri2qxyXM0NmIPX2dJqhKICXP4
8HATrUjWl+peSog=
            -----END CERTIFICATE-----</certificate-data>
    </signature-properties>
    <proxy-settings>
        <host>10.10.75.120</host>
        <port>3128</port>
        <user-name>jones</user-name>
        <password>bmc1234</password>
    </proxy-settings>
</config>

Configuring the Amazon EC2 adapter

To configure the actor adapter

Comments