OpsWorksCM class

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.

Constructors

OpsWorksCM({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

associateNode({required List<EngineAttribute> engineAttributes, required String nodeName, required String serverName}) → Future<AssociateNodeResponse>

Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createBackup({required String serverName, String? description, List<Tag>? tags}) → Future<CreateBackupResponse>

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.

createServer({required String engine, required String instanceProfileArn, required String instanceType, required String serverName, required String serviceRoleArn, bool? associatePublicIpAddress, String? backupId, int? backupRetentionCount, String? customCertificate, String? customDomain, String? customPrivateKey, bool? disableAutomatedBackup, List<EngineAttribute>? engineAttributes, String? engineModel, String? engineVersion, String? keyPair, String? preferredBackupWindow, String? preferredMaintenanceWindow, List<String>? securityGroupIds, List<String>? subnetIds, List<Tag>? tags}) → Future<CreateServerResponse>

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.

deleteBackup({required String backupId}) → Future<void>

Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.

deleteServer({required String serverName}) → Future<void>

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.

describeAccountAttributes() → Future<DescribeAccountAttributesResponse>

Describes your OpsWorks-CM account attributes.

describeBackups({String? backupId, int? maxResults, String? nextToken, String? serverName}) → Future<DescribeBackupsResponse>

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.

describeEvents({required String serverName, int? maxResults, String? nextToken}) → Future<DescribeEventsResponse>

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

describeNodeAssociationStatus({required String nodeAssociationStatusToken, required String serverName}) → Future<DescribeNodeAssociationStatusResponse>

Returns the current status of an existing association or disassociation request.

describeServers({int? maxResults, String? nextToken, String? serverName}) → Future<DescribeServersResponse>

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.

disassociateNode({required String nodeName, required String serverName, List<EngineAttribute>? engineAttributes}) → Future<DisassociateNodeResponse>

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.

exportServerEngineAttribute({required String exportAttributeName, required String serverName, List<EngineAttribute>? inputAttributes}) → Future<ExportServerEngineAttributeResponse>

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.

listTagsForResource({required String resourceArn, int? maxResults, String? nextToken}) → Future<ListTagsForResourceResponse>

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.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

restoreServer({required String backupId, required String serverName, String? instanceType, String? keyPair}) → Future<void>

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.

startMaintenance({required String serverName, List<EngineAttribute>? engineAttributes}) → Future<StartMaintenanceResponse>

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.

tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>

Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

Removes specified tags from an AWS OpsWorks-CM server or backup.

updateServer({required String serverName, int? backupRetentionCount, bool? disableAutomatedBackup, String? preferredBackupWindow, String? preferredMaintenanceWindow}) → Future<UpdateServerResponse>

Updates settings for a server.

updateServerEngineAttributes({required String attributeName, required String serverName, String? attributeValue}) → Future<UpdateServerEngineAttributesResponse>

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).

Operators

operator ==(Object other) → bool

The equality operator.

inherited