@Generated(value="software.amazon.awssdk:codegen") public interface OpsWorksCmAsyncClient extends SdkClient
builder()
method.
AWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers.
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 Chef
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-west-2.amazonaws.com
opsworks-cm.eu-west-1.amazonaws.com
Throttling limits
All API operations allow for five requests per second with a burst of 10 requests per second.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AssociateNodeResponse> |
associateNode(AssociateNodeRequest associateNodeRequest)
Associates a new node with the server.
|
default CompletableFuture<AssociateNodeResponse> |
associateNode(Consumer<AssociateNodeRequest.Builder> associateNodeRequest)
Associates a new node with the server.
|
static OpsWorksCmAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
OpsWorksCmAsyncClient . |
static OpsWorksCmAsyncClient |
create()
Create a
OpsWorksCmAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateBackupResponse> |
createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest)
Creates an application-level backup of a server.
|
default CompletableFuture<CreateBackupResponse> |
createBackup(CreateBackupRequest createBackupRequest)
Creates an application-level backup of a server.
|
default CompletableFuture<CreateServerResponse> |
createServer(Consumer<CreateServerRequest.Builder> createServerRequest)
Creates and immedately starts a new server.
|
default CompletableFuture<CreateServerResponse> |
createServer(CreateServerRequest createServerRequest)
Creates and immedately starts a new server.
|
default CompletableFuture<DeleteBackupResponse> |
deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)
Deletes a backup.
|
default CompletableFuture<DeleteBackupResponse> |
deleteBackup(DeleteBackupRequest deleteBackupRequest)
Deletes a backup.
|
default CompletableFuture<DeleteServerResponse> |
deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest)
Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance).
|
default CompletableFuture<DeleteServerResponse> |
deleteServer(DeleteServerRequest deleteServerRequest)
Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance).
|
default CompletableFuture<DescribeAccountAttributesResponse> |
describeAccountAttributes()
Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
|
default CompletableFuture<DescribeAccountAttributesResponse> |
describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest)
Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
|
default CompletableFuture<DescribeAccountAttributesResponse> |
describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
|
default CompletableFuture<DescribeBackupsResponse> |
describeBackups()
Describes backups.
|
default CompletableFuture<DescribeBackupsResponse> |
describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)
Describes backups.
|
default CompletableFuture<DescribeBackupsResponse> |
describeBackups(DescribeBackupsRequest describeBackupsRequest)
Describes backups.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Describes events for a specified server.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents(DescribeEventsRequest describeEventsRequest)
Describes events for a specified server.
|
default CompletableFuture<DescribeNodeAssociationStatusResponse> |
describeNodeAssociationStatus(Consumer<DescribeNodeAssociationStatusRequest.Builder> describeNodeAssociationStatusRequest)
Returns the current status of an existing association or disassociation request.
|
default CompletableFuture<DescribeNodeAssociationStatusResponse> |
describeNodeAssociationStatus(DescribeNodeAssociationStatusRequest describeNodeAssociationStatusRequest)
Returns the current status of an existing association or disassociation request.
|
default CompletableFuture<DescribeServersResponse> |
describeServers()
Lists all configuration management servers that are identified with your account.
|
default CompletableFuture<DescribeServersResponse> |
describeServers(Consumer<DescribeServersRequest.Builder> describeServersRequest)
Lists all configuration management servers that are identified with your account.
|
default CompletableFuture<DescribeServersResponse> |
describeServers(DescribeServersRequest describeServersRequest)
Lists all configuration management servers that are identified with your account.
|
default CompletableFuture<DisassociateNodeResponse> |
disassociateNode(Consumer<DisassociateNodeRequest.Builder> disassociateNodeRequest)
Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes.
|
default CompletableFuture<DisassociateNodeResponse> |
disassociateNode(DisassociateNodeRequest disassociateNodeRequest)
Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes.
|
default CompletableFuture<RestoreServerResponse> |
restoreServer(Consumer<RestoreServerRequest.Builder> restoreServerRequest)
Restores a backup to a server that is in a
CONNECTION_LOST , HEALTHY ,
RUNNING , UNHEALTHY , or TERMINATED state. |
default CompletableFuture<RestoreServerResponse> |
restoreServer(RestoreServerRequest restoreServerRequest)
Restores a backup to a server that is in a
CONNECTION_LOST , HEALTHY ,
RUNNING , UNHEALTHY , or TERMINATED state. |
default CompletableFuture<StartMaintenanceResponse> |
startMaintenance(Consumer<StartMaintenanceRequest.Builder> startMaintenanceRequest)
Manually starts server maintenance.
|
default CompletableFuture<StartMaintenanceResponse> |
startMaintenance(StartMaintenanceRequest startMaintenanceRequest)
Manually starts server maintenance.
|
default CompletableFuture<UpdateServerResponse> |
updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest)
Updates settings for a server.
|
default CompletableFuture<UpdateServerResponse> |
updateServer(UpdateServerRequest updateServerRequest)
Updates settings for a server.
|
default CompletableFuture<UpdateServerEngineAttributesResponse> |
updateServerEngineAttributes(Consumer<UpdateServerEngineAttributesRequest.Builder> updateServerEngineAttributesRequest)
Updates engine-specific attributes on a specified server.
|
default CompletableFuture<UpdateServerEngineAttributesResponse> |
updateServerEngineAttributes(UpdateServerEngineAttributesRequest updateServerEngineAttributesRequest)
Updates engine-specific attributes on a specified server.
|
serviceName
close
static final String SERVICE_NAME
static OpsWorksCmAsyncClient create()
OpsWorksCmAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static OpsWorksCmAsyncClientBuilder builder()
OpsWorksCmAsyncClient
.default CompletableFuture<AssociateNodeResponse> associateNode(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 (Chef):
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.
associateNodeRequest
- default CompletableFuture<AssociateNodeResponse> associateNode(Consumer<AssociateNodeRequest.Builder> 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 (Chef):
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.
This is a convenience which creates an instance of the AssociateNodeRequest.Builder
avoiding the need to
create one manually via AssociateNodeRequest.builder()
associateNodeRequest
- A Consumer
that will call methods on AssociateNodeRequest.Builder
to create a request.default CompletableFuture<CreateBackupResponse> createBackup(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.
createBackupRequest
- default CompletableFuture<CreateBackupResponse> createBackup(Consumer<CreateBackupRequest.Builder> 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.
This is a convenience which creates an instance of the CreateBackupRequest.Builder
avoiding the need to
create one manually via CreateBackupRequest.builder()
createBackupRequest
- A Consumer
that will call methods on CreateBackupRequest.Builder
to create a request.default CompletableFuture<CreateServerResponse> createServer(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.
createServerRequest
- default CompletableFuture<CreateServerResponse> createServer(Consumer<CreateServerRequest.Builder> 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.
This is a convenience which creates an instance of the CreateServerRequest.Builder
avoiding the need to
create one manually via CreateServerRequest.builder()
createServerRequest
- A Consumer
that will call methods on CreateServerRequest.Builder
to create a request.default CompletableFuture<DeleteBackupResponse> deleteBackup(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.
deleteBackupRequest
- default CompletableFuture<DeleteBackupResponse> deleteBackup(Consumer<DeleteBackupRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteBackupRequest.Builder
avoiding the need to
create one manually via DeleteBackupRequest.builder()
deleteBackupRequest
- A Consumer
that will call methods on DeleteBackupRequest.Builder
to create a request.default CompletableFuture<DeleteServerResponse> deleteServer(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.
deleteServerRequest
- default CompletableFuture<DeleteServerResponse> deleteServer(Consumer<DeleteServerRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteServerRequest.Builder
avoiding the need to
create one manually via DeleteServerRequest.builder()
deleteServerRequest
- A Consumer
that will call methods on DeleteServerRequest.Builder
to create a request.default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
This operation is synchronous.
describeAccountAttributesRequest
- default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest)
Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
This operation is synchronous.
This is a convenience which creates an instance of the DescribeAccountAttributesRequest.Builder
avoiding
the need to create one manually via DescribeAccountAttributesRequest.builder()
describeAccountAttributesRequest
- A Consumer
that will call methods on DescribeAccountAttributesRequest.Builder
to create a
request.default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes()
Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
This operation is synchronous.
default CompletableFuture<DescribeBackupsResponse> describeBackups(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.
describeBackupsRequest
- default CompletableFuture<DescribeBackupsResponse> describeBackups(Consumer<DescribeBackupsRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeBackupsRequest.Builder
avoiding the need
to create one manually via DescribeBackupsRequest.builder()
describeBackupsRequest
- A Consumer
that will call methods on DescribeBackupsRequest.Builder
to create a request.default CompletableFuture<DescribeBackupsResponse> describeBackups()
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.
default CompletableFuture<DescribeEventsResponse> describeEvents(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.
describeEventsRequest
- default CompletableFuture<DescribeEventsResponse> describeEvents(Consumer<DescribeEventsRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder
avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest
- A Consumer
that will call methods on DescribeEventsRequest.Builder
to create a request.default CompletableFuture<DescribeNodeAssociationStatusResponse> describeNodeAssociationStatus(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.
describeNodeAssociationStatusRequest
- default CompletableFuture<DescribeNodeAssociationStatusResponse> describeNodeAssociationStatus(Consumer<DescribeNodeAssociationStatusRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeNodeAssociationStatusRequest.Builder
avoiding the need to create one manually via DescribeNodeAssociationStatusRequest.builder()
describeNodeAssociationStatusRequest
- A Consumer
that will call methods on DescribeNodeAssociationStatusRequest.Builder
to
create a request.default CompletableFuture<DescribeServersResponse> describeServers(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.
describeServersRequest
- default CompletableFuture<DescribeServersResponse> describeServers(Consumer<DescribeServersRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeServersRequest.Builder
avoiding the need
to create one manually via DescribeServersRequest.builder()
describeServersRequest
- A Consumer
that will call methods on DescribeServersRequest.Builder
to create a request.default CompletableFuture<DescribeServersResponse> describeServers()
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.
default CompletableFuture<DisassociateNodeResponse> disassociateNode(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.
disassociateNodeRequest
- default CompletableFuture<DisassociateNodeResponse> disassociateNode(Consumer<DisassociateNodeRequest.Builder> 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.
This is a convenience which creates an instance of the DisassociateNodeRequest.Builder
avoiding the need
to create one manually via DisassociateNodeRequest.builder()
disassociateNodeRequest
- A Consumer
that will call methods on DisassociateNodeRequest.Builder
to create a request.default CompletableFuture<RestoreServerResponse> restoreServer(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.
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.
restoreServerRequest
- default CompletableFuture<RestoreServerResponse> restoreServer(Consumer<RestoreServerRequest.Builder> 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.
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.
This is a convenience which creates an instance of the RestoreServerRequest.Builder
avoiding the need to
create one manually via RestoreServerRequest.builder()
restoreServerRequest
- A Consumer
that will call methods on RestoreServerRequest.Builder
to create a request.default CompletableFuture<StartMaintenanceResponse> startMaintenance(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.
startMaintenanceRequest
- default CompletableFuture<StartMaintenanceResponse> startMaintenance(Consumer<StartMaintenanceRequest.Builder> 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.
This is a convenience which creates an instance of the StartMaintenanceRequest.Builder
avoiding the need
to create one manually via StartMaintenanceRequest.builder()
startMaintenanceRequest
- A Consumer
that will call methods on StartMaintenanceRequest.Builder
to create a request.default CompletableFuture<UpdateServerResponse> updateServer(UpdateServerRequest updateServerRequest)
Updates settings for a server.
This operation is synchronous.
updateServerRequest
- default CompletableFuture<UpdateServerResponse> updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest)
Updates settings for a server.
This operation is synchronous.
This is a convenience which creates an instance of the UpdateServerRequest.Builder
avoiding the need to
create one manually via UpdateServerRequest.builder()
updateServerRequest
- A Consumer
that will call methods on UpdateServerRequest.Builder
to create a request.default CompletableFuture<UpdateServerEngineAttributesResponse> updateServerEngineAttributes(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 private key (CHEF_PIVOTAL_KEY
), a Chef server's admin password (
CHEF_DELIVERY_ADMIN_PASSWORD
), 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.
updateServerEngineAttributesRequest
- default CompletableFuture<UpdateServerEngineAttributesResponse> updateServerEngineAttributes(Consumer<UpdateServerEngineAttributesRequest.Builder> 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 private key (CHEF_PIVOTAL_KEY
), a Chef server's admin password (
CHEF_DELIVERY_ADMIN_PASSWORD
), 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.
This is a convenience which creates an instance of the UpdateServerEngineAttributesRequest.Builder
avoiding the need to create one manually via UpdateServerEngineAttributesRequest.builder()
updateServerEngineAttributesRequest
- A Consumer
that will call methods on UpdateServerEngineAttributesRequest.Builder
to create
a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.