AWS OpsWorks CM 2016-11-01
- Client: Aws\OpsWorksCM\OpsWorksCMClient
- Service ID: opsworkscm
- Version: 2016-11-01
This page describes the parameters and results for the operations of the AWS OpsWorks CM (2016-11-01), and shows how to use the Aws\OpsWorksCM\OpsWorksCMClient object to call the described operations. This documentation is specific to the 2016-11-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- AssociateNode ( array $params = [] )
- Associates a new node with the server.
- CreateBackup ( array $params = [] )
- Creates an application-level backup of a server.
- CreateServer ( array $params = [] )
- Creates and immedately starts a new server.
- DeleteBackup ( array $params = [] )
- Deletes a backup.
- DeleteServer ( array $params = [] )
- Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance).
- DescribeAccountAttributes ( array $params = [] )
- Describes your OpsWorks-CM account attributes.
- DescribeBackups ( array $params = [] )
- Describes backups.
- DescribeEvents ( array $params = [] )
- Describes events for a specified server.
- DescribeNodeAssociationStatus ( array $params = [] )
- Returns the current status of an existing association or disassociation request.
- DescribeServers ( array $params = [] )
- Lists all configuration management servers that are identified with your account.
- DisassociateNode ( array $params = [] )
- Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes.
- ExportServerEngineAttribute ( array $params = [] )
- Exports a specified server engine attribute as a base64-encoded string.
- ListTagsForResource ( array $params = [] )
- 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.
- RestoreServer ( array $params = [] )
- Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state.
- StartMaintenance ( array $params = [] )
- Manually starts server maintenance.
- TagResource ( array $params = [] )
- Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.
- UntagResource ( array $params = [] )
- Removes specified tags from an AWS OpsWorks-CM server or backup.
- UpdateServer ( array $params = [] )
- Updates settings for a server.
- UpdateServerEngineAttributes ( array $params = [] )
- Updates engine-specific attributes on a specified server.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
Waiter name | API Operation | Delay | Max Attempts |
---|---|---|---|
NodeAssociated | DescribeNodeAssociationStatus | 15 | 15 |
Operations
AssociateNode
$result = $client->associateNode
([/* ... */]); $promise = $client->associateNodeAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->associateNode([ 'EngineAttributes' => [ // REQUIRED [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'NodeName' => '<string>', // REQUIRED 'ServerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EngineAttributes
-
- Required: Yes
- Type: Array of EngineAttribute structures
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 nameddefault
can exist. -
CHEF_NODE_PUBLIC_KEY
: A PEM-formatted public key. This key is required for thechef-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.
- NodeName
-
- Required: Yes
- Type: string
The name of the node.
- ServerName
-
- Required: Yes
- Type: string
The name of the server with which to associate the node.
Result Syntax
[ 'NodeAssociationStatusToken' => '<string>', ]
Result Details
Members
- NodeAssociationStatusToken
-
- Type: string
Contains a token which can be passed to the
DescribeNodeAssociationStatus
API call to get the status of the association request.
Errors
- InvalidStateException:
The resource is in a state that does not allow you to perform a specified action.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
CreateBackup
$result = $client->createBackup
([/* ... */]); $promise = $client->createBackupAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createBackup([ 'Description' => '<string>', 'ServerName' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- Description
-
- Type: string
A user-defined description of the backup.
- ServerName
-
- Required: Yes
- Type: string
The name of the server that you want to back up.
- Tags
-
- Type: Array of Tag structures
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.
Result Syntax
[ 'Backup' => [ 'BackupArn' => '<string>', 'BackupId' => '<string>', 'BackupType' => 'AUTOMATED|MANUAL', 'CreatedAt' => <DateTime>, 'Description' => '<string>', 'Engine' => '<string>', 'EngineModel' => '<string>', 'EngineVersion' => '<string>', 'InstanceProfileArn' => '<string>', 'InstanceType' => '<string>', 'KeyPair' => '<string>', 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'S3DataSize' => <integer>, 'S3DataUrl' => '<string>', 'S3LogUrl' => '<string>', 'SecurityGroupIds' => ['<string>', ...], 'ServerName' => '<string>', 'ServiceRoleArn' => '<string>', 'Status' => 'IN_PROGRESS|OK|FAILED|DELETING', 'StatusDescription' => '<string>', 'SubnetIds' => ['<string>', ...], 'ToolsVersion' => '<string>', 'UserArn' => '<string>', ], ]
Result Details
Members
- Backup
-
- Type: Backup structure
Backup created by request.
Errors
- InvalidStateException:
The resource is in a state that does not allow you to perform a specified action.
- LimitExceededException:
The limit of servers or backups has been reached.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
CreateServer
$result = $client->createServer
([/* ... */]); $promise = $client->createServerAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->createServer([ 'AssociatePublicIpAddress' => true || false, 'BackupId' => '<string>', 'BackupRetentionCount' => <integer>, 'CustomCertificate' => '<string>', 'CustomDomain' => '<string>', 'CustomPrivateKey' => '<string>', 'DisableAutomatedBackup' => true || false, 'Engine' => '<string>', // REQUIRED 'EngineAttributes' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'EngineModel' => '<string>', 'EngineVersion' => '<string>', 'InstanceProfileArn' => '<string>', // REQUIRED 'InstanceType' => '<string>', // REQUIRED 'KeyPair' => '<string>', 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'SecurityGroupIds' => ['<string>', ...], 'ServerName' => '<string>', // REQUIRED 'ServiceRoleArn' => '<string>', // REQUIRED 'SubnetIds' => ['<string>', ...], 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- AssociatePublicIpAddress
-
- Type: boolean
Associate a public IP address with a server that you are launching. Valid values are
true
orfalse
. The default value istrue
. - BackupId
-
- Type: string
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
- BackupRetentionCount
-
- Type: int
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
. - CustomCertificate
-
- Type: string
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
andCustomPrivateKey
. The following are requirements for theCustomCertificate
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'sNotAfter
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
.
- CustomDomain
-
- Type: string
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 generatedEndpoint
value if the server is using a custom domain. If you specify a custom domain, you must also specify values forCustomCertificate
andCustomPrivateKey
. - CustomPrivateKey
-
- Type: string
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
andCustomCertificate
. - DisableAutomatedBackup
-
- Type: boolean
Enable or disable scheduled backups. Valid values are
true
orfalse
. The default value istrue
. - Engine
-
- Required: Yes
- Type: string
The configuration management engine to use. Valid values include
ChefAutomate
andPuppet
. - EngineAttributes
-
- Type: Array of EngineAttribute structures
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.
- EngineModel
-
- Type: string
The engine model of the server. Valid values in this release include
Monolithic
for Puppet andSingle
for Chef. - EngineVersion
-
- Type: string
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 are2019
or2017
. - InstanceProfileArn
-
- Required: Yes
- Type: string
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.
- InstanceType
-
- Required: Yes
- Type: string
The Amazon EC2 instance type to use. For example,
m5.large
. - KeyPair
-
- Type: string
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.
- PreferredBackupWindow
-
- Type: string
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 as00
. 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.) - PreferredMaintenanceWindow
-
- Type: string
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 as00
. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinition
for more information.Example:
Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.) - SecurityGroupIds
-
- Type: Array of strings
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).
- ServerName
-
- Required: Yes
- Type: string
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.
- ServiceRoleArn
-
- Required: Yes
- Type: string
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.
- SubnetIds
-
- Type: Array of strings
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.
- Tags
-
- Type: Array of Tag structures
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.
Result Syntax
[ 'Server' => [ 'AssociatePublicIpAddress' => true || false, 'BackupRetentionCount' => <integer>, 'CloudFormationStackArn' => '<string>', 'CreatedAt' => <DateTime>, 'CustomDomain' => '<string>', 'DisableAutomatedBackup' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineAttributes' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'EngineModel' => '<string>', 'EngineVersion' => '<string>', 'InstanceProfileArn' => '<string>', 'InstanceType' => '<string>', 'KeyPair' => '<string>', 'MaintenanceStatus' => 'SUCCESS|FAILED', 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'SecurityGroupIds' => ['<string>', ...], 'ServerArn' => '<string>', 'ServerName' => '<string>', 'ServiceRoleArn' => '<string>', 'Status' => 'BACKING_UP|CONNECTION_LOST|CREATING|DELETING|MODIFYING|FAILED|HEALTHY|RUNNING|RESTORING|SETUP|UNDER_MAINTENANCE|UNHEALTHY|TERMINATED', 'StatusReason' => '<string>', 'SubnetIds' => ['<string>', ...], ], ]
Result Details
Members
- Server
-
- Type: Server structure
The server that is created by the request.
Errors
- LimitExceededException:
The limit of servers or backups has been reached.
- ResourceAlreadyExistsException:
The requested resource cannot be created because it already exists.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
DeleteBackup
$result = $client->deleteBackup
([/* ... */]); $promise = $client->deleteBackupAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteBackup([ 'BackupId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- BackupId
-
- Required: Yes
- Type: string
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
.
Result Syntax
[]
Result Details
Errors
- InvalidStateException:
The resource is in a state that does not allow you to perform a specified action.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
DeleteServer
$result = $client->deleteServer
([/* ... */]); $promise = $client->deleteServerAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteServer([ 'ServerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ServerName
-
- Required: Yes
- Type: string
The ID of the server to delete.
Result Syntax
[]
Result Details
Errors
- InvalidStateException:
The resource is in a state that does not allow you to perform a specified action.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
DescribeAccountAttributes
$result = $client->describeAccountAttributes
([/* ... */]); $promise = $client->describeAccountAttributesAsync
([/* ... */]);
Describes your OpsWorks-CM account attributes.
This operation is synchronous.
Parameter Syntax
$result = $client->describeAccountAttributes([ ]);
Parameter Details
Members
Result Syntax
[ 'Attributes' => [ [ 'Maximum' => <integer>, 'Name' => '<string>', 'Used' => <integer>, ], // ... ], ]
Result Details
Members
- Attributes
-
- Type: Array of AccountAttribute structures
The attributes that are currently set for the account.
Errors
There are no errors described for this operation.
DescribeBackups
$result = $client->describeBackups
([/* ... */]); $promise = $client->describeBackupsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeBackups([ 'BackupId' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', 'ServerName' => '<string>', ]);
Parameter Details
Members
- BackupId
-
- Type: string
Describes a single backup.
- MaxResults
-
- Type: int
This is not currently implemented for
DescribeBackups
requests. - NextToken
-
- Type: string
This is not currently implemented for
DescribeBackups
requests. - ServerName
-
- Type: string
Returns backups for the server with the specified ServerName.
Result Syntax
[ 'Backups' => [ [ 'BackupArn' => '<string>', 'BackupId' => '<string>', 'BackupType' => 'AUTOMATED|MANUAL', 'CreatedAt' => <DateTime>, 'Description' => '<string>', 'Engine' => '<string>', 'EngineModel' => '<string>', 'EngineVersion' => '<string>', 'InstanceProfileArn' => '<string>', 'InstanceType' => '<string>', 'KeyPair' => '<string>', 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'S3DataSize' => <integer>, 'S3DataUrl' => '<string>', 'S3LogUrl' => '<string>', 'SecurityGroupIds' => ['<string>', ...], 'ServerName' => '<string>', 'ServiceRoleArn' => '<string>', 'Status' => 'IN_PROGRESS|OK|FAILED|DELETING', 'StatusDescription' => '<string>', 'SubnetIds' => ['<string>', ...], 'ToolsVersion' => '<string>', 'UserArn' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Backups
-
- Type: Array of Backup structures
Contains the response to a
DescribeBackups
request. - NextToken
-
- Type: string
This is not currently implemented for
DescribeBackups
requests.
Errors
- ValidationException:
One or more of the provided request parameters are not valid.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- InvalidNextTokenException:
This occurs when the provided nextToken is not valid.
DescribeEvents
$result = $client->describeEvents
([/* ... */]); $promise = $client->describeEventsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeEvents([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'ServerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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 theNextToken
request parameter to get the next set of results. - NextToken
-
- Type: string
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 thenextToken
parameter. If there are no more results, the response object'snextToken
parameter value isnull
. Setting anextToken
value that was not returned in your previous results causes anInvalidNextTokenException
to occur. - ServerName
-
- Required: Yes
- Type: string
The name of the server for which you want to view events.
Result Syntax
[ 'NextToken' => '<string>', 'ServerEvents' => [ [ 'CreatedAt' => <DateTime>, 'LogUrl' => '<string>', 'Message' => '<string>', 'ServerName' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
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 thenextToken
parameter. If there are no more results, the response object'snextToken
parameter value isnull
. Setting anextToken
value that was not returned in your previous results causes anInvalidNextTokenException
to occur. - ServerEvents
-
- Type: Array of ServerEvent structures
Contains the response to a
DescribeEvents
request.
Errors
- ValidationException:
One or more of the provided request parameters are not valid.
- InvalidNextTokenException:
This occurs when the provided nextToken is not valid.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
DescribeNodeAssociationStatus
$result = $client->describeNodeAssociationStatus
([/* ... */]); $promise = $client->describeNodeAssociationStatusAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeNodeAssociationStatus([ 'NodeAssociationStatusToken' => '<string>', // REQUIRED 'ServerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- NodeAssociationStatusToken
-
- Required: Yes
- Type: string
The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.
- ServerName
-
- Required: Yes
- Type: string
The name of the server from which to disassociate the node.
Result Syntax
[ 'EngineAttributes' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'NodeAssociationStatus' => 'SUCCESS|FAILED|IN_PROGRESS', ]
Result Details
Members
- EngineAttributes
-
- Type: Array of EngineAttribute structures
Attributes specific to the node association. In Puppet, the attibute PUPPET_NODE_CERT contains the signed certificate (the result of the CSR).
- NodeAssociationStatus
-
- Type: string
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.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
DescribeServers
$result = $client->describeServers
([/* ... */]); $promise = $client->describeServersAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeServers([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'ServerName' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
This is not currently implemented for
DescribeServers
requests. - NextToken
-
- Type: string
This is not currently implemented for
DescribeServers
requests. - ServerName
-
- Type: string
Describes the server with the specified ServerName.
Result Syntax
[ 'NextToken' => '<string>', 'Servers' => [ [ 'AssociatePublicIpAddress' => true || false, 'BackupRetentionCount' => <integer>, 'CloudFormationStackArn' => '<string>', 'CreatedAt' => <DateTime>, 'CustomDomain' => '<string>', 'DisableAutomatedBackup' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineAttributes' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'EngineModel' => '<string>', 'EngineVersion' => '<string>', 'InstanceProfileArn' => '<string>', 'InstanceType' => '<string>', 'KeyPair' => '<string>', 'MaintenanceStatus' => 'SUCCESS|FAILED', 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'SecurityGroupIds' => ['<string>', ...], 'ServerArn' => '<string>', 'ServerName' => '<string>', 'ServiceRoleArn' => '<string>', 'Status' => 'BACKING_UP|CONNECTION_LOST|CREATING|DELETING|MODIFYING|FAILED|HEALTHY|RUNNING|RESTORING|SETUP|UNDER_MAINTENANCE|UNHEALTHY|TERMINATED', 'StatusReason' => '<string>', 'SubnetIds' => ['<string>', ...], ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
This is not currently implemented for
DescribeServers
requests. - Servers
-
- Type: Array of Server structures
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.
Errors
- ValidationException:
One or more of the provided request parameters are not valid.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- InvalidNextTokenException:
This occurs when the provided nextToken is not valid.
DisassociateNode
$result = $client->disassociateNode
([/* ... */]); $promise = $client->disassociateNodeAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->disassociateNode([ 'EngineAttributes' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'NodeName' => '<string>', // REQUIRED 'ServerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EngineAttributes
-
- Type: Array of EngineAttribute structures
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 nameddefault
can exist.
- NodeName
-
- Required: Yes
- Type: string
The name of the client node.
- ServerName
-
- Required: Yes
- Type: string
The name of the server from which to disassociate the node.
Result Syntax
[ 'NodeAssociationStatusToken' => '<string>', ]
Result Details
Members
- NodeAssociationStatusToken
-
- Type: string
Contains a token which can be passed to the
DescribeNodeAssociationStatus
API call to get the status of the disassociation request.
Errors
- InvalidStateException:
The resource is in a state that does not allow you to perform a specified action.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
ExportServerEngineAttribute
$result = $client->exportServerEngineAttribute
([/* ... */]); $promise = $client->exportServerEngineAttributeAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->exportServerEngineAttribute([ 'ExportAttributeName' => '<string>', // REQUIRED 'InputAttributes' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ServerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ExportAttributeName
-
- Required: Yes
- Type: string
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 theInputAttributes
list. - InputAttributes
-
- Type: Array of EngineAttribute structures
The list of engine attributes. The list type is
EngineAttribute
. AnEngineAttribute
list item is a pair that includes an attribute name and its value. For theUserdata
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.
- ServerName
-
- Required: Yes
- Type: string
The name of the server from which you are exporting the attribute.
Result Syntax
[ 'EngineAttribute' => [ 'Name' => '<string>', 'Value' => '<string>', ], 'ServerName' => '<string>', ]
Result Details
Members
- EngineAttribute
-
- Type: EngineAttribute structure
The requested engine attribute pair with attribute name and value.
- ServerName
-
- Type: string
The server name used in the request.
Errors
- ValidationException:
One or more of the provided request parameters are not valid.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- InvalidStateException:
The resource is in a state that does not allow you to perform a specified action.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listTagsForResource([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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 theNextToken
request parameter to get the next set of results. - NextToken
-
- Type: string
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 thenextToken
parameter. If there are no more results, the response object'snextToken
parameter value isnull
. Setting anextToken
value that was not returned in your previous results causes anInvalidNextTokenException
to occur. - ResourceArn
-
- Required: Yes
- Type: string
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
.
Result Syntax
[ 'NextToken' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
A token that you can use as the value of
NextToken
in subsequent calls to the API to show more results. - Tags
-
- Type: Array of Tag structures
Tags that have been applied to the resource.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
RestoreServer
$result = $client->restoreServer
([/* ... */]); $promise = $client->restoreServerAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->restoreServer([ 'BackupId' => '<string>', // REQUIRED 'InstanceType' => '<string>', 'KeyPair' => '<string>', 'ServerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- BackupId
-
- Required: Yes
- Type: string
The ID of the backup that you want to use to restore a server.
- InstanceType
-
- Type: string
The type of instance to restore. Valid values must be specified in the following format:
^([cm][34]|t2).*
For example,m5.large
. Valid values arem5.large
,r5.xlarge
, andr5.2xlarge
. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup. - KeyPair
-
- Type: string
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.
- ServerName
-
- Required: Yes
- Type: string
The name of the server that you want to restore.
Result Syntax
[ 'Server' => [ 'AssociatePublicIpAddress' => true || false, 'BackupRetentionCount' => <integer>, 'CloudFormationStackArn' => '<string>', 'CreatedAt' => <DateTime>, 'CustomDomain' => '<string>', 'DisableAutomatedBackup' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineAttributes' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'EngineModel' => '<string>', 'EngineVersion' => '<string>', 'InstanceProfileArn' => '<string>', 'InstanceType' => '<string>', 'KeyPair' => '<string>', 'MaintenanceStatus' => 'SUCCESS|FAILED', 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'SecurityGroupIds' => ['<string>', ...], 'ServerArn' => '<string>', 'ServerName' => '<string>', 'ServiceRoleArn' => '<string>', 'Status' => 'BACKING_UP|CONNECTION_LOST|CREATING|DELETING|MODIFYING|FAILED|HEALTHY|RUNNING|RESTORING|SETUP|UNDER_MAINTENANCE|UNHEALTHY|TERMINATED', 'StatusReason' => '<string>', 'SubnetIds' => ['<string>', ...], ], ]
Result Details
Members
- Server
-
- Type: Server structure
Describes a configuration management server.
Errors
- InvalidStateException:
The resource is in a state that does not allow you to perform a specified action.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
StartMaintenance
$result = $client->startMaintenance
([/* ... */]); $promise = $client->startMaintenanceAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->startMaintenance([ 'EngineAttributes' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ServerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EngineAttributes
-
- Type: Array of EngineAttribute structures
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 aStartMaintenance
request and set the value totrue
to upgrade the server to Chef Automate 2. For more information, see Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2.
- ServerName
-
- Required: Yes
- Type: string
The name of the server on which to run maintenance.
Result Syntax
[ 'Server' => [ 'AssociatePublicIpAddress' => true || false, 'BackupRetentionCount' => <integer>, 'CloudFormationStackArn' => '<string>', 'CreatedAt' => <DateTime>, 'CustomDomain' => '<string>', 'DisableAutomatedBackup' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineAttributes' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'EngineModel' => '<string>', 'EngineVersion' => '<string>', 'InstanceProfileArn' => '<string>', 'InstanceType' => '<string>', 'KeyPair' => '<string>', 'MaintenanceStatus' => 'SUCCESS|FAILED', 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'SecurityGroupIds' => ['<string>', ...], 'ServerArn' => '<string>', 'ServerName' => '<string>', 'ServiceRoleArn' => '<string>', 'Status' => 'BACKING_UP|CONNECTION_LOST|CREATING|DELETING|MODIFYING|FAILED|HEALTHY|RUNNING|RESTORING|SETUP|UNDER_MAINTENANCE|UNHEALTHY|TERMINATED', 'StatusReason' => '<string>', 'SubnetIds' => ['<string>', ...], ], ]
Result Details
Members
- Server
-
- Type: Server structure
Contains the response to a
StartMaintenance
request.
Errors
- InvalidStateException:
The resource is in a state that does not allow you to perform a specified action.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.
Parameter Syntax
$result = $client->tagResource([ 'ResourceArn' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
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
. - Tags
-
- Required: Yes
- Type: Array of Tag structures
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.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
- InvalidStateException:
The resource is in a state that does not allow you to perform a specified action.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes specified tags from an AWS OpsWorks-CM server or backup.
Parameter Syntax
$result = $client->untagResource([ 'ResourceArn' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
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
. - TagKeys
-
- Required: Yes
- Type: Array of strings
The keys of tags that you want to remove.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
- InvalidStateException:
The resource is in a state that does not allow you to perform a specified action.
UpdateServer
$result = $client->updateServer
([/* ... */]); $promise = $client->updateServerAsync
([/* ... */]);
Updates settings for a server.
This operation is synchronous.
Parameter Syntax
$result = $client->updateServer([ 'BackupRetentionCount' => <integer>, 'DisableAutomatedBackup' => true || false, 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'ServerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- BackupRetentionCount
-
- Type: int
Sets the number of automated backups that you want to keep.
- DisableAutomatedBackup
-
- Type: boolean
Setting DisableAutomatedBackup to
true
disables automated or scheduled backups. Automated backups are enabled by default. - PreferredBackupWindow
-
- Type: string
DDD:HH:MM
(weekly start time) orHH:MM
(daily start time).Time windows always use coordinated universal time (UTC). Valid strings for day of week (
DDD
) are:Mon
,Tue
,Wed
,Thr
,Fri
,Sat
, orSun
. - PreferredMaintenanceWindow
-
- Type: string
DDD:HH:MM
(weekly start time) orHH:MM
(daily start time).Time windows always use coordinated universal time (UTC). Valid strings for day of week (
DDD
) are:Mon
,Tue
,Wed
,Thr
,Fri
,Sat
, orSun
. - ServerName
-
- Required: Yes
- Type: string
The name of the server to update.
Result Syntax
[ 'Server' => [ 'AssociatePublicIpAddress' => true || false, 'BackupRetentionCount' => <integer>, 'CloudFormationStackArn' => '<string>', 'CreatedAt' => <DateTime>, 'CustomDomain' => '<string>', 'DisableAutomatedBackup' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineAttributes' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'EngineModel' => '<string>', 'EngineVersion' => '<string>', 'InstanceProfileArn' => '<string>', 'InstanceType' => '<string>', 'KeyPair' => '<string>', 'MaintenanceStatus' => 'SUCCESS|FAILED', 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'SecurityGroupIds' => ['<string>', ...], 'ServerArn' => '<string>', 'ServerName' => '<string>', 'ServiceRoleArn' => '<string>', 'Status' => 'BACKING_UP|CONNECTION_LOST|CREATING|DELETING|MODIFYING|FAILED|HEALTHY|RUNNING|RESTORING|SETUP|UNDER_MAINTENANCE|UNHEALTHY|TERMINATED', 'StatusReason' => '<string>', 'SubnetIds' => ['<string>', ...], ], ]
Result Details
Members
- Server
-
- Type: Server structure
Contains the response to a
UpdateServer
request.
Errors
- InvalidStateException:
The resource is in a state that does not allow you to perform a specified action.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
UpdateServerEngineAttributes
$result = $client->updateServerEngineAttributes
([/* ... */]); $promise = $client->updateServerEngineAttributesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateServerEngineAttributes([ 'AttributeName' => '<string>', // REQUIRED 'AttributeValue' => '<string>', 'ServerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AttributeName
-
- Required: Yes
- Type: string
The name of the engine attribute to update.
- AttributeValue
-
- Type: string
The value to set for the attribute.
- ServerName
-
- Required: Yes
- Type: string
The name of the server to update.
Result Syntax
[ 'Server' => [ 'AssociatePublicIpAddress' => true || false, 'BackupRetentionCount' => <integer>, 'CloudFormationStackArn' => '<string>', 'CreatedAt' => <DateTime>, 'CustomDomain' => '<string>', 'DisableAutomatedBackup' => true || false, 'Endpoint' => '<string>', 'Engine' => '<string>', 'EngineAttributes' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'EngineModel' => '<string>', 'EngineVersion' => '<string>', 'InstanceProfileArn' => '<string>', 'InstanceType' => '<string>', 'KeyPair' => '<string>', 'MaintenanceStatus' => 'SUCCESS|FAILED', 'PreferredBackupWindow' => '<string>', 'PreferredMaintenanceWindow' => '<string>', 'SecurityGroupIds' => ['<string>', ...], 'ServerArn' => '<string>', 'ServerName' => '<string>', 'ServiceRoleArn' => '<string>', 'Status' => 'BACKING_UP|CONNECTION_LOST|CREATING|DELETING|MODIFYING|FAILED|HEALTHY|RUNNING|RESTORING|SETUP|UNDER_MAINTENANCE|UNHEALTHY|TERMINATED', 'StatusReason' => '<string>', 'SubnetIds' => ['<string>', ...], ], ]
Result Details
Members
- Server
-
- Type: Server structure
Contains the response to an
UpdateServerEngineAttributes
request.
Errors
- InvalidStateException:
The resource is in a state that does not allow you to perform a specified action.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
- ValidationException:
One or more of the provided request parameters are not valid.
Shapes
AccountAttribute
Description
Stores account attributes.
Members
- Maximum
-
- Type: int
The maximum allowed value.
- Name
-
- Type: string
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.
- Used
-
- Type: int
The current usage, such as the current number of servers that are associated with the account.
Backup
Description
Describes a single backup.
Members
- BackupArn
-
- Type: string
The ARN of the backup.
- BackupId
-
- Type: string
The generated ID of the backup. Example:
myServerName-yyyyMMddHHmmssSSS
- BackupType
-
- Type: string
The backup type. Valid values are
automated
ormanual
. - CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time stamp when the backup was created in the database. Example:
2016-07-29T13:38:47.520Z
- Description
-
- Type: string
A user-provided description for a manual backup. This field is empty for automated backups.
- Engine
-
- Type: string
The engine type that is obtained from the server when the backup is created.
- EngineModel
-
- Type: string
The engine model that is obtained from the server when the backup is created.
- EngineVersion
-
- Type: string
The engine version that is obtained from the server when the backup is created.
- InstanceProfileArn
-
- Type: string
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.
- InstanceType
-
- Type: string
The instance type that is obtained from the server when the backup is created.
- KeyPair
-
- Type: string
The key pair that is obtained from the server when the backup is created.
- PreferredBackupWindow
-
- Type: string
The preferred backup period that is obtained from the server when the backup is created.
- PreferredMaintenanceWindow
-
- Type: string
The preferred maintenance period that is obtained from the server when the backup is created.
- S3DataSize
-
- Type: int
This field is deprecated and is no longer used.
- S3DataUrl
-
- Type: string
This field is deprecated and is no longer used.
- S3LogUrl
-
- Type: string
The Amazon S3 URL of the backup's log file.
- SecurityGroupIds
-
- Type: Array of strings
The security group IDs that are obtained from the server when the backup is created.
- ServerName
-
- Type: string
The name of the server from which the backup was made.
- ServiceRoleArn
-
- Type: string
The service role ARN that is obtained from the server when the backup is created.
- Status
-
- Type: string
The status of a backup while in progress.
- StatusDescription
-
- Type: string
An informational message about backup status.
- SubnetIds
-
- Type: Array of strings
The subnet IDs that are obtained from the server when the backup is created.
- ToolsVersion
-
- Type: string
The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
- UserArn
-
- Type: string
The IAM user ARN of the requester for manual backups. This field is empty for automated backups.
EngineAttribute
Description
A name and value pair that is specific to the engine of the server.
Members
- Name
-
- Type: string
The name of the engine attribute.
- Value
-
- Type: string
The value of the engine attribute.
InvalidNextTokenException
Description
This occurs when the provided nextToken is not valid.
Members
- Message
-
- Type: string
Error or informational message that can contain more detail about a nextToken failure.
InvalidStateException
Description
The resource is in a state that does not allow you to perform a specified action.
Members
- Message
-
- Type: string
Error or informational message that provides more detail if a resource is in a state that is not valid for performing a specified action.
LimitExceededException
Description
The limit of servers or backups has been reached.
Members
- Message
-
- Type: string
Error or informational message that the maximum allowed number of servers or backups has been exceeded.
ResourceAlreadyExistsException
Description
The requested resource cannot be created because it already exists.
Members
- Message
-
- Type: string
Error or informational message in response to a CreateServer request that a resource cannot be created because it already exists.
ResourceNotFoundException
Description
The requested resource does not exist, or access was denied.
Members
- Message
-
- Type: string
Error or informational message that can contain more detail about problems locating or accessing a resource.
Server
Description
Describes a configuration management server.
Members
- AssociatePublicIpAddress
-
- Type: boolean
Associate a public IP address with a server that you are launching.
- BackupRetentionCount
-
- Type: int
The number of automated backups to keep.
- CloudFormationStackArn
-
- Type: string
The ARN of the CloudFormation stack that was used to create the server.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time stamp of server creation. Example
2016-07-29T13:38:47.520Z
- CustomDomain
-
- Type: string
An optional public endpoint of a server, such as
https://aws.my-company.com
. You cannot access the server by using theEndpoint
value if the server has aCustomDomain
specified. - DisableAutomatedBackup
-
- Type: boolean
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
- Endpoint
-
- Type: string
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 theEndpoint
value if the server has aCustomDomain
specified. - Engine
-
- Type: string
The engine type of the server. Valid values in this release include
ChefAutomate
andPuppet
. - EngineAttributes
-
- Type: Array of EngineAttribute structures
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.
- EngineModel
-
- Type: string
The engine model of the server. Valid values in this release include
Monolithic
for Puppet andSingle
for Chef. - EngineVersion
-
- Type: string
The engine version of the server. For a Chef server, the valid value for EngineVersion is currently
2
. For a Puppet server, specify either2019
or2017
. - InstanceProfileArn
-
- Type: string
The instance profile ARN of the server.
- InstanceType
-
- Type: string
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.
- KeyPair
-
- Type: string
The key pair associated with the server.
- MaintenanceStatus
-
- Type: string
The status of the most recent server maintenance run. Shows
SUCCESS
orFAILED
. - PreferredBackupWindow
-
- Type: string
The preferred backup period specified for the server.
- PreferredMaintenanceWindow
-
- Type: string
The preferred maintenance period specified for the server.
- SecurityGroupIds
-
- Type: Array of strings
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.
- ServerArn
-
- Type: string
The ARN of the server.
- ServerName
-
- Type: string
The name of the server.
- ServiceRoleArn
-
- Type: string
The service role ARN used to create the server.
- Status
-
- Type: string
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.
- StatusReason
-
- Type: string
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).
- SubnetIds
-
- Type: Array of strings
The subnet IDs specified in a CreateServer request.
ServerEvent
Description
An event that is related to the server, such as the start of maintenance or backup.
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the event occurred.
- LogUrl
-
- Type: string
The Amazon S3 URL of the event's log file.
- Message
-
- Type: string
A human-readable informational or status message.
- ServerName
-
- Type: string
The name of the server on or for which the event occurred.
Tag
Description
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. 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.
Members
- Key
-
- Required: Yes
- Type: string
A tag key, such as
Stage
orName
. 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:+ - = . _ : /
- Value
-
- Required: Yes
- Type: string
An optional tag value, such as
Production
ortest-owcm-server
. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters:+ - = . _ : /
ValidationException
Description
One or more of the provided request parameters are not valid.
Members
- Message
-
- Type: string
Error or informational message that can contain more detail about a validation failure.