AbstractAWSOpsWorksCM (AWS Java SDK for AWS OpsWorks for Chef Automate 1.12.342 API)

java.lang.Object
- com.amazonaws.services.opsworkscm.AbstractAWSOpsWorksCM

All Implemented Interfaces:

AWSOpsWorksCM

Direct Known Subclasses:

AbstractAWSOpsWorksCMAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAWSOpsWorksCM()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateNodeResult`	`associateNode(AssociateNodeRequest request)` Associates a new node with the server.
`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 stacks (including the server's EC2 instance).
`DescribeAccountAttributesResult`	`describeAccountAttributes(DescribeAccountAttributesRequest request)` Describes your OpsWorks-CM account attributes.
`DescribeBackupsResult`	`describeBackups(DescribeBackupsRequest request)` Describes backups.
`DescribeEventsResult`	`describeEvents(DescribeEventsRequest request)` Describes events for a specified server.
`DescribeNodeAssociationStatusResult`	`describeNodeAssociationStatus(DescribeNodeAssociationStatusRequest request)` Returns the current status of an existing association or disassociation request.
`DescribeServersResult`	`describeServers(DescribeServersRequest request)` Lists all configuration management servers that are identified with your account.
`DisassociateNodeResult`	`disassociateNode(DisassociateNodeRequest request)` Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes.
`ExportServerEngineAttributeResult`	`exportServerEngineAttribute(ExportServerEngineAttributeRequest request)` Exports a specified server engine attribute as a base64-encoded string.
`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.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.
`RestoreServerResult`	`restoreServer(RestoreServerRequest request)` Restores a backup to a server that is in a `CONNECTION_LOST`, `HEALTHY`, `RUNNING`, `UNHEALTHY`, or `TERMINATED` 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.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes specified tags from an AWS OpsWorks-CM server or backup.
`UpdateServerResult`	`updateServer(UpdateServerRequest request)` Updates settings for a server.
`UpdateServerEngineAttributesResult`	`updateServerEngineAttributes(UpdateServerEngineAttributesRequest request)` Updates engine-specific attributes on a specified server.
`AWSOpsWorksCMWaiters`	`waiters()`

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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    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)
```
    Description copied from interface: AWSOpsWorksCM
    
    Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.
    
    On a Chef server: This command is an alternative to knife bootstrap.
    
    Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION,Value=default" "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem"
    
    On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR.
    
    Example (Puppet): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR,Value=csr-pem"
    
    A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance.
    
    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 in the BACKING_UP state, the server cannot be changed, and no additional backup can be created.
    
    Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can create a maximum of 50 manual backups.
    
    This operation is asynchronous.
    
    A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or 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 is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers.
    
    This operation is asynchronous.
    
    A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid.
    
    If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group.
    
    Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
    
    Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
    
    By default, your 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.
    
    To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for CustomDomain, CustomCertificate, and CustomPrivateKey.
    
    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.
    
    An InvalidStateException is thrown when a backup deletion is already in progress. 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 stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.
    
    This operation is asynchronous.
    
    An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.
    
    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 OpsWorks-CM account attributes.
    
    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 not valid.
    
    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 not valid.
    
    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)
```
    Description copied from interface: AWSOpsWorksCM
    
    Returns the current status of an existing association or disassociation request.
    
    A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A ValidationException is raised when parameters of the request are not valid.
    
    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 CM 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 not valid.
    
    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)
```
    Description copied from interface: AWSOpsWorksCM
    
    Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode.
    
    A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.
    
    Specified by:
    
    disassociateNode in interface AWSOpsWorksCM
    
    Returns:
    
    Result of the DisassociateNode operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - exportServerEngineAttribute
```
public ExportServerEngineAttributeResult exportServerEngineAttribute(ExportServerEngineAttributeRequest request)
```
    Description copied from interface: AWSOpsWorksCM
    
    Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server.
    
    This operation is synchronous.
    
    A ValidationException is raised when parameters of the request are not valid. A ResourceNotFoundException is thrown when the server does not exist. An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING.
    
    Specified by:
    
    exportServerEngineAttribute in interface AWSOpsWorksCM
    
    Returns:
    
    Result of the ExportServerEngineAttribute operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSOpsWorksCM
    
    Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.
    
    Specified by:
    
    listTagsForResource in interface AWSOpsWorksCM
    
    Returns:
    
    Result of the ListTagsForResource 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 CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED 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 the server's client devices (nodes) should continue to work.
    
    Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a HEALTHY state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a Running or Stopped state, but is eventually terminated.
    
    This operation is asynchronous.
    
    An 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 not valid.
    
    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 is in an UNDER_MAINTENANCE state while maintenance is in progress.
    
    Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.
    
    Specified by:
    
    startMaintenance in interface AWSOpsWorksCM
    
    Returns:
    
    Result of the StartMaintenance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSOpsWorksCM
    
    Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.
    
    Specified by:
    
    tagResource in interface AWSOpsWorksCM
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSOpsWorksCM
    
    Removes specified tags from an AWS OpsWorks-CM server or backup.
    
    Specified by:
    
    untagResource in interface AWSOpsWorksCM
    
    Returns:
    
    Result of the UntagResource 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. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password ( PUPPET_ADMIN_PASSWORD).
    
    This operation is asynchronous.
    
    This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.
    
    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.
  - waiters
```
public AWSOpsWorksCMWaiters waiters()
```
    Specified by:
    
    waiters in interface AWSOpsWorksCM

Class AbstractAWSOpsWorksCM

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAWSOpsWorksCM

Method Detail

setEndpoint

setRegion

associateNode

createBackup

createServer

deleteBackup

deleteServer

describeAccountAttributes

describeBackups

describeEvents

describeNodeAssociationStatus

describeServers

disassociateNode

exportServerEngineAttribute

listTagsForResource

restoreServer

startMaintenance

tagResource

untagResource

updateServer

updateServerEngineAttributes

shutdown

getCachedResponseMetadata

waiters