/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / opsworkscm.d.ts
opsworkscm.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {WaiterConfiguration} from '../lib/service'; 6 import {ServiceConfigurationOptions} from '../lib/service'; 7 import {ConfigBase as Config} from '../lib/config-base'; 8 interface Blob {} 9 declare class OpsWorksCM extends Service { 10 /** 11 * Constructs a service object. This object has one method for each API operation. 12 */ 13 constructor(options?: OpsWorksCM.Types.ClientConfiguration) 14 config: Config & OpsWorksCM.Types.ClientConfiguration; 15 /** 16 * 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. 17 */ 18 associateNode(params: OpsWorksCM.Types.AssociateNodeRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.AssociateNodeResponse) => void): Request<OpsWorksCM.Types.AssociateNodeResponse, AWSError>; 19 /** 20 * 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. 21 */ 22 associateNode(callback?: (err: AWSError, data: OpsWorksCM.Types.AssociateNodeResponse) => void): Request<OpsWorksCM.Types.AssociateNodeResponse, AWSError>; 23 /** 24 * 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. 25 */ 26 createBackup(params: OpsWorksCM.Types.CreateBackupRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.CreateBackupResponse) => void): Request<OpsWorksCM.Types.CreateBackupResponse, AWSError>; 27 /** 28 * 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. 29 */ 30 createBackup(callback?: (err: AWSError, data: OpsWorksCM.Types.CreateBackupResponse) => void): Request<OpsWorksCM.Types.CreateBackupResponse, AWSError>; 31 /** 32 * 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. 33 */ 34 createServer(params: OpsWorksCM.Types.CreateServerRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.CreateServerResponse) => void): Request<OpsWorksCM.Types.CreateServerResponse, AWSError>; 35 /** 36 * 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. 37 */ 38 createServer(callback?: (err: AWSError, data: OpsWorksCM.Types.CreateServerResponse) => void): Request<OpsWorksCM.Types.CreateServerResponse, AWSError>; 39 /** 40 * 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. 41 */ 42 deleteBackup(params: OpsWorksCM.Types.DeleteBackupRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DeleteBackupResponse) => void): Request<OpsWorksCM.Types.DeleteBackupResponse, AWSError>; 43 /** 44 * 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. 45 */ 46 deleteBackup(callback?: (err: AWSError, data: OpsWorksCM.Types.DeleteBackupResponse) => void): Request<OpsWorksCM.Types.DeleteBackupResponse, AWSError>; 47 /** 48 * 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. 49 */ 50 deleteServer(params: OpsWorksCM.Types.DeleteServerRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DeleteServerResponse) => void): Request<OpsWorksCM.Types.DeleteServerResponse, AWSError>; 51 /** 52 * 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. 53 */ 54 deleteServer(callback?: (err: AWSError, data: OpsWorksCM.Types.DeleteServerResponse) => void): Request<OpsWorksCM.Types.DeleteServerResponse, AWSError>; 55 /** 56 * Describes your OpsWorks-CM account attributes. This operation is synchronous. 57 */ 58 describeAccountAttributes(params: OpsWorksCM.Types.DescribeAccountAttributesRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeAccountAttributesResponse) => void): Request<OpsWorksCM.Types.DescribeAccountAttributesResponse, AWSError>; 59 /** 60 * Describes your OpsWorks-CM account attributes. This operation is synchronous. 61 */ 62 describeAccountAttributes(callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeAccountAttributesResponse) => void): Request<OpsWorksCM.Types.DescribeAccountAttributesResponse, AWSError>; 63 /** 64 * 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. 65 */ 66 describeBackups(params: OpsWorksCM.Types.DescribeBackupsRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeBackupsResponse) => void): Request<OpsWorksCM.Types.DescribeBackupsResponse, AWSError>; 67 /** 68 * 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. 69 */ 70 describeBackups(callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeBackupsResponse) => void): Request<OpsWorksCM.Types.DescribeBackupsResponse, AWSError>; 71 /** 72 * 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. 73 */ 74 describeEvents(params: OpsWorksCM.Types.DescribeEventsRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeEventsResponse) => void): Request<OpsWorksCM.Types.DescribeEventsResponse, AWSError>; 75 /** 76 * 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. 77 */ 78 describeEvents(callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeEventsResponse) => void): Request<OpsWorksCM.Types.DescribeEventsResponse, AWSError>; 79 /** 80 * 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. 81 */ 82 describeNodeAssociationStatus(params: OpsWorksCM.Types.DescribeNodeAssociationStatusRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeNodeAssociationStatusResponse) => void): Request<OpsWorksCM.Types.DescribeNodeAssociationStatusResponse, AWSError>; 83 /** 84 * 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. 85 */ 86 describeNodeAssociationStatus(callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeNodeAssociationStatusResponse) => void): Request<OpsWorksCM.Types.DescribeNodeAssociationStatusResponse, AWSError>; 87 /** 88 * 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. 89 */ 90 describeServers(params: OpsWorksCM.Types.DescribeServersRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeServersResponse) => void): Request<OpsWorksCM.Types.DescribeServersResponse, AWSError>; 91 /** 92 * 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. 93 */ 94 describeServers(callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeServersResponse) => void): Request<OpsWorksCM.Types.DescribeServersResponse, AWSError>; 95 /** 96 * 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. 97 */ 98 disassociateNode(params: OpsWorksCM.Types.DisassociateNodeRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DisassociateNodeResponse) => void): Request<OpsWorksCM.Types.DisassociateNodeResponse, AWSError>; 99 /** 100 * 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. 101 */ 102 disassociateNode(callback?: (err: AWSError, data: OpsWorksCM.Types.DisassociateNodeResponse) => void): Request<OpsWorksCM.Types.DisassociateNodeResponse, AWSError>; 103 /** 104 * 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. 105 */ 106 exportServerEngineAttribute(params: OpsWorksCM.Types.ExportServerEngineAttributeRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.ExportServerEngineAttributeResponse) => void): Request<OpsWorksCM.Types.ExportServerEngineAttributeResponse, AWSError>; 107 /** 108 * 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. 109 */ 110 exportServerEngineAttribute(callback?: (err: AWSError, data: OpsWorksCM.Types.ExportServerEngineAttributeResponse) => void): Request<OpsWorksCM.Types.ExportServerEngineAttributeResponse, AWSError>; 111 /** 112 * 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. 113 */ 114 listTagsForResource(params: OpsWorksCM.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.ListTagsForResourceResponse) => void): Request<OpsWorksCM.Types.ListTagsForResourceResponse, AWSError>; 115 /** 116 * 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. 117 */ 118 listTagsForResource(callback?: (err: AWSError, data: OpsWorksCM.Types.ListTagsForResourceResponse) => void): Request<OpsWorksCM.Types.ListTagsForResourceResponse, AWSError>; 119 /** 120 * 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. 121 */ 122 restoreServer(params: OpsWorksCM.Types.RestoreServerRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.RestoreServerResponse) => void): Request<OpsWorksCM.Types.RestoreServerResponse, AWSError>; 123 /** 124 * 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. 125 */ 126 restoreServer(callback?: (err: AWSError, data: OpsWorksCM.Types.RestoreServerResponse) => void): Request<OpsWorksCM.Types.RestoreServerResponse, AWSError>; 127 /** 128 * 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. 129 */ 130 startMaintenance(params: OpsWorksCM.Types.StartMaintenanceRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.StartMaintenanceResponse) => void): Request<OpsWorksCM.Types.StartMaintenanceResponse, AWSError>; 131 /** 132 * 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. 133 */ 134 startMaintenance(callback?: (err: AWSError, data: OpsWorksCM.Types.StartMaintenanceResponse) => void): Request<OpsWorksCM.Types.StartMaintenanceResponse, AWSError>; 135 /** 136 * Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups. 137 */ 138 tagResource(params: OpsWorksCM.Types.TagResourceRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.TagResourceResponse) => void): Request<OpsWorksCM.Types.TagResourceResponse, AWSError>; 139 /** 140 * Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups. 141 */ 142 tagResource(callback?: (err: AWSError, data: OpsWorksCM.Types.TagResourceResponse) => void): Request<OpsWorksCM.Types.TagResourceResponse, AWSError>; 143 /** 144 * Removes specified tags from an AWS OpsWorks-CM server or backup. 145 */ 146 untagResource(params: OpsWorksCM.Types.UntagResourceRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.UntagResourceResponse) => void): Request<OpsWorksCM.Types.UntagResourceResponse, AWSError>; 147 /** 148 * Removes specified tags from an AWS OpsWorks-CM server or backup. 149 */ 150 untagResource(callback?: (err: AWSError, data: OpsWorksCM.Types.UntagResourceResponse) => void): Request<OpsWorksCM.Types.UntagResourceResponse, AWSError>; 151 /** 152 * Updates settings for a server. This operation is synchronous. 153 */ 154 updateServer(params: OpsWorksCM.Types.UpdateServerRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.UpdateServerResponse) => void): Request<OpsWorksCM.Types.UpdateServerResponse, AWSError>; 155 /** 156 * Updates settings for a server. This operation is synchronous. 157 */ 158 updateServer(callback?: (err: AWSError, data: OpsWorksCM.Types.UpdateServerResponse) => void): Request<OpsWorksCM.Types.UpdateServerResponse, AWSError>; 159 /** 160 * 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. 161 */ 162 updateServerEngineAttributes(params: OpsWorksCM.Types.UpdateServerEngineAttributesRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.UpdateServerEngineAttributesResponse) => void): Request<OpsWorksCM.Types.UpdateServerEngineAttributesResponse, AWSError>; 163 /** 164 * 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. 165 */ 166 updateServerEngineAttributes(callback?: (err: AWSError, data: OpsWorksCM.Types.UpdateServerEngineAttributesResponse) => void): Request<OpsWorksCM.Types.UpdateServerEngineAttributesResponse, AWSError>; 167 /** 168 * Waits for the nodeAssociated state by periodically calling the underlying OpsWorksCM.describeNodeAssociationStatusoperation every 15 seconds (at most 15 times). Wait until node is associated or disassociated. 169 */ 170 waitFor(state: "nodeAssociated", params: OpsWorksCM.Types.DescribeNodeAssociationStatusRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeNodeAssociationStatusResponse) => void): Request<OpsWorksCM.Types.DescribeNodeAssociationStatusResponse, AWSError>; 171 /** 172 * Waits for the nodeAssociated state by periodically calling the underlying OpsWorksCM.describeNodeAssociationStatusoperation every 15 seconds (at most 15 times). Wait until node is associated or disassociated. 173 */ 174 waitFor(state: "nodeAssociated", callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeNodeAssociationStatusResponse) => void): Request<OpsWorksCM.Types.DescribeNodeAssociationStatusResponse, AWSError>; 175 } 176 declare namespace OpsWorksCM { 177 export type AWSOpsWorksCMResourceArn = string; 178 export interface AccountAttribute { 179 /** 180 * The attribute name. The following are supported attribute names. ServerLimit: The number of current servers/maximum number of servers allowed. By default, you can have a maximum of 10 servers. ManualBackupLimit: The number of current manual backups/maximum number of backups allowed. By default, you can have a maximum of 50 manual backups saved. 181 */ 182 Name?: String; 183 /** 184 * The maximum allowed value. 185 */ 186 Maximum?: Integer; 187 /** 188 * The current usage, such as the current number of servers that are associated with the account. 189 */ 190 Used?: Integer; 191 } 192 export type AccountAttributes = AccountAttribute[]; 193 export interface AssociateNodeRequest { 194 /** 195 * The name of the server with which to associate the node. 196 */ 197 ServerName: ServerName; 198 /** 199 * The name of the node. 200 */ 201 NodeName: NodeName; 202 /** 203 * Engine attributes used for associating the node. Attributes accepted in a AssociateNode request for Chef CHEF_ORGANIZATION: The Chef organization with which the node is associated. By default only one organization named default can exist. CHEF_NODE_PUBLIC_KEY: A PEM-formatted public key. This key is required for the chef-client agent to access the Chef API. Attributes accepted in a AssociateNode request for Puppet PUPPET_NODE_CSR: A PEM-formatted certificate-signing request (CSR) that is created by the node. 204 */ 205 EngineAttributes: EngineAttributes; 206 } 207 export interface AssociateNodeResponse { 208 /** 209 * Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the association request. 210 */ 211 NodeAssociationStatusToken?: NodeAssociationStatusToken; 212 } 213 export type AttributeName = string; 214 export type AttributeValue = string; 215 export interface Backup { 216 /** 217 * The ARN of the backup. 218 */ 219 BackupArn?: String; 220 /** 221 * The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS 222 */ 223 BackupId?: BackupId; 224 /** 225 * The backup type. Valid values are automated or manual. 226 */ 227 BackupType?: BackupType; 228 /** 229 * The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z 230 */ 231 CreatedAt?: Timestamp; 232 /** 233 * A user-provided description for a manual backup. This field is empty for automated backups. 234 */ 235 Description?: String; 236 /** 237 * The engine type that is obtained from the server when the backup is created. 238 */ 239 Engine?: String; 240 /** 241 * The engine model that is obtained from the server when the backup is created. 242 */ 243 EngineModel?: String; 244 /** 245 * The engine version that is obtained from the server when the backup is created. 246 */ 247 EngineVersion?: String; 248 /** 249 * The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup. 250 */ 251 InstanceProfileArn?: String; 252 /** 253 * The instance type that is obtained from the server when the backup is created. 254 */ 255 InstanceType?: String; 256 /** 257 * The key pair that is obtained from the server when the backup is created. 258 */ 259 KeyPair?: String; 260 /** 261 * The preferred backup period that is obtained from the server when the backup is created. 262 */ 263 PreferredBackupWindow?: TimeWindowDefinition; 264 /** 265 * The preferred maintenance period that is obtained from the server when the backup is created. 266 */ 267 PreferredMaintenanceWindow?: TimeWindowDefinition; 268 /** 269 * This field is deprecated and is no longer used. 270 */ 271 S3DataSize?: Integer; 272 /** 273 * This field is deprecated and is no longer used. 274 */ 275 S3DataUrl?: String; 276 /** 277 * The Amazon S3 URL of the backup's log file. 278 */ 279 S3LogUrl?: String; 280 /** 281 * The security group IDs that are obtained from the server when the backup is created. 282 */ 283 SecurityGroupIds?: Strings; 284 /** 285 * The name of the server from which the backup was made. 286 */ 287 ServerName?: ServerName; 288 /** 289 * The service role ARN that is obtained from the server when the backup is created. 290 */ 291 ServiceRoleArn?: String; 292 /** 293 * The status of a backup while in progress. 294 */ 295 Status?: BackupStatus; 296 /** 297 * An informational message about backup status. 298 */ 299 StatusDescription?: String; 300 /** 301 * The subnet IDs that are obtained from the server when the backup is created. 302 */ 303 SubnetIds?: Strings; 304 /** 305 * The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created. 306 */ 307 ToolsVersion?: String; 308 /** 309 * The IAM user ARN of the requester for manual backups. This field is empty for automated backups. 310 */ 311 UserArn?: String; 312 } 313 export type BackupId = string; 314 export type BackupRetentionCountDefinition = number; 315 export type BackupStatus = "IN_PROGRESS"|"OK"|"FAILED"|"DELETING"|string; 316 export type BackupType = "AUTOMATED"|"MANUAL"|string; 317 export type Backups = Backup[]; 318 export type Boolean = boolean; 319 export interface CreateBackupRequest { 320 /** 321 * The name of the server that you want to back up. 322 */ 323 ServerName: ServerName; 324 /** 325 * A user-defined description of the backup. 326 */ 327 Description?: String; 328 /** 329 * A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup. The key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources. 330 */ 331 Tags?: TagList; 332 } 333 export interface CreateBackupResponse { 334 /** 335 * Backup created by request. 336 */ 337 Backup?: Backup; 338 } 339 export interface CreateServerRequest { 340 /** 341 * Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true. 342 */ 343 AssociatePublicIpAddress?: Boolean; 344 /** 345 * An optional public endpoint of a server, such as https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey. 346 */ 347 CustomDomain?: CustomDomain; 348 /** 349 * A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey. The following are requirements for the CustomCertificate value: You can provide either a self-signed, custom certificate, or the full certificate chain. The certificate must be a valid X509 certificate, or a certificate chain in PEM format. The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date). The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain. The certificate must match the value of CustomPrivateKey. 350 */ 351 CustomCertificate?: CustomCertificate; 352 /** 353 * A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate. 354 */ 355 CustomPrivateKey?: CustomPrivateKey; 356 /** 357 * Enable or disable scheduled backups. Valid values are true or false. The default value is true. 358 */ 359 DisableAutomatedBackup?: Boolean; 360 /** 361 * The configuration management engine to use. Valid values include ChefAutomate and Puppet. 362 */ 363 Engine: String; 364 /** 365 * The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef. 366 */ 367 EngineModel?: String; 368 /** 369 * The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, valid values are 2019 or 2017. 370 */ 371 EngineVersion?: String; 372 /** 373 * Optional engine attributes on a specified server. Attributes accepted in a Chef createServer request: CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response. CHEF_AUTOMATE_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response. Attributes accepted in a Puppet createServer request: PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII characters. PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170. PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key. 374 */ 375 EngineAttributes?: EngineAttributes; 376 /** 377 * The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1. 378 */ 379 BackupRetentionCount?: BackupRetentionCountDefinition; 380 /** 381 * The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters. 382 */ 383 ServerName: ServerName; 384 /** 385 * The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need. 386 */ 387 InstanceProfileArn: InstanceProfileArn; 388 /** 389 * The Amazon EC2 instance type to use. For example, m5.large. 390 */ 391 InstanceType: String; 392 /** 393 * The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH. 394 */ 395 KeyPair?: KeyPair; 396 /** 397 * The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM. MM must be specified as 00. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information. Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.) 398 */ 399 PreferredMaintenanceWindow?: TimeWindowDefinition; 400 /** 401 * The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats: HH:MM for daily backups DDD:HH:MM for weekly backups MM must be specified as 00. The specified time is in coordinated universal time (UTC). The default value is a random, daily start time. Example: 08:00, which represents a daily start time of 08:00 UTC. Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.) 402 */ 403 PreferredBackupWindow?: TimeWindowDefinition; 404 /** 405 * A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds. If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone). 406 */ 407 SecurityGroupIds?: Strings; 408 /** 409 * The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need. 410 */ 411 ServiceRoleArn: ServiceRoleArn; 412 /** 413 * The IDs of subnets in which to launch the server EC2 instance. Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled. EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled. For more information about supported Amazon EC2 platforms, see Supported Platforms. 414 */ 415 SubnetIds?: Strings; 416 /** 417 * A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server. The key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @ The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @ Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server. 418 */ 419 Tags?: TagList; 420 /** 421 * If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId. 422 */ 423 BackupId?: BackupId; 424 } 425 export interface CreateServerResponse { 426 /** 427 * The server that is created by the request. 428 */ 429 Server?: Server; 430 } 431 export type CustomCertificate = string; 432 export type CustomDomain = string; 433 export type CustomPrivateKey = string; 434 export interface DeleteBackupRequest { 435 /** 436 * The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS. 437 */ 438 BackupId: BackupId; 439 } 440 export interface DeleteBackupResponse { 441 } 442 export interface DeleteServerRequest { 443 /** 444 * The ID of the server to delete. 445 */ 446 ServerName: ServerName; 447 } 448 export interface DeleteServerResponse { 449 } 450 export interface DescribeAccountAttributesRequest { 451 } 452 export interface DescribeAccountAttributesResponse { 453 /** 454 * The attributes that are currently set for the account. 455 */ 456 Attributes?: AccountAttributes; 457 } 458 export interface DescribeBackupsRequest { 459 /** 460 * Describes a single backup. 461 */ 462 BackupId?: BackupId; 463 /** 464 * Returns backups for the server with the specified ServerName. 465 */ 466 ServerName?: ServerName; 467 /** 468 * This is not currently implemented for DescribeBackups requests. 469 */ 470 NextToken?: NextToken; 471 /** 472 * This is not currently implemented for DescribeBackups requests. 473 */ 474 MaxResults?: MaxResults; 475 } 476 export interface DescribeBackupsResponse { 477 /** 478 * Contains the response to a DescribeBackups request. 479 */ 480 Backups?: Backups; 481 /** 482 * This is not currently implemented for DescribeBackups requests. 483 */ 484 NextToken?: String; 485 } 486 export interface DescribeEventsRequest { 487 /** 488 * The name of the server for which you want to view events. 489 */ 490 ServerName: ServerName; 491 /** 492 * NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur. 493 */ 494 NextToken?: NextToken; 495 /** 496 * To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results. 497 */ 498 MaxResults?: MaxResults; 499 } 500 export interface DescribeEventsResponse { 501 /** 502 * Contains the response to a DescribeEvents request. 503 */ 504 ServerEvents?: ServerEvents; 505 /** 506 * NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur. 507 */ 508 NextToken?: String; 509 } 510 export interface DescribeNodeAssociationStatusRequest { 511 /** 512 * The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse. 513 */ 514 NodeAssociationStatusToken: NodeAssociationStatusToken; 515 /** 516 * The name of the server from which to disassociate the node. 517 */ 518 ServerName: ServerName; 519 } 520 export interface DescribeNodeAssociationStatusResponse { 521 /** 522 * The status of the association or disassociation request. Possible values: SUCCESS: The association or disassociation succeeded. FAILED: The association or disassociation failed. IN_PROGRESS: The association or disassociation is still in progress. 523 */ 524 NodeAssociationStatus?: NodeAssociationStatus; 525 /** 526 * Attributes specific to the node association. In Puppet, the attibute PUPPET_NODE_CERT contains the signed certificate (the result of the CSR). 527 */ 528 EngineAttributes?: EngineAttributes; 529 } 530 export interface DescribeServersRequest { 531 /** 532 * Describes the server with the specified ServerName. 533 */ 534 ServerName?: ServerName; 535 /** 536 * This is not currently implemented for DescribeServers requests. 537 */ 538 NextToken?: NextToken; 539 /** 540 * This is not currently implemented for DescribeServers requests. 541 */ 542 MaxResults?: MaxResults; 543 } 544 export interface DescribeServersResponse { 545 /** 546 * Contains the response to a DescribeServers request. For Chef Automate servers: If DescribeServersResponse$Servers$EngineAttributes includes CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef Automate 2. To be eligible for upgrade, a server running Chef Automate 1 must have had at least one successful maintenance run after November 1, 2019. For Puppet servers: DescribeServersResponse$Servers$EngineAttributes contains the following two responses: PUPPET_API_CA_CERT, the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates. PUPPET_API_CRL, a certificate revocation list. The certificate revocation list is for internal maintenance purposes only. For more information about the Puppet certificate revocation list, see Man Page: puppet certificate_revocation_list in the Puppet documentation. 547 */ 548 Servers?: Servers; 549 /** 550 * This is not currently implemented for DescribeServers requests. 551 */ 552 NextToken?: String; 553 } 554 export interface DisassociateNodeRequest { 555 /** 556 * The name of the server from which to disassociate the node. 557 */ 558 ServerName: ServerName; 559 /** 560 * The name of the client node. 561 */ 562 NodeName: NodeName; 563 /** 564 * Engine attributes that are used for disassociating the node. No attributes are required for Puppet. Attributes required in a DisassociateNode request for Chef CHEF_ORGANIZATION: The Chef organization with which the node was associated. By default only one organization named default can exist. 565 */ 566 EngineAttributes?: EngineAttributes; 567 } 568 export interface DisassociateNodeResponse { 569 /** 570 * Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the disassociation request. 571 */ 572 NodeAssociationStatusToken?: NodeAssociationStatusToken; 573 } 574 export interface EngineAttribute { 575 /** 576 * The name of the engine attribute. 577 */ 578 Name?: EngineAttributeName; 579 /** 580 * The value of the engine attribute. 581 */ 582 Value?: EngineAttributeValue; 583 } 584 export type EngineAttributeName = string; 585 export type EngineAttributeValue = string; 586 export type EngineAttributes = EngineAttribute[]; 587 export interface ExportServerEngineAttributeRequest { 588 /** 589 * The name of the export attribute. Currently, the supported export attribute is Userdata. This exports a user data script that includes parameters and values provided in the InputAttributes list. 590 */ 591 ExportAttributeName: String; 592 /** 593 * The name of the server from which you are exporting the attribute. 594 */ 595 ServerName: ServerName; 596 /** 597 * The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are supported engine attribute names. RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored. OrganizationName In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization default. In Puppet, this parameter is ignored. NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored. NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored. 598 */ 599 InputAttributes?: EngineAttributes; 600 } 601 export interface ExportServerEngineAttributeResponse { 602 /** 603 * The requested engine attribute pair with attribute name and value. 604 */ 605 EngineAttribute?: EngineAttribute; 606 /** 607 * The server name used in the request. 608 */ 609 ServerName?: ServerName; 610 } 611 export type InstanceProfileArn = string; 612 export type Integer = number; 613 export type KeyPair = string; 614 export interface ListTagsForResourceRequest { 615 /** 616 * The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server for which you want to show applied tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE. 617 */ 618 ResourceArn: AWSOpsWorksCMResourceArn; 619 /** 620 * NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call ListTagsForResource again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur. 621 */ 622 NextToken?: NextToken; 623 /** 624 * To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results. 625 */ 626 MaxResults?: MaxResults; 627 } 628 export interface ListTagsForResourceResponse { 629 /** 630 * Tags that have been applied to the resource. 631 */ 632 Tags?: TagList; 633 /** 634 * A token that you can use as the value of NextToken in subsequent calls to the API to show more results. 635 */ 636 NextToken?: NextToken; 637 } 638 export type MaintenanceStatus = "SUCCESS"|"FAILED"|string; 639 export type MaxResults = number; 640 export type NextToken = string; 641 export type NodeAssociationStatus = "SUCCESS"|"FAILED"|"IN_PROGRESS"|string; 642 export type NodeAssociationStatusToken = string; 643 export type NodeName = string; 644 export interface RestoreServerRequest { 645 /** 646 * The ID of the backup that you want to use to restore a server. 647 */ 648 BackupId: BackupId; 649 /** 650 * The name of the server that you want to restore. 651 */ 652 ServerName: ServerName; 653 /** 654 * The type of instance to restore. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large, r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup. 655 */ 656 InstanceType?: String; 657 /** 658 * The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key. 659 */ 660 KeyPair?: KeyPair; 661 } 662 export interface RestoreServerResponse { 663 Server?: Server; 664 } 665 export interface Server { 666 /** 667 * Associate a public IP address with a server that you are launching. 668 */ 669 AssociatePublicIpAddress?: Boolean; 670 /** 671 * The number of automated backups to keep. 672 */ 673 BackupRetentionCount?: Integer; 674 /** 675 * The name of the server. 676 */ 677 ServerName?: String; 678 /** 679 * Time stamp of server creation. Example 2016-07-29T13:38:47.520Z 680 */ 681 CreatedAt?: Timestamp; 682 /** 683 * The ARN of the CloudFormation stack that was used to create the server. 684 */ 685 CloudFormationStackArn?: String; 686 /** 687 * An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified. 688 */ 689 CustomDomain?: CustomDomain; 690 /** 691 * Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount. 692 */ 693 DisableAutomatedBackup?: Boolean; 694 /** 695 * A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified. 696 */ 697 Endpoint?: String; 698 /** 699 * The engine type of the server. Valid values in this release include ChefAutomate and Puppet. 700 */ 701 Engine?: String; 702 /** 703 * The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef. 704 */ 705 EngineModel?: String; 706 /** 707 * The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer(). Attributes returned in a createServer response for Chef CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands. Attributes returned in a createServer response for Puppet PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online. 708 */ 709 EngineAttributes?: EngineAttributes; 710 /** 711 * The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017. 712 */ 713 EngineVersion?: String; 714 /** 715 * The instance profile ARN of the server. 716 */ 717 InstanceProfileArn?: String; 718 /** 719 * The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console. 720 */ 721 InstanceType?: String; 722 /** 723 * The key pair associated with the server. 724 */ 725 KeyPair?: String; 726 /** 727 * The status of the most recent server maintenance run. Shows SUCCESS or FAILED. 728 */ 729 MaintenanceStatus?: MaintenanceStatus; 730 /** 731 * The preferred maintenance period specified for the server. 732 */ 733 PreferredMaintenanceWindow?: TimeWindowDefinition; 734 /** 735 * The preferred backup period specified for the server. 736 */ 737 PreferredBackupWindow?: TimeWindowDefinition; 738 /** 739 * The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console. 740 */ 741 SecurityGroupIds?: Strings; 742 /** 743 * The service role ARN used to create the server. 744 */ 745 ServiceRoleArn?: String; 746 /** 747 * The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state. 748 */ 749 Status?: ServerStatus; 750 /** 751 * Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results). 752 */ 753 StatusReason?: String; 754 /** 755 * The subnet IDs specified in a CreateServer request. 756 */ 757 SubnetIds?: Strings; 758 /** 759 * The ARN of the server. 760 */ 761 ServerArn?: String; 762 } 763 export interface ServerEvent { 764 /** 765 * The time when the event occurred. 766 */ 767 CreatedAt?: Timestamp; 768 /** 769 * The name of the server on or for which the event occurred. 770 */ 771 ServerName?: String; 772 /** 773 * A human-readable informational or status message. 774 */ 775 Message?: String; 776 /** 777 * The Amazon S3 URL of the event's log file. 778 */ 779 LogUrl?: String; 780 } 781 export type ServerEvents = ServerEvent[]; 782 export type ServerName = string; 783 export type ServerStatus = "BACKING_UP"|"CONNECTION_LOST"|"CREATING"|"DELETING"|"MODIFYING"|"FAILED"|"HEALTHY"|"RUNNING"|"RESTORING"|"SETUP"|"UNDER_MAINTENANCE"|"UNHEALTHY"|"TERMINATED"|string; 784 export type Servers = Server[]; 785 export type ServiceRoleArn = string; 786 export interface StartMaintenanceRequest { 787 /** 788 * The name of the server on which to run maintenance. 789 */ 790 ServerName: ServerName; 791 /** 792 * Engine attributes that are specific to the server on which you want to run maintenance. Attributes accepted in a StartMaintenance request for Chef CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade to Chef Automate 2, add this engine attribute to a StartMaintenance request and set the value to true to upgrade the server to Chef Automate 2. For more information, see Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2. 793 */ 794 EngineAttributes?: EngineAttributes; 795 } 796 export interface StartMaintenanceResponse { 797 /** 798 * Contains the response to a StartMaintenance request. 799 */ 800 Server?: Server; 801 } 802 export type String = string; 803 export type Strings = String[]; 804 export interface Tag { 805 /** 806 * A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / 807 */ 808 Key: TagKey; 809 /** 810 * An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / 811 */ 812 Value: TagValue; 813 } 814 export type TagKey = string; 815 export type TagKeyList = TagKey[]; 816 export type TagList = Tag[]; 817 export interface TagResourceRequest { 818 /** 819 * The Amazon Resource Number (ARN) of a resource to which you want to apply tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE. 820 */ 821 ResourceArn: AWSOpsWorksCMResourceArn; 822 /** 823 * A map that contains tag keys and tag values to attach to AWS OpsWorks-CM servers or backups. The key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server or backup. 824 */ 825 Tags: TagList; 826 } 827 export interface TagResourceResponse { 828 } 829 export type TagValue = string; 830 export type TimeWindowDefinition = string; 831 export type Timestamp = Date; 832 export interface UntagResourceRequest { 833 /** 834 * The Amazon Resource Number (ARN) of a resource from which you want to remove tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE. 835 */ 836 ResourceArn: AWSOpsWorksCMResourceArn; 837 /** 838 * The keys of tags that you want to remove. 839 */ 840 TagKeys: TagKeyList; 841 } 842 export interface UntagResourceResponse { 843 } 844 export interface UpdateServerEngineAttributesRequest { 845 /** 846 * The name of the server to update. 847 */ 848 ServerName: ServerName; 849 /** 850 * The name of the engine attribute to update. 851 */ 852 AttributeName: AttributeName; 853 /** 854 * The value to set for the attribute. 855 */ 856 AttributeValue?: AttributeValue; 857 } 858 export interface UpdateServerEngineAttributesResponse { 859 /** 860 * Contains the response to an UpdateServerEngineAttributes request. 861 */ 862 Server?: Server; 863 } 864 export interface UpdateServerRequest { 865 /** 866 * Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups are enabled by default. 867 */ 868 DisableAutomatedBackup?: Boolean; 869 /** 870 * Sets the number of automated backups that you want to keep. 871 */ 872 BackupRetentionCount?: Integer; 873 /** 874 * The name of the server to update. 875 */ 876 ServerName: ServerName; 877 PreferredMaintenanceWindow?: TimeWindowDefinition; 878 PreferredBackupWindow?: TimeWindowDefinition; 879 } 880 export interface UpdateServerResponse { 881 /** 882 * Contains the response to a UpdateServer request. 883 */ 884 Server?: Server; 885 } 886 /** 887 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 888 */ 889 export type apiVersion = "2016-11-01"|"latest"|string; 890 export interface ClientApiVersions { 891 /** 892 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 893 */ 894 apiVersion?: apiVersion; 895 } 896 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 897 /** 898 * Contains interfaces for use with the OpsWorksCM client. 899 */ 900 export import Types = OpsWorksCM; 901 } 902 export = OpsWorksCM;