AWS.Tools.OpsWorksCM.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.OpsWorksCM</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.AddOWCMNodeCmdlet"> <summary> Associates a new node with the server. For more information about how to disassociate a node, see <a>DisassociateNode</a>. <para> On a Chef server: This command is an alternative to <code>knife bootstrap</code>. </para><para> Example (Chef): <code>aws opsworks-cm associate-node --server-name <i>MyServer</i> --node-name <i>MyManagedNode</i> --engine-attributes "Name=<i>CHEF_ORGANIZATION</i>,Value=default" "Name=<i>CHEF_NODE_PUBLIC_KEY</i>,Value=<i>public-key-pem</i>"</code></para><para> On a Puppet server, this command is an alternative to the <code>puppet cert sign</code> command that signs a Puppet node CSR. </para><para> Example (Chef): <code>aws opsworks-cm associate-node --server-name <i>MyServer</i> --node-name <i>MyManagedNode</i> --engine-attributes "Name=<i>PUPPET_NODE_CSR</i>,Value=<i>csr-pem</i>"</code></para><para> A node can can only be associated with servers that are in a <code>HEALTHY</code> state. Otherwise, an <code>InvalidStateException</code> is thrown. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.AddOWCMNodeCmdlet.EngineAttribute"> <summary> <para> Amazon.OpsWorksCM.Model.AssociateNodeRequest.EngineAttributes </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.AddOWCMNodeCmdlet.NodeName"> <summary> <para> <para>The name of the node. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.AddOWCMNodeCmdlet.ServerName"> <summary> <para> <para>The name of the server with which to associate the node. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.AddOWCMNodeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.ExportOWCMServerEngineAttributeCmdlet"> <summary> 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. <para> This operation is synchronous. </para><para> A <code>ValidationException</code> is raised when parameters of the request are not valid. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. An <code>InvalidStateException</code> is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.ExportOWCMServerEngineAttributeCmdlet.ExportAttributeName"> <summary> <para> <para>The name of the export attribute. Currently, the supported export attribute is <code>Userdata</code>. This exports a user data script that includes parameters and values provided in the <code>InputAttributes</code> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.ExportOWCMServerEngineAttributeCmdlet.InputAttribute"> <summary> <para> <para>The list of engine attributes. The list type is <code>EngineAttribute</code>. An <code>EngineAttribute</code> list item is a pair that includes an attribute name and its value. For the <code>Userdata</code> ExportAttributeName, the following are supported engine attribute names.</para><ul><li><para><b>RunList</b> In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored.</para></li><li><para><b>OrganizationName</b> In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization <code>default</code>. In Puppet, this parameter is ignored.</para></li><li><para><b>NodeEnvironment</b> In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored.</para></li><li><para><b>NodeClientVersion</b> 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.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.ExportOWCMServerEngineAttributeCmdlet.ServerName"> <summary> <para> <para>The name of the server from which you are exporting the attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.ExportOWCMServerEngineAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMAccountAttributeCmdlet"> <summary> Describes your OpsWorks-CM account attributes. <para> This operation is synchronous. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMBackupListCmdlet"> <summary> 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. <para> This operation is synchronous. </para><para> A <code>ResourceNotFoundException</code> is thrown when the backup does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMBackupListCmdlet.BackupId"> <summary> <para> <para>Describes a single backup. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMBackupListCmdlet.ServerName"> <summary> <para> <para>Returns backups for the server with the specified ServerName. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMBackupListCmdlet.MaxResult"> <summary> <para> <para>This is not currently implemented for <code>DescribeBackups</code> requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMBackupListCmdlet.NextToken"> <summary> <para> <para>This is not currently implemented for <code>DescribeBackups</code> requests.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMEventListCmdlet"> <summary> Describes events for a specified server. Results are ordered by time, with newest events first. <para> This operation is synchronous. </para><para> A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMEventListCmdlet.ServerName"> <summary> <para> <para>The name of the server for which you want to view events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMEventListCmdlet.MaxResult"> <summary> <para> <para>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 <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMEventListCmdlet.NextToken"> <summary> <para> <para>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 <code>DescribeEvents</code> again, and assign the token from the previous results as the value of the <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code> parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your previous results causes an <code>InvalidNextTokenException</code> to occur. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMNodeAssociationStatusCmdlet"> <summary> Returns the current status of an existing association or disassociation request. <para> A <code>ResourceNotFoundException</code> is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMNodeAssociationStatusCmdlet.NodeAssociationStatusToken"> <summary> <para> <para>The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMNodeAssociationStatusCmdlet.ServerName"> <summary> <para> <para>The name of the server from which to disassociate the node. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMServerListCmdlet"> <summary> 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. <para> This operation is synchronous. </para><para> A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMServerListCmdlet.ServerName"> <summary> <para> <para>Describes the server with the specified ServerName.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMServerListCmdlet.MaxResult"> <summary> <para> <para>This is not currently implemented for <code>DescribeServers</code> requests. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMServerListCmdlet.NextToken"> <summary> <para> <para>This is not currently implemented for <code>DescribeServers</code> requests. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMBackupCmdlet"> <summary> Creates an application-level backup of a server. While the server is in the <code>BACKING_UP</code> state, the server cannot be changed, and no additional backup can be created. <para> Backups can be created for servers in <code>RUNNING</code>, <code>HEALTHY</code>, and <code>UNHEALTHY</code> states. By default, you can create a maximum of 50 manual backups. </para><para> This operation is asynchronous. </para><para> A <code>LimitExceededException</code> is thrown when the maximum number of manual backups is reached. An <code>InvalidStateException</code> is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A <code>ResourceNotFoundException</code> is thrown when the server is not found. A <code>ValidationException</code> is thrown when parameters of the request are not valid. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMBackupCmdlet.Description"> <summary> <para> <para> A user-defined description of the backup. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMBackupCmdlet.ServerName"> <summary> <para> <para>The name of the server that you want to back up. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMBackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet"> <summary> Creates and immedately starts a new server. The server is ready to use when it is in the <code>HEALTHY</code> state. By default, you can create a maximum of 10 servers. <para> This operation is asynchronous. </para><para> A <code>LimitExceededException</code> is thrown when you have created the maximum number of servers (10). A <code>ResourceAlreadyExistsException</code> is thrown when a server with the same name already exists in the account. A <code>ResourceNotFoundException</code> is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A <code>ValidationException</code> is thrown when parameters of the request are not valid. </para><para> If you do not specify a security group by adding the <code>SecurityGroupIds</code> parameter, AWS OpsWorks creates a new security group. </para><para><i>Chef Automate:</i> 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. </para><para><i>Puppet Enterprise:</i> 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. </para><para> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.AssociatePublicIpAddress"> <summary> <para> <para> Associate a public IP address with a server that you are launching. Valid values are <code>true</code> or <code>false</code>. The default value is <code>true</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.BackupId"> <summary> <para> <para> If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.BackupRetentionCount"> <summary> <para> <para> 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 <code>1</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.DisableAutomatedBackup"> <summary> <para> <para> Enable or disable scheduled backups. Valid values are <code>true</code> or <code>false</code>. The default value is <code>true</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.Engine"> <summary> <para> <para> The configuration management engine to use. Valid values include <code>ChefAutomate</code> and <code>Puppet</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.EngineAttribute"> <summary> <para> Amazon.OpsWorksCM.Model.CreateServerRequest.EngineAttributes </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.EngineModel"> <summary> <para> <para> The engine model of the server. Valid values in this release include <code>Monolithic</code> for Puppet and <code>Single</code> for Chef. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.EngineVersion"> <summary> <para> <para> The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently <code>12</code>. For a Puppet server, the valid value is <code>2017</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.InstanceProfileArn"> <summary> <para> <para> 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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.InstanceType"> <summary> <para> <para> The Amazon EC2 instance type to use. For example, <code>m5.large</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.KeyPair"> <summary> <para> <para> 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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.PreferredBackupWindow"> <summary> <para> <para> 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: </para><ul><li><para><code>HH:MM</code> for daily backups</para></li><li><para><code>DDD:HH:MM</code> for weekly backups</para></li></ul><para>The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.</para><para><b>Example:</b><code>08:00</code>, which represents a daily start time of 08:00 UTC.</para><para><b>Example:</b><code>Mon:08:00</code>, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para> 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: <code>DDD:HH:MM</code>. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See <code>TimeWindowDefinition</code> for more information. </para><para><b>Example:</b><code>Mon:08:00</code>, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.) </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.SecurityGroupId"> <summary> <para> <para> 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 <code>SubnetIds</code>. </para><para> 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). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.ServerName"> <summary> <para> <para> 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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.ServiceRoleArn"> <summary> <para> <para> 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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.SubnetId"> <summary> <para> <para> The IDs of subnets in which to launch the server EC2 instance. </para><para> Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled. </para><para> 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. </para><para>For more information about supported Amazon EC2 platforms, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html">Supported Platforms</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMBackupCmdlet"> <summary> Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous. <para> An <code>InvalidStateException</code> is thrown when a backup deletion is already in progress. A <code>ResourceNotFoundException</code> is thrown when the backup does not exist. A <code>ValidationException</code> is thrown when parameters of the request are not valid. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMBackupCmdlet.BackupId"> <summary> <para> <para>The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format <code>ServerName-yyyyMMddHHmmssSSS</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMBackupCmdlet.PassThru"> <summary> Returns the value passed to the BackupId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMBackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMNodeCmdlet"> <summary> 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 <a>AssociateNode</a>. <para> A node can can only be disassociated from a server that is in a <code>HEALTHY</code> state. Otherwise, an <code>InvalidStateException</code> is thrown. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMNodeCmdlet.EngineAttribute"> <summary> <para> Amazon.OpsWorksCM.Model.DisassociateNodeRequest.EngineAttributes </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMNodeCmdlet.NodeName"> <summary> <para> <para>The name of the client node. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMNodeCmdlet.ServerName"> <summary> <para> <para>The name of the server from which to disassociate the node. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMNodeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMServerCmdlet"> <summary> 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 <code>DELETING</code>. After the server is deleted, it is no longer returned by <code>DescribeServer</code> requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted. <para> This operation is asynchronous. </para><para> An <code>InvalidStateException</code> is thrown when a server deletion is already in progress. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para><para></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMServerCmdlet.ServerName"> <summary> <para> <para>The ID of the server to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMServerCmdlet.PassThru"> <summary> Returns the value passed to the ServerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMServerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.RestoreOWCMServerCmdlet"> <summary> Restores a backup to a server that is in a <code>CONNECTION_LOST</code>, <code>HEALTHY</code>, <code>RUNNING</code>, <code>UNHEALTHY</code>, or <code>TERMINATED</code> 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. <para> This operation is asynchronous. </para><para> An <code>InvalidStateException</code> is thrown when the server is not in a valid state. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RestoreOWCMServerCmdlet.BackupId"> <summary> <para> <para> The ID of the backup that you want to use to restore a server. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RestoreOWCMServerCmdlet.InstanceType"> <summary> <para> <para> The type of the instance to create. Valid values must be specified in the following format: <code>^([cm][34]|t2).*</code> For example, <code>m5.large</code>. Valid values are <code>m5.large</code>, <code>r5.xlarge</code>, and <code>r5.2xlarge</code>. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RestoreOWCMServerCmdlet.KeyPair"> <summary> <para> <para> 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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RestoreOWCMServerCmdlet.ServerName"> <summary> <para> <para> The name of the server that you want to restore. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RestoreOWCMServerCmdlet.PassThru"> <summary> Returns the value passed to the ServerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RestoreOWCMServerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.StartOWCMMaintenanceCmdlet"> <summary> 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 <code>UNDER_MAINTENANCE</code> state while maintenance is in progress. <para> Maintenance can only be started on servers in <code>HEALTHY</code> and <code>UNHEALTHY</code> states. Otherwise, an <code>InvalidStateException</code> is thrown. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.StartOWCMMaintenanceCmdlet.EngineAttribute"> <summary> <para> <para>Engine attributes that are specific to the server on which you want to run maintenance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.StartOWCMMaintenanceCmdlet.ServerName"> <summary> <para> <para>The name of the server on which to run maintenance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.StartOWCMMaintenanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerCmdlet"> <summary> Updates settings for a server. <para> This operation is synchronous. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerCmdlet.BackupRetentionCount"> <summary> <para> <para>Sets the number of automated backups that you want to keep. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerCmdlet.DisableAutomatedBackup"> <summary> <para> <para>Setting DisableAutomatedBackup to <code>true</code> disables automated or scheduled backups. Automated backups are enabled by default. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerCmdlet.PreferredBackupWindow"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerCmdlet.PreferredMaintenanceWindow"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerCmdlet.ServerName"> <summary> <para> <para>The name of the server to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerEngineAttributeCmdlet"> <summary> Updates engine-specific attributes on a specified server. The server enters the <code>MODIFYING</code> 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 (<code>CHEF_PIVOTAL_KEY</code>) or a Puppet server's admin password (<code>PUPPET_ADMIN_PASSWORD</code>). <para> This operation is asynchronous. </para><para> This operation can only be called for servers in <code>HEALTHY</code> or <code>UNHEALTHY</code> states. Otherwise, an <code>InvalidStateException</code> is raised. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerEngineAttributeCmdlet.AttributeName"> <summary> <para> <para>The name of the engine attribute to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerEngineAttributeCmdlet.AttributeValue"> <summary> <para> <para>The value to set for the attribute. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerEngineAttributeCmdlet.ServerName"> <summary> <para> <para>The name of the server to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerEngineAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |