com.amazonaws.services.opsworkscm.AWSOpsWorksCMAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-opsworkscm Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.opsworkscm;
import javax.annotation.Generated;
import com.amazonaws.services.opsworkscm.model.*;
/**
* Interface for accessing OpsWorksCM asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.opsworkscm.AbstractAWSOpsWorksCMAsync} instead.
*
*
* AWS OpsWorks CM
*
* AWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers.
* You can use AWS OpsWorks CM to create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for Puppet
* Enterprise servers, and add or remove nodes for the servers to manage.
*
*
* Glossary of terms
*
*
* -
*
* Server: A configuration management server that can be highly-available. The configuration management server
* runs on an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon
* Relational Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the
* configuration manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start or stop
* servers. After you create servers, they continue to run until they are deleted.
*
*
* -
*
* Engine: The engine is the specific configuration manager that you want to use. Valid values in this release
* include ChefAutomate and Puppet.
*
*
* -
*
* Backup: This is an application-level backup of the data that the configuration manager stores. AWS OpsWorks CM
* creates an S3 bucket for backups when you launch the first server. A backup maintains a snapshot of a server's
* configuration-related attributes at the time the backup starts.
*
*
* -
*
* Events: Events are always related to a server. Events are written during server creation, when health checks
* run, when backups are created, when system maintenance is performed, etc. When you delete a server, the server's
* events are also deleted.
*
*
* -
*
* Account attributes: Every account has attributes that are assigned in the AWS OpsWorks CM database. These
* attributes store information about configuration limits (servers, backups, etc.) and your customer account.
*
*
*
*
* Endpoints
*
*
* AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your
* servers can only be accessed or managed within the endpoint in which they are created.
*
*
* -
*
* opsworks-cm.us-east-1.amazonaws.com
*
*
* -
*
* opsworks-cm.us-east-2.amazonaws.com
*
*
* -
*
* opsworks-cm.us-west-1.amazonaws.com
*
*
* -
*
* opsworks-cm.us-west-2.amazonaws.com
*
*
* -
*
* opsworks-cm.ap-northeast-1.amazonaws.com
*
*
* -
*
* opsworks-cm.ap-southeast-1.amazonaws.com
*
*
* -
*
* opsworks-cm.ap-southeast-2.amazonaws.com
*
*
* -
*
* opsworks-cm.eu-central-1.amazonaws.com
*
*
* -
*
* opsworks-cm.eu-west-1.amazonaws.com
*
*
*
*
* For more information, see AWS OpsWorks
* endpoints and quotas in the AWS General Reference.
*
*
* Throttling limits
*
*
* All API operations allow for five requests per second with a burst of 10 requests per second.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSOpsWorksCMAsync extends 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.
*
*
* @param associateNodeRequest
* @return A Java Future containing the result of the AssociateNode operation returned by the service.
* @sample AWSOpsWorksCMAsync.AssociateNode
* @see AWS API
* Documentation
*/
java.util.concurrent.Future associateNodeAsync(AssociateNodeRequest associateNodeRequest);
/**
*
* 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.
*
*
* @param associateNodeRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AssociateNode operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.AssociateNode
* @see AWS API
* Documentation
*/
java.util.concurrent.Future associateNodeAsync(AssociateNodeRequest associateNodeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param createBackupRequest
* @return A Java Future containing the result of the CreateBackup operation returned by the service.
* @sample AWSOpsWorksCMAsync.CreateBackup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createBackupAsync(CreateBackupRequest createBackupRequest);
/**
*
* 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.
*
*
* @param createBackupRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateBackup operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.CreateBackup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createBackupAsync(CreateBackupRequest createBackupRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param createServerRequest
* @return A Java Future containing the result of the CreateServer operation returned by the service.
* @sample AWSOpsWorksCMAsync.CreateServer
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createServerAsync(CreateServerRequest createServerRequest);
/**
*
* 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.
*
*
* @param createServerRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateServer operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.CreateServer
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createServerAsync(CreateServerRequest createServerRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deleteBackupRequest
* @return A Java Future containing the result of the DeleteBackup operation returned by the service.
* @sample AWSOpsWorksCMAsync.DeleteBackup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteBackupAsync(DeleteBackupRequest deleteBackupRequest);
/**
*
* 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.
*
*
* @param deleteBackupRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteBackup operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.DeleteBackup
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteBackupAsync(DeleteBackupRequest deleteBackupRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
*
* @param deleteServerRequest
* @return A Java Future containing the result of the DeleteServer operation returned by the service.
* @sample AWSOpsWorksCMAsync.DeleteServer
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteServerAsync(DeleteServerRequest deleteServerRequest);
/**
*
* 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.
*
*
*
*
* @param deleteServerRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteServer operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.DeleteServer
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteServerAsync(DeleteServerRequest deleteServerRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes your OpsWorks-CM account attributes.
*
*
* This operation is synchronous.
*
*
* @param describeAccountAttributesRequest
* @return A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
* @sample AWSOpsWorksCMAsync.DescribeAccountAttributes
* @see AWS API Documentation
*/
java.util.concurrent.Future describeAccountAttributesAsync(
DescribeAccountAttributesRequest describeAccountAttributesRequest);
/**
*
* Describes your OpsWorks-CM account attributes.
*
*
* This operation is synchronous.
*
*
* @param describeAccountAttributesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.DescribeAccountAttributes
* @see AWS API Documentation
*/
java.util.concurrent.Future describeAccountAttributesAsync(
DescribeAccountAttributesRequest describeAccountAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeBackupsRequest
* @return A Java Future containing the result of the DescribeBackups operation returned by the service.
* @sample AWSOpsWorksCMAsync.DescribeBackups
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeBackupsAsync(DescribeBackupsRequest describeBackupsRequest);
/**
*
* 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.
*
*
* @param describeBackupsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeBackups operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.DescribeBackups
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeBackupsAsync(DescribeBackupsRequest describeBackupsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeEventsRequest
* @return A Java Future containing the result of the DescribeEvents operation returned by the service.
* @sample AWSOpsWorksCMAsync.DescribeEvents
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeEventsAsync(DescribeEventsRequest describeEventsRequest);
/**
*
* 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.
*
*
* @param describeEventsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeEvents operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.DescribeEvents
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeEventsAsync(DescribeEventsRequest describeEventsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeNodeAssociationStatusRequest
* @return A Java Future containing the result of the DescribeNodeAssociationStatus operation returned by the
* service.
* @sample AWSOpsWorksCMAsync.DescribeNodeAssociationStatus
* @see AWS API Documentation
*/
java.util.concurrent.Future describeNodeAssociationStatusAsync(
DescribeNodeAssociationStatusRequest describeNodeAssociationStatusRequest);
/**
*
* 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.
*
*
* @param describeNodeAssociationStatusRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeNodeAssociationStatus operation returned by the
* service.
* @sample AWSOpsWorksCMAsyncHandler.DescribeNodeAssociationStatus
* @see AWS API Documentation
*/
java.util.concurrent.Future describeNodeAssociationStatusAsync(
DescribeNodeAssociationStatusRequest describeNodeAssociationStatusRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeServersRequest
* @return A Java Future containing the result of the DescribeServers operation returned by the service.
* @sample AWSOpsWorksCMAsync.DescribeServers
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeServersAsync(DescribeServersRequest describeServersRequest);
/**
*
* 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.
*
*
* @param describeServersRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeServers operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.DescribeServers
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeServersAsync(DescribeServersRequest describeServersRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param disassociateNodeRequest
* @return A Java Future containing the result of the DisassociateNode operation returned by the service.
* @sample AWSOpsWorksCMAsync.DisassociateNode
* @see AWS
* API Documentation
*/
java.util.concurrent.Future disassociateNodeAsync(DisassociateNodeRequest disassociateNodeRequest);
/**
*
* 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.
*
*
* @param disassociateNodeRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DisassociateNode operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.DisassociateNode
* @see AWS
* API Documentation
*/
java.util.concurrent.Future disassociateNodeAsync(DisassociateNodeRequest disassociateNodeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param exportServerEngineAttributeRequest
* @return A Java Future containing the result of the ExportServerEngineAttribute operation returned by the service.
* @sample AWSOpsWorksCMAsync.ExportServerEngineAttribute
* @see AWS API Documentation
*/
java.util.concurrent.Future exportServerEngineAttributeAsync(
ExportServerEngineAttributeRequest exportServerEngineAttributeRequest);
/**
*
* 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.
*
*
* @param exportServerEngineAttributeRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ExportServerEngineAttribute operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.ExportServerEngineAttribute
* @see AWS API Documentation
*/
java.util.concurrent.Future exportServerEngineAttributeAsync(
ExportServerEngineAttributeRequest exportServerEngineAttributeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSOpsWorksCMAsync.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param restoreServerRequest
* @return A Java Future containing the result of the RestoreServer operation returned by the service.
* @sample AWSOpsWorksCMAsync.RestoreServer
* @see AWS API
* Documentation
*/
java.util.concurrent.Future restoreServerAsync(RestoreServerRequest restoreServerRequest);
/**
*
* 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.
*
*
* @param restoreServerRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RestoreServer operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.RestoreServer
* @see AWS API
* Documentation
*/
java.util.concurrent.Future restoreServerAsync(RestoreServerRequest restoreServerRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param startMaintenanceRequest
* @return A Java Future containing the result of the StartMaintenance operation returned by the service.
* @sample AWSOpsWorksCMAsync.StartMaintenance
* @see AWS
* API Documentation
*/
java.util.concurrent.Future startMaintenanceAsync(StartMaintenanceRequest startMaintenanceRequest);
/**
*
* 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.
*
*
* @param startMaintenanceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartMaintenance operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.StartMaintenance
* @see AWS
* API Documentation
*/
java.util.concurrent.Future startMaintenanceAsync(StartMaintenanceRequest startMaintenanceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server
* backups.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSOpsWorksCMAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server
* backups.
*
*
* @param tagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes specified tags from an AWS OpsWorks-CM server or backup.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSOpsWorksCMAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes specified tags from an AWS OpsWorks-CM server or backup.
*
*
* @param untagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates settings for a server.
*
*
* This operation is synchronous.
*
*
* @param updateServerRequest
* @return A Java Future containing the result of the UpdateServer operation returned by the service.
* @sample AWSOpsWorksCMAsync.UpdateServer
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateServerAsync(UpdateServerRequest updateServerRequest);
/**
*
* Updates settings for a server.
*
*
* This operation is synchronous.
*
*
* @param updateServerRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateServer operation returned by the service.
* @sample AWSOpsWorksCMAsyncHandler.UpdateServer
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateServerAsync(UpdateServerRequest updateServerRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param updateServerEngineAttributesRequest
* @return A Java Future containing the result of the UpdateServerEngineAttributes operation returned by the
* service.
* @sample AWSOpsWorksCMAsync.UpdateServerEngineAttributes
* @see AWS API Documentation
*/
java.util.concurrent.Future updateServerEngineAttributesAsync(
UpdateServerEngineAttributesRequest updateServerEngineAttributesRequest);
/**
*
* 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.
*
*
* @param updateServerEngineAttributesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateServerEngineAttributes operation returned by the
* service.
* @sample AWSOpsWorksCMAsyncHandler.UpdateServerEngineAttributes
* @see AWS API Documentation
*/
java.util.concurrent.Future updateServerEngineAttributesAsync(
UpdateServerEngineAttributesRequest updateServerEngineAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}