com.amazonaws.services.opsworkscm

Class AbstractAWSOpsWorksCM

java.lang.Object

com.amazonaws.services.opsworkscm.AbstractAWSOpsWorksCM

All Implemented Interfaces:

AWSOpsWorksCM

Direct Known Subclasses:

AbstractAWSOpsWorksCMAsync

public class AbstractAWSOpsWorksCM
extends Object
implements AWSOpsWorksCM

Abstract implementation of AWSOpsWorksCM. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.opsworkscm.AWSOpsWorksCM

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAWSOpsWorksCM()

Method Summary

Modifier and Type	Method and Description
AssociateNodeResult	associateNode(AssociateNodeRequest request)
CreateBackupResult	createBackup(CreateBackupRequest request) Creates an application-level backup of a server.
CreateServerResult	createServer(CreateServerRequest request) Creates and immedately starts a new Server.
DeleteBackupResult	deleteBackup(DeleteBackupRequest request) Deletes a backup.
DeleteServerResult	deleteServer(DeleteServerRequest request) Deletes the server and the underlying AWS CloudFormation stack (including the server's EC2 instance).
DescribeAccountAttributesResult	describeAccountAttributes(DescribeAccountAttributesRequest request) Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
DescribeBackupsResult	describeBackups(DescribeBackupsRequest request) Describes backups.
DescribeEventsResult	describeEvents(DescribeEventsRequest request) Describes events for a specified server.
DescribeNodeAssociationStatusResult	describeNodeAssociationStatus(DescribeNodeAssociationStatusRequest request)
DescribeServersResult	describeServers(DescribeServersRequest request) Lists all configuration management servers that are identified with your account.
DisassociateNodeResult	disassociateNode(DisassociateNodeRequest request)
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
RestoreServerResult	restoreServer(RestoreServerRequest request) Restores a backup to a server that is in a RUNNING, FAILED, or HEALTHY state.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("opsworks-cm.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to AWSOpsWorksCM.setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartMaintenanceResult	startMaintenance(StartMaintenanceRequest request) Manually starts server maintenance.
UpdateServerResult	updateServer(UpdateServerRequest request) Updates settings for a server.
UpdateServerEngineAttributesResult	updateServerEngineAttributes(UpdateServerEngineAttributesRequest request) Updates engine specific attributes on a specified server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAWSOpsWorksCM

protected AbstractAWSOpsWorksCM()

Method Detail

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AWSOpsWorksCM

Overrides the default endpoint for this client ("opsworks-cm.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "opsworks-cm.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "opsworks-cm.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Specified by:

setEndpoint in interface AWSOpsWorksCM

Parameters:

endpoint - The endpoint (ex: "opsworks-cm.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "opsworks-cm.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

public void setRegion(Region region)

Description copied from interface: AWSOpsWorksCM

An alternative to AWSOpsWorksCM.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Specified by:

setRegion in interface AWSOpsWorksCM

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

associateNode

public AssociateNodeResult associateNode(AssociateNodeRequest request)

Specified by:

associateNode in interface AWSOpsWorksCM

Returns:

Result of the AssociateNode operation returned by the service.

See Also:

AWS API Documentation

createBackup

public CreateBackupResult createBackup(CreateBackupRequest request)

Description copied from interface: AWSOpsWorksCM

Creates an application-level backup of a server. While the server is BACKING_UP, the server can not be modified and no additional backup can be created.

Backups can be created for RUNNING, HEALTHY and UNHEALTHY servers.

This operation is asnychronous.

By default 50 manual backups can be created.

A LimitExceededException is thrown then the maximum number of manual backup is reached. A InvalidStateException is thrown when the server is not in any of RUNNING, HEALTHY, UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.

Specified by:

createBackup in interface AWSOpsWorksCM

Returns:

Result of the CreateBackup operation returned by the service.

See Also:

AWS API Documentation

createServer

public CreateServerResult createServer(CreateServerRequest request)

Description copied from interface: AWSOpsWorksCM

Creates and immedately starts a new Server. The server can be used once it has reached the HEALTHY state.

This operation is asnychronous.

A LimitExceededException is thrown then the maximum number of server backup is reached. A ResourceAlreadyExistsException is raise when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when a backupId is passed, but the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

By default 10 servers can be created. A LimitExceededException is raised when the limit is exceeded.

When no security groups are provided by using SecurityGroupIds, AWS OpsWorks creates a new security group. This security group opens the Chef server to the world on TCP port 443. If a KeyName is present, SSH access is enabled. SSH is also open to the world on TCP port 22.

By default, the Chef Server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.

Specified by:

createServer in interface AWSOpsWorksCM

Returns:

Result of the CreateServer operation returned by the service.

See Also:

AWS API Documentation

deleteBackup

public DeleteBackupResult deleteBackup(DeleteBackupRequest request)

Description copied from interface: AWSOpsWorksCM

Deletes a backup. You can delete both manual and automated backups.

This operation is asynchronous.

A InvalidStateException is thrown then a backup is already deleting. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

Specified by:

deleteBackup in interface AWSOpsWorksCM

Returns:

Result of the DeleteBackup operation returned by the service.

See Also:

AWS API Documentation

deleteServer

public DeleteServerResult deleteServer(DeleteServerRequest request)

Description copied from interface: AWSOpsWorksCM

Deletes the server and the underlying AWS CloudFormation stack (including the server's EC2 instance). The server status updated to DELETING. Once the server is successfully deleted, it will no longer be returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

This operation is asynchronous.

A InvalidStateException is thrown then a server is already deleting. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

deleteServer in interface AWSOpsWorksCM

Returns:

Result of the DeleteServer operation returned by the service.

See Also:

AWS API Documentation

describeAccountAttributes

public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)

Description copied from interface: AWSOpsWorksCM

Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.

This operation is synchronous.

Specified by:

describeAccountAttributes in interface AWSOpsWorksCM

Returns:

Result of the DescribeAccountAttributes operation returned by the service.

See Also:

AWS API Documentation

describeBackups

public DescribeBackupsResult describeBackups(DescribeBackupsRequest request)

Description copied from interface: AWSOpsWorksCM

Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.

This operation is synchronous.

A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

describeBackups in interface AWSOpsWorksCM

Returns:

Result of the DescribeBackups operation returned by the service.

See Also:

AWS API Documentation

describeEvents

public DescribeEventsResult describeEvents(DescribeEventsRequest request)

Description copied from interface: AWSOpsWorksCM

Describes events for a specified server. Results are ordered by time, with newest events first.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

describeEvents in interface AWSOpsWorksCM

Returns:

Result of the DescribeEvents operation returned by the service.

See Also:

AWS API Documentation

describeNodeAssociationStatus

public DescribeNodeAssociationStatusResult describeNodeAssociationStatus(DescribeNodeAssociationStatusRequest request)

Specified by:

describeNodeAssociationStatus in interface AWSOpsWorksCM

Returns:

Result of the DescribeNodeAssociationStatus operation returned by the service.

See Also:

AWS API Documentation

describeServers

public DescribeServersResult describeServers(DescribeServersRequest request)

Description copied from interface: AWSOpsWorksCM

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks for Chef Automate does not query other services.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

describeServers in interface AWSOpsWorksCM

Returns:

Result of the DescribeServers operation returned by the service.

See Also:

AWS API Documentation

disassociateNode

public DisassociateNodeResult disassociateNode(DisassociateNodeRequest request)

Specified by:

disassociateNode in interface AWSOpsWorksCM

Returns:

Result of the DisassociateNode operation returned by the service.

See Also:

AWS API Documentation

restoreServer

public RestoreServerResult restoreServer(RestoreServerRequest request)

Description copied from interface: AWSOpsWorksCM

Restores a backup to a server that is in a RUNNING, FAILED, or HEALTHY state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of all of the server's client devices should continue to work.

This operation is asynchronous.

A InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

restoreServer in interface AWSOpsWorksCM

Returns:

Result of the RestoreServer operation returned by the service.

See Also:

AWS API Documentation

startMaintenance

public StartMaintenanceResult startMaintenance(StartMaintenanceRequest request)

Description copied from interface: AWSOpsWorksCM

Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server will switch to UNDER_MAINTENANCE state, while maintenace is in progress.

Maintenace can only be started for HEALTHY and UNHEALTHY servers. A InvalidStateException is thrown otherwise. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

startMaintenance in interface AWSOpsWorksCM

Returns:

Result of the StartMaintenance operation returned by the service.

See Also:

AWS API Documentation

updateServer

public UpdateServerResult updateServer(UpdateServerRequest request)

Description copied from interface: AWSOpsWorksCM

Updates settings for a server.

This operation is synchronous.

Specified by:

updateServer in interface AWSOpsWorksCM

Returns:

Result of the UpdateServer operation returned by the service.

See Also:

AWS API Documentation

updateServerEngineAttributes

public UpdateServerEngineAttributesResult updateServerEngineAttributes(UpdateServerEngineAttributesRequest request)

Description copied from interface: AWSOpsWorksCM

Updates engine specific attributes on a specified server. Server will enter the MODIFYING state when this operation is in progress. Only one update can take place at a time.

This operation can be use to reset Chef Server main API key (CHEF_PIVOTAL_KEY).

This operation is asynchronous.

This operation can only be called for HEALTHY and UNHEALTHY servers. Otherwise a InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Specified by:

updateServerEngineAttributes in interface AWSOpsWorksCM

Returns:

Result of the UpdateServerEngineAttributes operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AWSOpsWorksCM

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSOpsWorksCM

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSOpsWorksCM

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AWSOpsWorksCM

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.