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 <c>knife bootstrap</c>. </para><para> Example (Chef): <c>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>"</c></para><para> On a Puppet server, this command is an alternative to the <c>puppet cert sign</c> command that signs a Puppet node CSR. </para><para> Example (Puppet): <c>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>"</c></para><para> A node can can only be associated with servers that are in a <c>HEALTHY</c> state. Otherwise, an <c>InvalidStateException</c> is thrown. A <c>ResourceNotFoundException</c> is thrown when the server does not exist. A <c>ValidationException</c> 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> <para>Engine attributes used for associating the node. </para><para><b>Attributes accepted in a AssociateNode request for Chef</b></para><ul><li><para><c>CHEF_ORGANIZATION</c>: The Chef organization with which the node is associated. By default only one organization named <c>default</c> can exist. </para></li><li><para><c>CHEF_NODE_PUBLIC_KEY</c>: A PEM-formatted public key. This key is required for the <c>chef-client</c> agent to access the Chef API. </para></li></ul><para><b>Attributes accepted in a AssociateNode request for Puppet</b></para><ul><li><para><c>PUPPET_NODE_CSR</c>: A PEM-formatted certificate-signing request (CSR) that is created by the node. </para></li></ul> </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NodeAssociationStatusToken'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.AssociateNodeResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.AssociateNodeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.AddOWCMNodeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </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.AddOWCMResourceTagCmdlet"> <summary> Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.AddOWCMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of a resource to which you want to apply tags. For example, <c>arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.AddOWCMResourceTagCmdlet.Tag"> <summary> <para> <para>A map that contains tag keys and tag values to attach to AWS OpsWorks-CM servers or backups.</para><ul><li><para>The key cannot be empty.</para></li><li><para>The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: <c>+ - = . _ : /</c></para></li><li><para>The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: <c>+ - = . _ : /</c></para></li><li><para>Leading and trailing white spaces are trimmed from both the key and value.</para></li><li><para>A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server or backup.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.AddOWCMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.AddOWCMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.AddOWCMResourceTagCmdlet.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 <c>ValidationException</c> is raised when parameters of the request are not valid. A <c>ResourceNotFoundException</c> is thrown when the server does not exist. An <c>InvalidStateException</c> 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 <c>Userdata</c>. This exports a user data script that includes parameters and values provided in the <c>InputAttributes</c> 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 <c>EngineAttribute</c>. An <c>EngineAttribute</c> list item is a pair that includes an attribute name and its value. For the <c>Userdata</c> 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 <c>default</c>. 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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.ExportServerEngineAttributeResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.ExportServerEngineAttributeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.ExportOWCMServerEngineAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </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="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMAccountAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.DescribeAccountAttributesResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.DescribeAccountAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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 <c>ResourceNotFoundException</c> is thrown when the backup does not exist. A <c>ValidationException</c> is raised when parameters of the request are not valid. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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 <c>DescribeBackups</c> requests.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMBackupListCmdlet.NextToken"> <summary> <para> <para>This is not currently implemented for <c>DescribeBackups</c> 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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMBackupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Backups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.DescribeBackupsResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.DescribeBackupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMBackupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMBackupListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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 <c>ResourceNotFoundException</c> is thrown when the server does not exist. A <c>ValidationException</c> is raised when parameters of the request are not valid. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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 <c>NextToken</c> value that you can assign to the <c>NextToken</c> request parameter to get the next set of results. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </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 <c>DescribeEvents</c> again, and assign the token from the previous results as the value of the <c>nextToken</c> parameter. If there are no more results, the response object's <c>nextToken</c> parameter value is <c>null</c>. Setting a <c>nextToken</c> value that was not returned in your previous results causes an <c>InvalidNextTokenException</c> 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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMEventListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServerEvents'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.DescribeEventsResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.DescribeEventsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMEventListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMEventListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMNodeAssociationStatusCmdlet"> <summary> Returns the current status of an existing association or disassociation request. <para> A <c>ResourceNotFoundException</c> is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A <c>ValidationException</c> 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="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMNodeAssociationStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.DescribeNodeAssociationStatusResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.DescribeNodeAssociationStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMNodeAssociationStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMResourceTagCmdlet"> <summary> 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.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>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, <c>arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMResourceTagCmdlet.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 <c>NextToken</c> value that you can assign to the <c>NextToken</c> request parameter to get the next set of results.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMResourceTagCmdlet.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 <c>ListTagsForResource</c> again, and assign the token from the previous results as the value of the <c>nextToken</c> parameter. If there are no more results, the response object's <c>nextToken</c> parameter value is <c>null</c>. Setting a <c>nextToken</c> value that was not returned in your previous results causes an <c>InvalidNextTokenException</c> 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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMResourceTagCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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 <c>ResourceNotFoundException</c> is thrown when the server does not exist. A <c>ValidationException</c> is raised when parameters of the request are not valid. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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 <c>DescribeServers</c> requests. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMServerListCmdlet.NextToken"> <summary> <para> <para>This is not currently implemented for <c>DescribeServers</c> 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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMServerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Servers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.DescribeServersResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.DescribeServersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMServerListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.GetOWCMServerListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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 <c>BACKING_UP</c> state, the server cannot be changed, and no additional backup can be created. <para> Backups can be created for servers in <c>RUNNING</c>, <c>HEALTHY</c>, and <c>UNHEALTHY</c> states. By default, you can create a maximum of 50 manual backups. </para><para> This operation is asynchronous. </para><para> A <c>LimitExceededException</c> is thrown when the maximum number of manual backups is reached. An <c>InvalidStateException</c> is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A <c>ResourceNotFoundException</c> is thrown when the server is not found. A <c>ValidationException</c> 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.Tag"> <summary> <para> <para>A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.</para><ul><li><para>The key cannot be empty.</para></li><li><para>The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: <c>+ - = . _ : /</c></para></li><li><para>The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: <c>+ - = . _ : /</c></para></li><li><para>Leading and trailing white spaces are trimmed from both the key and value.</para></li><li><para>A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMBackupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Backup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.CreateBackupResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.CreateBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMBackupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </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 <c>HEALTHY</c> state. By default, you can create a maximum of 10 servers. <para> This operation is asynchronous. </para><para> A <c>LimitExceededException</c> is thrown when you have created the maximum number of servers (10). A <c>ResourceAlreadyExistsException</c> is thrown when a server with the same name already exists in the account. A <c>ResourceNotFoundException</c> is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A <c>ValidationException</c> is thrown when parameters of the request are not valid. </para><para> If you do not specify a security group by adding the <c>SecurityGroupIds</c> 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><para> To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for <c>CustomDomain</c>, <c>CustomCertificate</c>, and <c>CustomPrivateKey</c>. </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 <c>true</c> or <c>false</c>. The default value is <c>true</c>. </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 <c>1</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.CustomCertificate"> <summary> <para> <para>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 <c>CustomDomain</c> and <c>CustomPrivateKey</c>. The following are requirements for the <c>CustomCertificate</c> value:</para><ul><li><para>You can provide either a self-signed, custom certificate, or the full certificate chain.</para></li><li><para>The certificate must be a valid X509 certificate, or a certificate chain in PEM format.</para></li><li><para>The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's <c>NotBefore</c> date), or after it expires (the certificate's <c>NotAfter</c> date).</para></li><li><para>The certificate’s common name or subject alternative names (SANs), if present, must match the value of <c>CustomDomain</c>.</para></li><li><para>The certificate must match the value of <c>CustomPrivateKey</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.CustomDomain"> <summary> <para> <para>An optional public endpoint of a server, such as <c>https://aws.my-company.com</c>. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated <c>Endpoint</c> value if the server is using a custom domain. If you specify a custom domain, you must also specify values for <c>CustomCertificate</c> and <c>CustomPrivateKey</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.CustomPrivateKey"> <summary> <para> <para>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 <c>CustomDomain</c> and <c>CustomCertificate</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.DisableAutomatedBackup"> <summary> <para> <para> Enable or disable scheduled backups. Valid values are <c>true</c> or <c>false</c>. The default value is <c>true</c>. </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 <c>ChefAutomate</c> and <c>Puppet</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.EngineAttribute"> <summary> <para> <para>Optional engine attributes on a specified server. </para><para><b>Attributes accepted in a Chef createServer request:</b></para><ul><li><para><c>CHEF_AUTOMATE_PIVOTAL_KEY</c>: 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. </para></li><li><para><c>CHEF_AUTOMATE_ADMIN_PASSWORD</c>: 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.</para></li></ul><para><b>Attributes accepted in a Puppet createServer request:</b></para><ul><li><para><c>PUPPET_ADMIN_PASSWORD</c>: To work with the Puppet Enterprise console, a password must use ASCII characters.</para></li><li><para><c>PUPPET_R10K_REMOTE</c>: 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.</para></li><li><para><c>PUPPET_R10K_PRIVATE_KEY</c>: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.</para></li></ul> </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 <c>Monolithic</c> for Puppet and <c>Single</c> 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 <c>2</c>. For a Puppet server, valid values are <c>2019</c> or <c>2017</c>. </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, <c>m5.large</c>. </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><c>HH:MM</c> for daily backups</para></li><li><para><c>DDD:HH:MM</c> for weekly backups</para></li></ul><para><c>MM</c> must be specified as <c>00</c>. The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.</para><para><b>Example:</b><c>08:00</c>, which represents a daily start time of 08:00 UTC.</para><para><b>Example:</b><c>Mon:08:00</c>, 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: <c>DDD:HH:MM</c>. <c>MM</c> must be specified as <c>00</c>. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See <c>TimeWindowDefinition</c> for more information. </para><para><b>Example:</b><c>Mon:08:00</c>, 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 <c>SubnetIds</c>. </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.Tag"> <summary> <para> <para>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.</para><ul><li><para>The key cannot be empty.</para></li><li><para>The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: <c>+ - = . _ : / @</c></para></li><li><para>The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: <c>+ - = . _ : / @</c></para></li><li><para>Leading and trailing white spaces are trimmed from both the key and value.</para></li><li><para>A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Server'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.CreateServerResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.CreateServerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.NewOWCMServerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </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 <c>InvalidStateException</c> is thrown when a backup deletion is already in progress. A <c>ResourceNotFoundException</c> is thrown when the backup does not exist. A <c>ValidationException</c> 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 <c>ServerName-yyyyMMddHHmmssSSS</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMBackupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.DeleteBackupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMBackupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupId parameter. The -PassThru parameter is deprecated, use -Select '^BackupId' instead. This parameter will be removed in a future version. </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 <c>HEALTHY</c> state. Otherwise, an <c>InvalidStateException</c> is thrown. A <c>ResourceNotFoundException</c> is thrown when the server does not exist. A <c>ValidationException</c> is raised when parameters of the request are not valid. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMNodeCmdlet.EngineAttribute"> <summary> <para> <para>Engine attributes that are used for disassociating the node. No attributes are required for Puppet. </para><para><b>Attributes required in a DisassociateNode request for Chef</b></para><ul><li><para><c>CHEF_ORGANIZATION</c>: The Chef organization with which the node was associated. By default only one organization named <c>default</c> can exist. </para></li></ul> </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NodeAssociationStatusToken'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.DisassociateNodeResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.DisassociateNodeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMNodeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </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.RemoveOWCMResourceTagCmdlet"> <summary> Removes specified tags from an AWS OpsWorks-CM server or backup. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of a resource from which you want to remove tags. For example, <c>arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of tags that you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMResourceTagCmdlet.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 <c>DELETING</c>. After the server is deleted, it is no longer returned by <c>DescribeServer</c> requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted. <para> This operation is asynchronous. </para><para> An <c>InvalidStateException</c> is thrown when a server deletion is already in progress. A <c>ResourceNotFoundException</c> is thrown when the server does not exist. A <c>ValidationException</c> 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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.DeleteServerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RemoveOWCMServerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </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 <c>CONNECTION_LOST</c>, <c>HEALTHY</c>, <c>RUNNING</c>, <c>UNHEALTHY</c>, or <c>TERMINATED</c> 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> Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a <c>HEALTHY</c> state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a <c>Running</c> or <c>Stopped</c> state, but is eventually terminated. </para><para> This operation is asynchronous. </para><para> An <c>InvalidStateException</c> is thrown when the server is not in a valid state. A <c>ResourceNotFoundException</c> is thrown when the server does not exist. A <c>ValidationException</c> 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 instance to restore. Valid values must be specified in the following format: <c>^([cm][34]|t2).*</c> For example, <c>m5.large</c>. Valid values are <c>m5.large</c>, <c>r5.xlarge</c>, and <c>r5.2xlarge</c>. 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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.RestoreServerResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.RestoreServerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.RestoreOWCMServerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </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 <c>UNDER_MAINTENANCE</c> state while maintenance is in progress. <para> Maintenance can only be started on servers in <c>HEALTHY</c> and <c>UNHEALTHY</c> states. Otherwise, an <c>InvalidStateException</c> is thrown. A <c>ResourceNotFoundException</c> is thrown when the server does not exist. A <c>ValidationException</c> 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><b>Attributes accepted in a StartMaintenance request for Chef</b></para><ul><li><para><c>CHEF_MAJOR_UPGRADE</c>: If a Chef Automate server is eligible for upgrade to Chef Automate 2, add this engine attribute to a <c>StartMaintenance</c> request and set the value to <c>true</c> to upgrade the server to Chef Automate 2. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opscm-a2upgrade.html">Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2</a>. </para></li></ul> </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Server'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.StartMaintenanceResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.StartMaintenanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.StartOWCMMaintenanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </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 <c>true</c> 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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Server'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.UpdateServerResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.UpdateServerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </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 <c>MODIFYING</c> 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 (<c>CHEF_PIVOTAL_KEY</c>) or a Puppet server's admin password (<c>PUPPET_ADMIN_PASSWORD</c>). <para> This operation is asynchronous. </para><para> This operation can only be called for servers in <c>HEALTHY</c> or <c>UNHEALTHY</c> states. Otherwise, an <c>InvalidStateException</c> is raised. A <c>ResourceNotFoundException</c> is thrown when the server does not exist. A <c>ValidationException</c> 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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Server'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.UpdateServerEngineAttributesResponse). Specifying the name of a property of type Amazon.OpsWorksCM.Model.UpdateServerEngineAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OWCM.UpdateOWCMServerEngineAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServerName parameter. The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. </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> |