com.amazonaws.services.opsworks.model

Class RegisterInstanceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opsworks.model.RegisterInstanceRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RegisterInstanceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RegisterInstance operation.

Registers instances with a specified stack that were created outside of AWS OpsWorks.

NOTE:We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stack.

Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

See Also:

AWSOpsWorks.registerInstance(RegisterInstanceRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterInstanceRequest()

Method Summary

Methods

Modifier and Type	Method and Description
RegisterInstanceRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getHostname() The instance's hostname.
InstanceIdentity	getInstanceIdentity() An InstanceIdentity object that contains the instance's identity.
String	getPrivateIp() The instance's private IP address.
String	getPublicIp() The instance's public IP address.
String	getRsaPublicKey() The instances public RSA key.
String	getRsaPublicKeyFingerprint() The instances public RSA key fingerprint.
String	getStackId() The ID of the stack that the instance is to be registered with.
int	hashCode()
void	setHostname(String hostname) The instance's hostname.
void	setInstanceIdentity(InstanceIdentity instanceIdentity) An InstanceIdentity object that contains the instance's identity.
void	setPrivateIp(String privateIp) The instance's private IP address.
void	setPublicIp(String publicIp) The instance's public IP address.
void	setRsaPublicKey(String rsaPublicKey) The instances public RSA key.
void	setRsaPublicKeyFingerprint(String rsaPublicKeyFingerprint) The instances public RSA key fingerprint.
void	setStackId(String stackId) The ID of the stack that the instance is to be registered with.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RegisterInstanceRequest	withHostname(String hostname) The instance's hostname.
RegisterInstanceRequest	withInstanceIdentity(InstanceIdentity instanceIdentity) An InstanceIdentity object that contains the instance's identity.
RegisterInstanceRequest	withPrivateIp(String privateIp) The instance's private IP address.
RegisterInstanceRequest	withPublicIp(String publicIp) The instance's public IP address.
RegisterInstanceRequest	withRsaPublicKey(String rsaPublicKey) The instances public RSA key.
RegisterInstanceRequest	withRsaPublicKeyFingerprint(String rsaPublicKeyFingerprint) The instances public RSA key fingerprint.
RegisterInstanceRequest	withStackId(String stackId) The ID of the stack that the instance is to be registered with.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegisterInstanceRequest

public RegisterInstanceRequest()

Method Detail

getStackId

public String getStackId()

The ID of the stack that the instance is to be registered with.

Returns:

The ID of the stack that the instance is to be registered with.

setStackId

public void setStackId(String stackId)

The ID of the stack that the instance is to be registered with.

Parameters:

stackId - The ID of the stack that the instance is to be registered with.

withStackId

public RegisterInstanceRequest withStackId(String stackId)

The ID of the stack that the instance is to be registered with.

Returns a reference to this object so that method calls can be chained together.

Parameters:

stackId - The ID of the stack that the instance is to be registered with.

Returns:

A reference to this updated object so that method calls can be chained together.

getHostname

public String getHostname()

The instance's hostname.

Returns:

The instance's hostname.

setHostname

public void setHostname(String hostname)

The instance's hostname.

Parameters:

hostname - The instance's hostname.

withHostname

public RegisterInstanceRequest withHostname(String hostname)

The instance's hostname.

Returns a reference to this object so that method calls can be chained together.

Parameters:

hostname - The instance's hostname.

Returns:

A reference to this updated object so that method calls can be chained together.

getPublicIp

public String getPublicIp()

The instance's public IP address.

Returns:

The instance's public IP address.

setPublicIp

public void setPublicIp(String publicIp)

The instance's public IP address.

Parameters:

publicIp - The instance's public IP address.

withPublicIp

public RegisterInstanceRequest withPublicIp(String publicIp)

The instance's public IP address.

Returns a reference to this object so that method calls can be chained together.

Parameters:

publicIp - The instance's public IP address.

Returns:

A reference to this updated object so that method calls can be chained together.

getPrivateIp

public String getPrivateIp()

The instance's private IP address.

Returns:

The instance's private IP address.

setPrivateIp

public void setPrivateIp(String privateIp)

The instance's private IP address.

Parameters:

privateIp - The instance's private IP address.

withPrivateIp

public RegisterInstanceRequest withPrivateIp(String privateIp)

The instance's private IP address.

Returns a reference to this object so that method calls can be chained together.

Parameters:

privateIp - The instance's private IP address.

Returns:

A reference to this updated object so that method calls can be chained together.

getRsaPublicKey

public String getRsaPublicKey()

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

Returns:

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

setRsaPublicKey

public void setRsaPublicKey(String rsaPublicKey)

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

Parameters:

rsaPublicKey - The instances public RSA key. This key is used to encrypt communication between the instance and the service.

withRsaPublicKey

public RegisterInstanceRequest withRsaPublicKey(String rsaPublicKey)

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

Returns a reference to this object so that method calls can be chained together.

Parameters:

rsaPublicKey - The instances public RSA key. This key is used to encrypt communication between the instance and the service.

Returns:

A reference to this updated object so that method calls can be chained together.

getRsaPublicKeyFingerprint

public String getRsaPublicKeyFingerprint()

The instances public RSA key fingerprint.

Returns:

The instances public RSA key fingerprint.

setRsaPublicKeyFingerprint

public void setRsaPublicKeyFingerprint(String rsaPublicKeyFingerprint)

The instances public RSA key fingerprint.

Parameters:

rsaPublicKeyFingerprint - The instances public RSA key fingerprint.

withRsaPublicKeyFingerprint

public RegisterInstanceRequest withRsaPublicKeyFingerprint(String rsaPublicKeyFingerprint)

The instances public RSA key fingerprint.

Returns a reference to this object so that method calls can be chained together.

Parameters:

rsaPublicKeyFingerprint - The instances public RSA key fingerprint.

Returns:

A reference to this updated object so that method calls can be chained together.

getInstanceIdentity

public InstanceIdentity getInstanceIdentity()

An InstanceIdentity object that contains the instance's identity.

Returns:

An InstanceIdentity object that contains the instance's identity.

setInstanceIdentity

public void setInstanceIdentity(InstanceIdentity instanceIdentity)

An InstanceIdentity object that contains the instance's identity.

Parameters:

instanceIdentity - An InstanceIdentity object that contains the instance's identity.

withInstanceIdentity

public RegisterInstanceRequest withInstanceIdentity(InstanceIdentity instanceIdentity)

An InstanceIdentity object that contains the instance's identity.

Returns a reference to this object so that method calls can be chained together.

Parameters:

instanceIdentity - An InstanceIdentity object that contains the instance's identity.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public RegisterInstanceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()