AWS.Tools.OpsWorks.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.OpsWorks</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticIpCmdlet"> <summary> Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling <a>RegisterElasticIp</a>. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticIpCmdlet.ElasticIp"> <summary> <para> <para>The Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticIpCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticIpCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticIpCmdlet.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.OPS.AddOPSElasticLoadBalancerCmdlet"> <summary> Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/layers-elb.html">Elastic Load Balancing</a>. <note><para> You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see <a href="https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/Welcome.html"> Elastic Load Balancing Developer Guide</a>. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticLoadBalancerCmdlet.ElasticLoadBalancerName"> <summary> <para> <para>The Elastic Load Balancing instance's name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticLoadBalancerCmdlet.LayerId"> <summary> <para> <para>The ID of the layer to which the Elastic Load Balancing instance is to be attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticLoadBalancerCmdlet.PassThru"> <summary> Returns the value passed to the ElasticLoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticLoadBalancerCmdlet.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.OPS.AddOPSResourceTagCmdlet"> <summary> Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/tagging.html">Tags</a> in the AWS OpsWorks User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The stack or layer's Amazon Resource Number (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSResourceTagCmdlet.Tag"> <summary> <para> <para>A map that contains tag keys and tag values that are attached to a stack or layer.</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: <code>+ - = . _ : /</code></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: <code>+ - = . _ : /</code></para></li><li><para>Leading and trailing white spaces are trimmed from both the key and value.</para></li><li><para>A maximum of 40 tags is allowed for any resource.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSResourceTagCmdlet.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.OPS.AddOPSVolumeCmdlet"> <summary> Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling <a>RegisterVolume</a>. After you register the volume, you must call <a>UpdateVolume</a> to specify a mount point before calling <code>AssignVolume</code>. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSVolumeCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSVolumeCmdlet.VolumeId"> <summary> <para> <para>The volume ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSVolumeCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSVolumeCmdlet.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.OPS.CopyOPSStackCmdlet"> <summary> Creates a clone of a specified stack. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html">Clone a Stack</a>. By default, all parameters are set to the values used by the parent stack. <para><b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.AgentVersion"> <summary> <para> <para>The default AWS OpsWorks Stacks agent version. You have the following options:</para><ul><li><para>Auto-update - Set this parameter to <code>LATEST</code>. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.</para></li><li><para>Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.</para></li></ul><para>The default setting is <code>LATEST</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2.</para><note><para>You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.Attribute"> <summary> <para> <para>A list of stack attributes and values as key/value pairs to be added to the cloned stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.ChefConfiguration_BerkshelfVersion"> <summary> <para> <para>The Berkshelf version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CloneAppId"> <summary> <para> <para>A list of source stack app IDs to be included in the cloned stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.ClonePermission"> <summary> <para> <para>Whether to clone the source stack's permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomJson"> <summary> <para> <para>A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:</para><para><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></para><para>For more information about custom JSON, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.DefaultAvailabilityZone"> <summary> <para> <para>The cloned stack's default Availability Zone, which must be in the specified region. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. If you also specify a value for <code>DefaultSubnetId</code>, the subnet must be in the same zone. For more information, see the <code>VpcId</code> parameter description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.DefaultInstanceProfileArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.DefaultOs"> <summary> <para> <para>The stack's operating system, which must be set to one of the following.</para><ul><li><para>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2018.03</code>, <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</para></li><li><para>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</para></li><li><para><code>CentOS Linux 7</code></para></li><li><para><code>Red Hat Enterprise Linux 7</code></para></li><li><para><code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</para></li><li><para>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</para></li></ul><para>The default option is the parent stack's operating system. For more information about supported operating systems, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>.</para><note><para>You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.DefaultRootDeviceType"> <summary> <para> <para>The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.DefaultSshKeyName"> <summary> <para> <para>A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html"> Using SSH to Communicate with an Instance</a> and <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html"> Managing SSH Access</a>. You can override this setting by specifying a different key pair, or no key pair, when you <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> create an instance</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.DefaultSubnetId"> <summary> <para> <para>The stack's default VPC subnet ID. This parameter is required if you specify a value for the <code>VpcId</code> parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for <code>DefaultAvailabilityZone</code>, the subnet must be in that zone. For information on default values and when this parameter is required, see the <code>VpcId</code> parameter description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.HostnameTheme"> <summary> <para> <para>The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, <code>HostnameTheme</code> is set to <code>Layer_Dependent</code>, which creates host names by appending integers to the layer's short name. The other themes are:</para><ul><li><para><code>Baked_Goods</code></para></li><li><para><code>Clouds</code></para></li><li><para><code>Europe_Cities</code></para></li><li><para><code>Fruits</code></para></li><li><para><code>Greek_Deities_and_Titans</code></para></li><li><para><code>Legendary_creatures_from_Japan</code></para></li><li><para><code>Planets_and_Moons</code></para></li><li><para><code>Roman_Deities</code></para></li><li><para><code>Scottish_Islands</code></para></li><li><para><code>US_Cities</code></para></li><li><para><code>Wild_Cats</code></para></li></ul><para>To obtain a generated host name, call <code>GetHostNameSuggestion</code>, which returns a host name based on the current theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.ChefConfiguration_ManageBerkshelf"> <summary> <para> <para>Whether to enable Berkshelf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.ConfigurationManager_Name"> <summary> <para> <para>The name. This parameter must be set to "Chef".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.Name"> <summary> <para> <para>The cloned stack name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomCookbooksSource_Password"> <summary> <para> <para>When included in a request, the parameter depends on the repository type.</para><ul><li><para>For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key.</para></li><li><para>For HTTP bundles and Subversion repositories, set <code>Password</code> to the password.</para></li></ul><para>For more information on how to safely handle IAM credentials, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>.</para><para>In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.StackRegion"> <summary> <para> <para>The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomCookbooksSource_Revision"> <summary> <para> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.ServiceRoleArn"> <summary> <para> <para>The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling <a>DescribePermissions</a>. For more information about IAM ARNs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para><note><para>You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.SourceStackId"> <summary> <para> <para>The source stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomCookbooksSource_SshKey"> <summary> <para> <para>In requests, the repository's SSH key.</para><para>In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomCookbooksSource_Type"> <summary> <para> <para>The repository type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomCookbooksSource_Url"> <summary> <para> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.UseCustomCookbook"> <summary> <para> <para>Whether to use custom cookbooks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.UseOpsworksSecurityGroup"> <summary> <para> <para>Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.</para><para>AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With <code>UseOpsworksSecurityGroups</code> you can instead provide your own custom security groups. <code>UseOpsworksSecurityGroups</code> has the following settings: </para><ul><li><para>True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.</para></li><li><para>False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html">Create a New Stack</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomCookbooksSource_Username"> <summary> <para> <para>This parameter depends on the repository type.</para><ul><li><para>For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID.</para></li><li><para>For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.ConfigurationManager_Version"> <summary> <para> <para>The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.</para><ul><li><para>If your account supports EC2 Classic, the default value is no VPC.</para></li><li><para>If your account does not support EC2 Classic, the default value is the default VPC for the specified region.</para></li></ul><para>If the VPC ID corresponds to a default VPC and you have specified either the <code>DefaultAvailabilityZone</code> or the <code>DefaultSubnetId</code> parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. </para><para>If you specify a nondefault VPC ID, note the following:</para><ul><li><para>It must belong to a VPC in your account that is in the specified region.</para></li><li><para>You must specify a value for <code>DefaultSubnetId</code>.</para></li></ul><para>For more information about how to use AWS OpsWorks Stacks with a VPC, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html">Running a Stack in a VPC</a>. For more information about default VPC and EC2 Classic, 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.OPS.CopyOPSStackCmdlet.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.OPS.DismountOPSElasticLoadBalancerCmdlet"> <summary> Detaches a specified Elastic Load Balancing instance from its layer. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.DismountOPSElasticLoadBalancerCmdlet.ElasticLoadBalancerName"> <summary> <para> <para>The Elastic Load Balancing instance's name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.DismountOPSElasticLoadBalancerCmdlet.LayerId"> <summary> <para> <para>The ID of the layer that the Elastic Load Balancing instance is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.DismountOPSElasticLoadBalancerCmdlet.PassThru"> <summary> Returns the value passed to the ElasticLoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.DismountOPSElasticLoadBalancerCmdlet.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.OPS.GetOPSAgentVersionCmdlet"> <summary> Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. <code>DescribeAgentVersions</code> returns a list of available agent versions for the specified stack or configuration manager. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSAgentVersionCmdlet.ConfigurationManager_Name"> <summary> <para> <para>The name. This parameter must be set to "Chef".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSAgentVersionCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSAgentVersionCmdlet.ConfigurationManager_Version"> <summary> <para> <para>The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSAppCmdlet"> <summary> Requests a description of a specified set of apps. <note><para> This call accepts only one resource-identifying parameter. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSAppCmdlet.AppId"> <summary> <para> <para>An array of app IDs for the apps to be described. If you use this parameter, <code>DescribeApps</code> returns a description of the specified apps. Otherwise, it returns a description of every app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSAppCmdlet.StackId"> <summary> <para> <para>The app stack ID. If you use this parameter, <code>DescribeApps</code> returns a description of the apps in the specified stack.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSCommandCmdlet"> <summary> Describes the results of specified commands. <note><para> This call accepts only one resource-identifying parameter. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSCommandCmdlet.CommandId"> <summary> <para> <para>An array of command IDs. If you include this parameter, <code>DescribeCommands</code> returns a description of the specified commands. Otherwise, it returns a description of every command.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSCommandCmdlet.DeploymentId"> <summary> <para> <para>The deployment ID. If you include this parameter, <code>DescribeCommands</code> returns a description of the commands associated with the specified deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSCommandCmdlet.InstanceId"> <summary> <para> <para>The instance ID. If you include this parameter, <code>DescribeCommands</code> returns a description of the commands associated with the specified instance.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSDeploymentCmdlet"> <summary> Requests a description of a specified set of deployments. <note><para> This call accepts only one resource-identifying parameter. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSDeploymentCmdlet.AppId"> <summary> <para> <para>The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSDeploymentCmdlet.DeploymentId"> <summary> <para> <para>An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSDeploymentCmdlet.StackId"> <summary> <para> <para>The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSEcsClusterCmdlet"> <summary> Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the <code>MaxResults</code> and <code>NextToken</code> parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para><para> This call accepts only one resource-identifying parameter. </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.OPS.GetOPSEcsClusterCmdlet.EcsClusterArn"> <summary> <para> <para>A list of ARNs, one for each cluster to be described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSEcsClusterCmdlet.StackId"> <summary> <para> <para>A stack ID. <code>DescribeEcsClusters</code> returns a description of the cluster that is registered with the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSEcsClusterCmdlet.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.OPS.GetOPSEcsClusterCmdlet.NextToken"> <summary> <para> <para>If the previous paginated request did not return all of the remaining results, the response object's<code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>DescribeEcsClusters</code> again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</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.OPS.GetOPSElasticIpCmdlet"> <summary> Describes <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP addresses</a>. <note><para> This call accepts only one resource-identifying parameter. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticIpCmdlet.InstanceId"> <summary> <para> <para>The instance ID. If you include this parameter, <code>DescribeElasticIps</code> returns a description of the Elastic IP addresses associated with the specified instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticIpCmdlet.Ip"> <summary> <para> <para>An array of Elastic IP addresses to be described. If you include this parameter, <code>DescribeElasticIps</code> returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticIpCmdlet.StackId"> <summary> <para> <para>A stack ID. If you include this parameter, <code>DescribeElasticIps</code> returns a description of the Elastic IP addresses that are registered with the specified stack.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticLoadBalancerCmdlet"> <summary> Describes a stack's Elastic Load Balancing instances. <note><para> This call accepts only one resource-identifying parameter. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticLoadBalancerCmdlet.LayerId"> <summary> <para> <para>A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticLoadBalancerCmdlet.StackId"> <summary> <para> <para>A stack ID. The action describes the stack's Elastic Load Balancing instances.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSHostnameSuggestionCmdlet"> <summary> Gets a generated host name for the specified layer, based on the current host name theme. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSHostnameSuggestionCmdlet.LayerId"> <summary> <para> <para>The layer ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSInstanceCmdlet"> <summary> Requests a description of a set of instances. <note><para> This call accepts only one resource-identifying parameter. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>An array of instance IDs to be described. If you use this parameter, <code>DescribeInstances</code> returns a description of the specified instances. Otherwise, it returns a description of every instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSInstanceCmdlet.LayerId"> <summary> <para> <para>A layer ID. If you use this parameter, <code>DescribeInstances</code> returns descriptions of the instances associated with the specified layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSInstanceCmdlet.StackId"> <summary> <para> <para>A stack ID. If you use this parameter, <code>DescribeInstances</code> returns descriptions of the instances associated with the specified stack.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSLayerCmdlet"> <summary> Requests a description of one or more layers in a specified stack. <note><para> This call accepts only one resource-identifying parameter. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSLayerCmdlet.LayerId"> <summary> <para> <para>An array of layer IDs that specify the layers to be described. If you omit this parameter, <code>DescribeLayers</code> returns a description of every layer in the specified stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSLayerCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSLoadBasedAutoScalingCmdlet"> <summary> Describes load-based auto scaling configurations for specified layers. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSLoadBasedAutoScalingCmdlet.LayerId"> <summary> <para> <para>An array of layer IDs.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSMyUserProfileCmdlet"> <summary> Describes a user's SSH information. <para><b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSOperatingSystemCmdlet"> <summary> Describes the operating systems that are supported by AWS OpsWorks Stacks. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSPermissionCmdlet"> <summary> Describes the permissions for a specified stack. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSPermissionCmdlet.IamUserArn"> <summary> <para> <para>The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSPermissionCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSRaidArrayCmdlet"> <summary> Describe an instance's RAID arrays. <note><para> This call accepts only one resource-identifying parameter. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSRaidArrayCmdlet.InstanceId"> <summary> <para> <para>The instance ID. If you use this parameter, <code>DescribeRaidArrays</code> returns descriptions of the RAID arrays associated with the specified instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSRaidArrayCmdlet.RaidArrayId"> <summary> <para> <para>An array of RAID array IDs. If you use this parameter, <code>DescribeRaidArrays</code> returns descriptions of the specified arrays. Otherwise, it returns a description of every array.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSRaidArrayCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSRdsDbInstanceCmdlet"> <summary> Describes Amazon RDS instances. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para><para> This call accepts only one resource-identifying parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSRdsDbInstanceCmdlet.RdsDbInstanceArn"> <summary> <para> <para>An array containing the ARNs of the instances to be described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSRdsDbInstanceCmdlet.StackId"> <summary> <para> <para>The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSResourceTagCmdlet"> <summary> Returns a list of tags that are applied to the specified stack or layer.<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.OPS.GetOPSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The stack or layer's Amazon Resource Number (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSResourceTagCmdlet.MaxResult"> <summary> <para> <para>Do not use. A validation exception occurs if you add a <code>MaxResults</code> parameter to a <code>ListTagsRequest</code> call. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSResourceTagCmdlet.NextToken"> <summary> <para> <para>Do not use. A validation exception occurs if you add a <code>NextToken</code> parameter to a <code>ListTagsRequest</code> call. </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.OPS.GetOPSServiceErrorCmdlet"> <summary> Describes AWS OpsWorks Stacks service errors. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para><para> This call accepts only one resource-identifying parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSServiceErrorCmdlet.InstanceId"> <summary> <para> <para>The instance ID. If you use this parameter, <code>DescribeServiceErrors</code> returns descriptions of the errors associated with the specified instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSServiceErrorCmdlet.ServiceErrorId"> <summary> <para> <para>An array of service error IDs. If you use this parameter, <code>DescribeServiceErrors</code> returns descriptions of the specified errors. Otherwise, it returns a description of every error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSServiceErrorCmdlet.StackId"> <summary> <para> <para>The stack ID. If you use this parameter, <code>DescribeServiceErrors</code> returns descriptions of the errors associated with the specified stack.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSStackCmdlet"> <summary> Requests a description of one or more stacks. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSStackCmdlet.StackId"> <summary> <para> <para>An array of stack IDs that specify the stacks to be described. If you omit this parameter, <code>DescribeStacks</code> returns a description of every stack.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSStackProvisioningParameterCmdlet"> <summary> Requests a description of a stack's provisioning parameters. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSStackProvisioningParameterCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSStackSummaryCmdlet"> <summary> Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as <code>running_setup</code> or <code>online</code>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSStackSummaryCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSTimeBasedAutoScalingCmdlet"> <summary> Describes time-based auto scaling configurations for specified instances. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSTimeBasedAutoScalingCmdlet.InstanceId"> <summary> <para> <para>An array of instance IDs.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSUserProfileCmdlet"> <summary> Describe specified users. <para><b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSUserProfileCmdlet.IamUserArn"> <summary> <para> <para>An array of IAM or federated user ARNs that identify the users to be described.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSVolumeCmdlet"> <summary> Describes an instance's Amazon EBS volumes. <note><para> This call accepts only one resource-identifying parameter. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSVolumeCmdlet.InstanceId"> <summary> <para> <para>The instance ID. If you use this parameter, <code>DescribeVolumes</code> returns descriptions of the volumes associated with the specified instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSVolumeCmdlet.RaidArrayId"> <summary> <para> <para>The RAID array ID. If you use this parameter, <code>DescribeVolumes</code> returns descriptions of the volumes associated with the specified RAID array.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSVolumeCmdlet.StackId"> <summary> <para> <para>A stack ID. The action describes the stack's registered Amazon EBS volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSVolumeCmdlet.VolumeId"> <summary> <para> <para>Am array of volume IDs. If you use this parameter, <code>DescribeVolumes</code> returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GrantOPSAccessCmdlet"> <summary> <note><para> This action can be used only with Windows stacks. </para></note><para> Grants RDP access to a Windows instance for a specified time period. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GrantOPSAccessCmdlet.InstanceId"> <summary> <para> <para>The instance's AWS OpsWorks Stacks ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GrantOPSAccessCmdlet.ValidForInMinute"> <summary> <para> <para>The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GrantOPSAccessCmdlet.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.OPS.NewOPSAppCmdlet"> <summary> Creates an app for a specified stack. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html">Creating Apps</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Attribute"> <summary> <para> <para>One or more user-defined key/value pairs to be added to the stack attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.SslConfiguration_Certificate"> <summary> <para> <para>The contents of the certificate's domain.crt file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.SslConfiguration_Chain"> <summary> <para> <para>Optional. Can be used to specify an intermediate certificate authority key or client authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.DataSource"> <summary> <para> <para>The app's data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Description"> <summary> <para> <para>A description of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Domain"> <summary> <para> <para>The app virtual host settings, with multiple domains separated by commas. For example: <code>'www.example.com, example.com'</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.EnableSsl"> <summary> <para> <para>Whether to enable SSL for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Environment"> <summary> <para> <para>An array of <code>EnvironmentVariable</code> objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment"> Environment Variables</a>.</para><para>There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20KB)."</para><note><para>If you have specified one or more environment variables, you cannot modify the stack's Chef version.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Name"> <summary> <para> <para>The app name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.AppSource_Password"> <summary> <para> <para>When included in a request, the parameter depends on the repository type.</para><ul><li><para>For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key.</para></li><li><para>For HTTP bundles and Subversion repositories, set <code>Password</code> to the password.</para></li></ul><para>For more information on how to safely handle IAM credentials, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>.</para><para>In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.SslConfiguration_PrivateKey"> <summary> <para> <para>The private key; the contents of the certificate's domain.kex file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.AppSource_Revision"> <summary> <para> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Shortname"> <summary> <para> <para>The app's short name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.AppSource_SshKey"> <summary> <para> <para>In requests, the repository's SSH key.</para><para>In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.AppSource_Type"> <summary> <para> <para>The repository type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Type"> <summary> <para> <para>The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify <code>other</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.AppSource_Url"> <summary> <para> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.AppSource_Username"> <summary> <para> <para>This parameter depends on the repository type.</para><ul><li><para>For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID.</para></li><li><para>For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.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.OPS.NewOPSDeploymentCmdlet"> <summary> Runs deployment or stack commands. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html">Deploying Apps</a> and <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-commands.html">Run Stack Commands</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.AppId"> <summary> <para> <para>The app ID. This parameter is required for app deployments, but not for other deployment commands.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.Command_Arg"> <summary> <para> <para>The arguments of those commands that take arguments. It should be set to a JSON object with the following format:</para><para><code>{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}</code></para><para>The <code>update_dependencies</code> command takes two arguments:</para><ul><li><para><code>upgrade_os_to</code> - Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such as <code>Amazon Linux 2016.09</code>. You must also set the <code>allow_reboot</code> argument to true.</para></li><li><para><code>allow_reboot</code> - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to either <code>true</code> or <code>false</code>. The default value is <code>false</code>.</para></li></ul><para>For example, to upgrade an instance to Amazon Linux 2016.09, set <code>Args</code> to the following.</para><para><code> { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } </code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.Comment"> <summary> <para> <para>A user-defined comment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.CustomJson"> <summary> <para> <para>A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:</para><para><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></para><para>For more information about custom JSON, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a> and <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html">Overriding Attributes With Custom JSON</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.InstanceId"> <summary> <para> <para>The instance IDs for the deployment targets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.LayerId"> <summary> <para> <para>The layer IDs for the deployment targets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.Command_Name"> <summary> <para> <para>Specifies the operation. You can specify only one command.</para><para>For stacks, the following commands are available:</para><ul><li><para><code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an <code>Args</code> parameter named <code>recipes</code> to the list of recipes to be executed. For example, to execute <code>phpapp::appsetup</code>, set <code>Args</code> to <code>{"recipes":["phpapp::appsetup"]}</code>.</para></li><li><para><code>install_dependencies</code>: Install the stack's dependencies.</para></li><li><para><code>update_custom_cookbooks</code>: Update the stack's custom cookbooks.</para></li><li><para><code>update_dependencies</code>: Update the stack's dependencies.</para></li></ul><note><para>The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.</para></note><para>For apps, the following commands are available:</para><ul><li><para><code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}.</para></li><li><para><code>rollback</code> Roll the app back to the previous version. When you update an app, AWS OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions.</para></li><li><para><code>start</code>: Start the app's web or application server.</para></li><li><para><code>stop</code>: Stop the app's web or application server.</para></li><li><para><code>restart</code>: Restart the app's web or application server.</para></li><li><para><code>undeploy</code>: Undeploy the app.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.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.OPS.NewOPSInstanceCmdlet"> <summary> Creates an instance in a specified stack. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html">Adding an Instance to a Layer</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.AgentVersion"> <summary> <para> <para>The default AWS OpsWorks Stacks agent version. You have the following options:</para><ul><li><para><code>INHERIT</code> - Use the stack's default agent version setting.</para></li><li><para><i>version_number</i> - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.</para></li></ul><para>The default setting is <code>INHERIT</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.AmiId"> <summary> <para> <para>A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</para><note><para>If you specify a custom AMI, you must set <code>Os</code> to <code>Custom</code>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.Architecture"> <summary> <para> <para>The instance architecture. The default option is <code>x86_64</code>. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.AutoScalingType"> <summary> <para> <para>For load-based or time-based instances, the type. Windows stacks can use only time-based instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.AvailabilityZone"> <summary> <para> <para>The instance Availability Zone. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.BlockDeviceMapping"> <summary> <para> <para>An array of <code>BlockDeviceMapping</code> objects that specify the instance's block devices. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block Device Mapping</a>. Note that block device mappings are not supported for custom AMIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.EbsOptimized"> <summary> <para> <para>Whether to create an Amazon EBS-optimized instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.Hostname"> <summary> <para> <para>The instance host name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.InstallUpdatesOnBoot"> <summary> <para> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. </para><note><para>We strongly recommend using the default value of <code>true</code> to ensure that your instances have the latest security updates.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.InstanceType"> <summary> <para> <para>The instance type, such as <code>t2.micro</code>. For a list of supported instance types, open the stack in the console, choose <b>Instances</b>, and choose <b>+ Instance</b>. The <b>Size</b> list contains the currently supported types. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. The parameter values that you use to specify the various types are in the <b>API Name</b> column of the <b>Available Instance Types</b> table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.LayerId"> <summary> <para> <para>An array that contains the instance's layer IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.Os"> <summary> <para> <para>The instance's operating system, which must be set to one of the following.</para><ul><li><para>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2018.03</code>, <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</para></li><li><para>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</para></li><li><para><code>CentOS Linux 7</code></para></li><li><para><code>Red Hat Enterprise Linux 7</code></para></li><li><para>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</para></li><li><para>A custom AMI: <code>Custom</code>.</para></li></ul><para>For more information about the supported operating systems, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>.</para><para>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the <a>CreateInstance</a> action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is <code>Custom</code>. For more information about supported operating systems, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating Systems</a>For more information about how to use custom AMIs with AWS OpsWorks Stacks, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.RootDeviceType"> <summary> <para> <para>The instance root device type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.SshKeyName"> <summary> <para> <para>The instance's Amazon EC2 key-pair name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.SubnetId"> <summary> <para> <para>The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.Tenancy"> <summary> <para> <para>The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: <code>dedicated</code>, <code>default</code>, or <code>host</code>. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see <a href="http://aws.amazon.com/ec2/dedicated-hosts/">Dedicated Hosts Overview</a> and <a href="http://aws.amazon.com/ec2/dedicated-hosts/">Amazon EC2 Dedicated Hosts</a>. For more information about dedicated instances, see <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html">Dedicated Instances</a> and <a href="http://aws.amazon.com/ec2/purchasing-options/dedicated-instances/">Amazon EC2 Dedicated Instances</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.VirtualizationType"> <summary> <para> <para>The instance's virtualization type, <code>paravirtual</code> or <code>hvm</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.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.OPS.NewOPSLayerCmdlet"> <summary> Creates a layer. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html">How to Create a Layer</a>. <note><para> You should use <b>CreateLayer</b> for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, <b>CreateLayer</b> fails. A stack can have an arbitrary number of custom layers, so you can call <b>CreateLayer</b> as many times as you like for that layer type. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Attribute"> <summary> <para> <para>One or more user-defined key-value pairs to be added to the stack attributes.</para><para>To create a cluster layer, set the <code>EcsClusterArn</code> attribute to the cluster's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.AutoAssignElasticIp"> <summary> <para> <para>Whether to automatically assign an <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP address</a> to the layer's instances. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.AutoAssignPublicIp"> <summary> <para> <para>For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomRecipes_Configure"> <summary> <para> <para>An array of custom recipe names to be run following a <code>configure</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomInstanceProfileArn"> <summary> <para> <para>The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomJson"> <summary> <para> <para>A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html"> Using Custom JSON</a>. This feature is supported as of version 1.7.42 of the AWS CLI. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomSecurityGroupId"> <summary> <para> <para>An array containing the layer custom security group IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Shutdown_DelayUntilElbConnectionsDrained"> <summary> <para> <para>Whether to enable Elastic Load Balancing connection draining. For more information, see <a href="https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain">Connection Draining</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomRecipes_Deploy"> <summary> <para> <para>An array of custom recipe names to be run following a <code>deploy</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.EnableAutoHealing"> <summary> <para> <para>Whether to disable auto healing for the layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CloudWatchLogsConfiguration_Enabled"> <summary> <para> <para>Whether CloudWatch Logs is enabled for a layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Shutdown_ExecutionTimeout"> <summary> <para> <para>The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.InstallUpdatesOnBoot"> <summary> <para> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. </para><note><para>To ensure that your instances have the latest security updates, we strongly recommend using the default value of <code>true</code>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CloudWatchLogsConfiguration_LogStream"> <summary> <para> <para>A list of configuration options for CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Name"> <summary> <para> <para>The layer name, which is used by the console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Package"> <summary> <para> <para>An array of <code>Package</code> objects that describes the layer packages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomRecipes_Setup"> <summary> <para> <para>An array of custom recipe names to be run following a <code>setup</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Shortname"> <summary> <para> <para>For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.</para><para>The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html">Layer Reference</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomRecipes_Shutdown"> <summary> <para> <para>An array of custom recipe names to be run following a <code>shutdown</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.StackId"> <summary> <para> <para>The layer stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Type"> <summary> <para> <para>The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomRecipes_Undeploy"> <summary> <para> <para>An array of custom recipe names to be run following a <code>undeploy</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.UseEbsOptimizedInstance"> <summary> <para> <para>Whether to use Amazon EBS-optimized instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.VolumeConfiguration"> <summary> <para> <para>A <code>VolumeConfigurations</code> object that describes the layer's Amazon EBS volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.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.OPS.NewOPSStackCmdlet"> <summary> Creates a new stack. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html">Create a New Stack</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.AgentVersion"> <summary> <para> <para>The default AWS OpsWorks Stacks agent version. You have the following options:</para><ul><li><para>Auto-update - Set this parameter to <code>LATEST</code>. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.</para></li><li><para>Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.</para></li></ul><para>The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2.</para><note><para>You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.Attribute"> <summary> <para> <para>One or more user-defined key-value pairs to be added to the stack attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.ChefConfiguration_BerkshelfVersion"> <summary> <para> <para>The Berkshelf version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomJson"> <summary> <para> <para>A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:</para><para><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></para><para>For more information about custom JSON, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.DefaultAvailabilityZone"> <summary> <para> <para>The stack's default Availability Zone, which must be in the specified region. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. If you also specify a value for <code>DefaultSubnetId</code>, the subnet must be in the same zone. For more information, see the <code>VpcId</code> parameter description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.DefaultInstanceProfileArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.DefaultOs"> <summary> <para> <para>The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.</para><ul><li><para>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2018.03</code>, <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</para></li><li><para>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</para></li><li><para><code>CentOS Linux 7</code></para></li><li><para><code>Red Hat Enterprise Linux 7</code></para></li><li><para>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</para></li><li><para>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html"> Using Custom AMIs</a>.</para></li></ul><para>The default option is the current Amazon Linux version. For more information about supported operating systems, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.DefaultRootDeviceType"> <summary> <para> <para>The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is <code>instance-store</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.DefaultSshKeyName"> <summary> <para> <para>A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html"> Using SSH to Communicate with an Instance</a> and <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html"> Managing SSH Access</a>. You can override this setting by specifying a different key pair, or no key pair, when you <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> create an instance</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.DefaultSubnetId"> <summary> <para> <para>The stack's default VPC subnet ID. This parameter is required if you specify a value for the <code>VpcId</code> parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for <code>DefaultAvailabilityZone</code>, the subnet must be in that zone. For information on default values and when this parameter is required, see the <code>VpcId</code> parameter description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.HostnameTheme"> <summary> <para> <para>The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, <code>HostnameTheme</code> is set to <code>Layer_Dependent</code>, which creates host names by appending integers to the layer's short name. The other themes are:</para><ul><li><para><code>Baked_Goods</code></para></li><li><para><code>Clouds</code></para></li><li><para><code>Europe_Cities</code></para></li><li><para><code>Fruits</code></para></li><li><para><code>Greek_Deities_and_Titans</code></para></li><li><para><code>Legendary_creatures_from_Japan</code></para></li><li><para><code>Planets_and_Moons</code></para></li><li><para><code>Roman_Deities</code></para></li><li><para><code>Scottish_Islands</code></para></li><li><para><code>US_Cities</code></para></li><li><para><code>Wild_Cats</code></para></li></ul><para>To obtain a generated host name, call <code>GetHostNameSuggestion</code>, which returns a host name based on the current theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.ChefConfiguration_ManageBerkshelf"> <summary> <para> <para>Whether to enable Berkshelf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.ConfigurationManager_Name"> <summary> <para> <para>The name. This parameter must be set to "Chef".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.Name"> <summary> <para> <para>The stack name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomCookbooksSource_Password"> <summary> <para> <para>When included in a request, the parameter depends on the repository type.</para><ul><li><para>For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key.</para></li><li><para>For HTTP bundles and Subversion repositories, set <code>Password</code> to the password.</para></li></ul><para>For more information on how to safely handle IAM credentials, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>.</para><para>In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.StackRegion"> <summary> <para> <para>The stack's AWS region, such as <code>ap-south-1</code>. For more information about Amazon regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>.</para><note><para>In the AWS CLI, this API maps to the <code>--stack-region</code> parameter. If the <code>--stack-region</code> parameter and the AWS CLI common parameter <code>--region</code> are set to the same value, the stack uses a <i>regional</i> endpoint. If the <code>--stack-region</code> parameter is not set, but the AWS CLI <code>--region</code> parameter is, this also results in a stack with a <i>regional</i> endpoint. However, if the <code>--region</code> parameter is set to <code>us-east-1</code>, and the <code>--stack-region</code> parameter is set to one of the following, then the stack uses a legacy or <i>classic</i> region: <code>us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2</code>. In this case, the actual API endpoint of the stack is in <code>us-east-1</code>. Only the preceding regions are supported as classic regions in the <code>us-east-1</code> API endpoint. Because it is a best practice to choose the regional endpoint that is closest to where you manage AWS, we recommend that you use regional endpoints for new stacks. The AWS CLI common <code>--region</code> parameter always specifies a regional API endpoint; it cannot be used to specify a classic AWS OpsWorks Stacks region.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomCookbooksSource_Revision"> <summary> <para> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.ServiceRoleArn"> <summary> <para> <para>The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomCookbooksSource_SshKey"> <summary> <para> <para>In requests, the repository's SSH key.</para><para>In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomCookbooksSource_Type"> <summary> <para> <para>The repository type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomCookbooksSource_Url"> <summary> <para> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.UseCustomCookbook"> <summary> <para> <para>Whether the stack uses custom cookbooks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.UseOpsworksSecurityGroup"> <summary> <para> <para>Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.</para><para>AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With <code>UseOpsworksSecurityGroups</code> you can instead provide your own custom security groups. <code>UseOpsworksSecurityGroups</code> has the following settings: </para><ul><li><para>True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.</para></li><li><para>False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html">Create a New Stack</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomCookbooksSource_Username"> <summary> <para> <para>This parameter depends on the repository type.</para><ul><li><para>For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID.</para></li><li><para>For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.ConfigurationManager_Version"> <summary> <para> <para>The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.</para><ul><li><para>If your account supports EC2-Classic, the default value is <code>no VPC</code>.</para></li><li><para>If your account does not support EC2-Classic, the default value is the default VPC for the specified region.</para></li></ul><para>If the VPC ID corresponds to a default VPC and you have specified either the <code>DefaultAvailabilityZone</code> or the <code>DefaultSubnetId</code> parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.</para><para>If you specify a nondefault VPC ID, note the following:</para><ul><li><para>It must belong to a VPC in your account that is in the specified region.</para></li><li><para>You must specify a value for <code>DefaultSubnetId</code>.</para></li></ul><para>For more information about how to use AWS OpsWorks Stacks with a VPC, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html">Running a Stack in a VPC</a>. For more information about default VPC and EC2-Classic, 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.OPS.NewOPSStackCmdlet.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.OPS.NewOPSUserProfileCmdlet"> <summary> Creates a new user profile. <para><b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSUserProfileCmdlet.AllowSelfManagement"> <summary> <para> <para>Whether users can specify their own SSH public key through the My Settings page. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html">Setting an IAM User's Public SSH Key</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSUserProfileCmdlet.IamUserArn"> <summary> <para> <para>The user's IAM ARN; this can also be a federated user's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSUserProfileCmdlet.SshPublicKey"> <summary> <para> <para>The user's public SSH key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSUserProfileCmdlet.SshUsername"> <summary> <para> <para>The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, <code>my.name</code> will be changed to <code>myname</code>. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSUserProfileCmdlet.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.OPS.RegisterOPSEcsClusterCmdlet"> <summary> Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html"> Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html"> Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSEcsClusterCmdlet.EcsClusterArn"> <summary> <para> <para>The cluster's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSEcsClusterCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSEcsClusterCmdlet.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.OPS.RegisterOPSElasticIpCmdlet"> <summary> Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling <a>DeregisterElasticIp</a>. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSElasticIpCmdlet.ElasticIp"> <summary> <para> <para>The Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSElasticIpCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSElasticIpCmdlet.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.OPS.RegisterOPSInstanceCmdlet"> <summary> Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack. <note><para> We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack. <code>RegisterInstance</code> handles only the second step. You should instead use the AWS CLI <code>register</code> command, which performs the entire registration operation. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register.html"> Registering an Instance with an AWS OpsWorks Stacks Stack</a>. </para></note><para> Registered instances have the same requirements as instances that are created by using the <a>CreateInstance</a> API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register-registering-preparer.html"> Preparing the Instance</a>. </para><para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.InstanceIdentity_Document"> <summary> <para> <para>A JSON document that contains the metadata.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.Hostname"> <summary> <para> <para>The instance's hostname.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.PrivateIp"> <summary> <para> <para>The instance's private IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.PublicIp"> <summary> <para> <para>The instance's public IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.RsaPublicKey"> <summary> <para> <para>The instances public RSA key. This key is used to encrypt communication between the instance and the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.RsaPublicKeyFingerprint"> <summary> <para> <para>The instances public RSA key fingerprint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.InstanceIdentity_Signature"> <summary> <para> <para>A signature that can be used to verify the document's accuracy and authenticity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.StackId"> <summary> <para> <para>The ID of the stack that the instance is to be registered with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.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.OPS.RegisterOPSInstanceAssignmentCmdlet"> <summary> Assign a registered instance to a layer. <ul><li><para> You can assign registered on-premises instances to any layer type. </para></li><li><para> You can assign registered Amazon EC2 instances only to custom layers. </para></li><li><para> You cannot use this action with instances that were created with AWS OpsWorks Stacks. </para></li></ul><para><b>Required Permissions</b>: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceAssignmentCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceAssignmentCmdlet.LayerId"> <summary> <para> <para>The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceAssignmentCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceAssignmentCmdlet.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.OPS.RegisterOPSRdsDbInstanceCmdlet"> <summary> Registers an Amazon RDS instance with a stack. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSRdsDbInstanceCmdlet.DbPassword"> <summary> <para> <para>The database password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSRdsDbInstanceCmdlet.DbUser"> <summary> <para> <para>The database's master user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSRdsDbInstanceCmdlet.RdsDbInstanceArn"> <summary> <para> <para>The Amazon RDS instance's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSRdsDbInstanceCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSRdsDbInstanceCmdlet.PassThru"> <summary> Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSRdsDbInstanceCmdlet.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.OPS.RegisterOPSVolumeCmdlet"> <summary> Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling <a>DeregisterVolume</a>. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSVolumeCmdlet.Ec2VolumeId"> <summary> <para> <para>The Amazon EBS volume ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSVolumeCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSVolumeCmdlet.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.OPS.RemoveOPSAppCmdlet"> <summary> Deletes a specified app. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSAppCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSAppCmdlet.PassThru"> <summary> Returns the value passed to the AppId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSAppCmdlet.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.OPS.RemoveOPSElasticIpCmdlet"> <summary> Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSElasticIpCmdlet.ElasticIp"> <summary> <para> <para>The Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSElasticIpCmdlet.PassThru"> <summary> Returns the value passed to the ElasticIp parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSElasticIpCmdlet.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.OPS.RemoveOPSInstanceCmdlet"> <summary> Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it. <para> For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html">Deleting Instances</a>. </para><para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSInstanceCmdlet.DeleteElasticIp"> <summary> <para> <para>Whether to delete the instance Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSInstanceCmdlet.DeleteVolume"> <summary> <para> <para>Whether to delete the instance's Amazon EBS volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSInstanceCmdlet.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.OPS.RemoveOPSLayerCmdlet"> <summary> Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-delete.html">How to Delete a Layer</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSLayerCmdlet.LayerId"> <summary> <para> <para>The layer ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSLayerCmdlet.PassThru"> <summary> Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSLayerCmdlet.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.OPS.RemoveOPSResourceTagCmdlet"> <summary> Removes tags from a specified stack or layer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The stack or layer's Amazon Resource Number (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of the keys of tags to be removed from a stack or layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSResourceTagCmdlet.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.OPS.RemoveOPSStackCmdlet"> <summary> Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-shutting.html">Shut Down a Stack</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSStackCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSStackCmdlet.PassThru"> <summary> Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSStackCmdlet.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.OPS.RemoveOPSUserProfileCmdlet"> <summary> Deletes a user profile. <para><b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSUserProfileCmdlet.IamUserArn"> <summary> <para> <para>The user's IAM ARN. This can also be a federated user's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSUserProfileCmdlet.PassThru"> <summary> Returns the value passed to the IamUserArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSUserProfileCmdlet.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.OPS.RemoveOPSVolumeCmdlet"> <summary> Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSVolumeCmdlet.VolumeId"> <summary> <para> <para>The volume ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSVolumeCmdlet.PassThru"> <summary> Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSVolumeCmdlet.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.OPS.RestartOPSInstanceCmdlet"> <summary> Reboots a specified instance. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RestartOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RestartOPSInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RestartOPSInstanceCmdlet.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.OPS.SetOPSLoadBasedAutoScalingCmdlet"> <summary> Specify the load-based auto scaling configuration for a specified layer. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html">Managing Load with Time-based and Load-based Instances</a>. <note><para> To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_Alarm"> <summary> <para> <para>Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.</para><note><para>To use custom alarms, you must update your service role to allow <code>cloudwatch:DescribeAlarms</code>. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html">Allowing AWS OpsWorks Stacks to Act on Your Behalf</a>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_Alarm"> <summary> <para> <para>Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.</para><note><para>To use custom alarms, you must update your service role to allow <code>cloudwatch:DescribeAlarms</code>. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html">Allowing AWS OpsWorks Stacks to Act on Your Behalf</a>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_CpuThreshold"> <summary> <para> <para>The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_CpuThreshold"> <summary> <para> <para>The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.Enable"> <summary> <para> <para>Enables load-based auto scaling for the layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_IgnoreMetricsTime"> <summary> <para> <para>The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. <code>IgnoreMetricsTime</code> allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_IgnoreMetricsTime"> <summary> <para> <para>The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. <code>IgnoreMetricsTime</code> allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_InstanceCount"> <summary> <para> <para>The number of instances to add or remove when the load exceeds a threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_InstanceCount"> <summary> <para> <para>The number of instances to add or remove when the load exceeds a threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.LayerId"> <summary> <para> <para>The layer ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_LoadThreshold"> <summary> <para> <para>The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see <a href="http://en.wikipedia.org/wiki/Load_%28computing%29">Load (computing)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_LoadThreshold"> <summary> <para> <para>The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see <a href="http://en.wikipedia.org/wiki/Load_%28computing%29">Load (computing)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_MemoryThreshold"> <summary> <para> <para>The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_MemoryThreshold"> <summary> <para> <para>The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_ThresholdsWaitTime"> <summary> <para> <para>The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_ThresholdsWaitTime"> <summary> <para> <para>The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.PassThru"> <summary> Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.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.OPS.SetOPSPermissionCmdlet"> <summary> Specifies a user's permissions. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingsecurity.html">Security and Permissions</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.AllowSsh"> <summary> <para> <para>The user is allowed to use SSH to communicate with the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.AllowSudo"> <summary> <para> <para>The user is allowed to use <b>sudo</b> to elevate privileges.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.IamUserArn"> <summary> <para> <para>The user's IAM ARN. This can also be a federated user's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.Level"> <summary> <para> <para>The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.</para><ul><li><para><code>deny</code></para></li><li><para><code>show</code></para></li><li><para><code>deploy</code></para></li><li><para><code>manage</code></para></li><li><para><code>iam_only</code></para></li></ul><para>For more information about the permissions associated with these levels, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.PassThru"> <summary> Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.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.OPS.SetOPSTimeBasedAutoScalingCmdlet"> <summary> Specify the time-based auto scaling configuration for a specified instance. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html">Managing Load with Time-based and Load-based Instances</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Friday"> <summary> <para> <para>The schedule for Friday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Monday"> <summary> <para> <para>The schedule for Monday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Saturday"> <summary> <para> <para>The schedule for Saturday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Sunday"> <summary> <para> <para>The schedule for Sunday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Thursday"> <summary> <para> <para>The schedule for Thursday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Tuesday"> <summary> <para> <para>The schedule for Tuesday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Wednesday"> <summary> <para> <para>The schedule for Wednesday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.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.OPS.StartOPSInstanceCmdlet"> <summary> Starts a specified instance. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StartOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StartOPSInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StartOPSInstanceCmdlet.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.OPS.StartOPSStackCmdlet"> <summary> Starts a stack's instances. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StartOPSStackCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StartOPSStackCmdlet.PassThru"> <summary> Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StartOPSStackCmdlet.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.OPS.StopOPSInstanceCmdlet"> <summary> Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSInstanceCmdlet.StopWithForce"> <summary> <para> <para>Specifies whether to force an instance to stop. If the instance's root device type is <code>ebs</code>, or EBS-backed, adding the <code>Force</code> parameter to the <code>StopInstances</code> API call disassociates the AWS OpsWorks Stacks instance from EC2, and forces deletion of <i>only</i> the OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks instance with a new one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSInstanceCmdlet.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.OPS.StopOPSStackCmdlet"> <summary> Stops a specified stack. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSStackCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSStackCmdlet.PassThru"> <summary> Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSStackCmdlet.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.OPS.UnregisterOPSEcsClusterCmdlet"> <summary> Deregisters a specified Amazon ECS cluster from a stack. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html#workinglayers-ecscluster-delete"> Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSEcsClusterCmdlet.EcsClusterArn"> <summary> <para> <para>The cluster's Amazon Resource Number (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSEcsClusterCmdlet.PassThru"> <summary> Returns the value passed to the EcsClusterArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSEcsClusterCmdlet.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.OPS.UnregisterOPSElasticIpCmdlet"> <summary> Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSElasticIpCmdlet.ElasticIp"> <summary> <para> <para>The Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSElasticIpCmdlet.PassThru"> <summary> Returns the value passed to the ElasticIp parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSElasticIpCmdlet.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.OPS.UnregisterOPSInstanceCmdlet"> <summary> Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action cannot be used with instances that were created with AWS OpsWorks Stacks. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSInstanceCmdlet.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.OPS.UnregisterOPSInstanceAssignmentCmdlet"> <summary> Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSInstanceAssignmentCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSInstanceAssignmentCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSInstanceAssignmentCmdlet.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.OPS.UnregisterOPSRdsDbInstanceCmdlet"> <summary> Deregisters an Amazon RDS instance. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSRdsDbInstanceCmdlet.RdsDbInstanceArn"> <summary> <para> <para>The Amazon RDS instance's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSRdsDbInstanceCmdlet.PassThru"> <summary> Returns the value passed to the RdsDbInstanceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSRdsDbInstanceCmdlet.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.OPS.UnregisterOPSVolumeCmdlet"> <summary> Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSVolumeCmdlet.VolumeId"> <summary> <para> <para>The AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSVolumeCmdlet.PassThru"> <summary> Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSVolumeCmdlet.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.OPS.UpdateOPSAppCmdlet"> <summary> Updates a specified app. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.Attribute"> <summary> <para> <para>One or more user-defined key/value pairs to be added to the stack attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.SslConfiguration_Certificate"> <summary> <para> <para>The contents of the certificate's domain.crt file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.SslConfiguration_Chain"> <summary> <para> <para>Optional. Can be used to specify an intermediate certificate authority key or client authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.DataSource"> <summary> <para> <para>The app's data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.Description"> <summary> <para> <para>A description of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.Domain"> <summary> <para> <para>The app's virtual host settings, with multiple domains separated by commas. For example: <code>'www.example.com, example.com'</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.EnableSsl"> <summary> <para> <para>Whether SSL is enabled for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.Environment"> <summary> <para> <para>An array of <code>EnvironmentVariable</code> objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment"> Environment Variables</a>.</para><para>There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20 KB)."</para><note><para>If you have specified one or more environment variables, you cannot modify the stack's Chef version.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.Name"> <summary> <para> <para>The app name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppSource_Password"> <summary> <para> <para>When included in a request, the parameter depends on the repository type.</para><ul><li><para>For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key.</para></li><li><para>For HTTP bundles and Subversion repositories, set <code>Password</code> to the password.</para></li></ul><para>For more information on how to safely handle IAM credentials, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>.</para><para>In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.SslConfiguration_PrivateKey"> <summary> <para> <para>The private key; the contents of the certificate's domain.kex file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppSource_Revision"> <summary> <para> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppSource_SshKey"> <summary> <para> <para>In requests, the repository's SSH key.</para><para>In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppSource_Type"> <summary> <para> <para>The repository type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.Type"> <summary> <para> <para>The app type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppSource_Url"> <summary> <para> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppSource_Username"> <summary> <para> <para>This parameter depends on the repository type.</para><ul><li><para>For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID.</para></li><li><para>For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.PassThru"> <summary> Returns the value passed to the AppId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.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.OPS.UpdateOPSElasticIpCmdlet"> <summary> Updates a registered Elastic IP address's name. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSElasticIpCmdlet.ElasticIp"> <summary> <para> <para>The IP address for which you want to update the name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSElasticIpCmdlet.Name"> <summary> <para> <para>The new name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSElasticIpCmdlet.PassThru"> <summary> Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSElasticIpCmdlet.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.OPS.UpdateOPSInstanceCmdlet"> <summary> Updates a specified instance. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.AgentVersion"> <summary> <para> <para>The default AWS OpsWorks Stacks agent version. You have the following options:</para><ul><li><para><code>INHERIT</code> - Use the stack's default agent version setting.</para></li><li><para><i>version_number</i> - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.</para></li></ul><para>The default setting is <code>INHERIT</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>.</para><para>AgentVersion cannot be set to Chef 12.2.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.AmiId"> <summary> <para> <para>The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.Architecture"> <summary> <para> <para>The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.AutoScalingType"> <summary> <para> <para>For load-based or time-based instances, the type. Windows stacks can use only time-based instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.EbsOptimized"> <summary> <para> <para>This property cannot be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.Hostname"> <summary> <para> <para>The instance host name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.InstallUpdatesOnBoot"> <summary> <para> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. </para><note><para>We strongly recommend using the default value of <code>true</code>, to ensure that your instances have the latest security updates.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.InstanceType"> <summary> <para> <para>The instance type, such as <code>t2.micro</code>. For a list of supported instance types, open the stack in the console, choose <b>Instances</b>, and choose <b>+ Instance</b>. The <b>Size</b> list contains the currently supported types. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. The parameter values that you use to specify the various types are in the <b>API Name</b> column of the <b>Available Instance Types</b> table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.LayerId"> <summary> <para> <para>The instance's layer IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.Os"> <summary> <para> <para>The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.</para><ul><li><para>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2018.03</code>, <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</para></li><li><para>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</para></li><li><para><code>CentOS Linux 7</code></para></li><li><para><code>Red Hat Enterprise Linux 7</code></para></li><li><para>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</para></li></ul><para>For more information about supported operating systems, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>.</para><para>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information about supported operating systems, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating Systems</a>. For more information about how to use custom AMIs with OpsWorks, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</para><note><para>You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.SshKeyName"> <summary> <para> <para>The instance's Amazon EC2 key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.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.OPS.UpdateOPSLayerCmdlet"> <summary> Updates a specified layer. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.Attribute"> <summary> <para> <para>One or more user-defined key/value pairs to be added to the stack attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.AutoAssignElasticIp"> <summary> <para> <para>Whether to automatically assign an <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP address</a> to the layer's instances. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.AutoAssignPublicIp"> <summary> <para> <para>For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomRecipes_Configure"> <summary> <para> <para>An array of custom recipe names to be run following a <code>configure</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomInstanceProfileArn"> <summary> <para> <para>The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomJson"> <summary> <para> <para>A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html"> Using Custom JSON</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomSecurityGroupId"> <summary> <para> <para>An array containing the layer's custom security group IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.Shutdown_DelayUntilElbConnectionsDrained"> <summary> <para> <para>Whether to enable Elastic Load Balancing connection draining. For more information, see <a href="https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain">Connection Draining</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomRecipes_Deploy"> <summary> <para> <para>An array of custom recipe names to be run following a <code>deploy</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.EnableAutoHealing"> <summary> <para> <para>Whether to disable auto healing for the layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CloudWatchLogsConfiguration_Enabled"> <summary> <para> <para>Whether CloudWatch Logs is enabled for a layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.Shutdown_ExecutionTimeout"> <summary> <para> <para>The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.InstallUpdatesOnBoot"> <summary> <para> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. </para><note><para>We strongly recommend using the default value of <code>true</code>, to ensure that your instances have the latest security updates.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.LayerId"> <summary> <para> <para>The layer ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CloudWatchLogsConfiguration_LogStream"> <summary> <para> <para>A list of configuration options for CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.Name"> <summary> <para> <para>The layer name, which is used by the console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.Package"> <summary> <para> <para>An array of <code>Package</code> objects that describe the layer's packages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomRecipes_Setup"> <summary> <para> <para>An array of custom recipe names to be run following a <code>setup</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.Shortname"> <summary> <para> <para>For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.</para><para>The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html">Layer Reference</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomRecipes_Shutdown"> <summary> <para> <para>An array of custom recipe names to be run following a <code>shutdown</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomRecipes_Undeploy"> <summary> <para> <para>An array of custom recipe names to be run following a <code>undeploy</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.UseEbsOptimizedInstance"> <summary> <para> <para>Whether to use Amazon EBS-optimized instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.VolumeConfiguration"> <summary> <para> <para>A <code>VolumeConfigurations</code> object that describes the layer's Amazon EBS volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.PassThru"> <summary> Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.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.OPS.UpdateOPSMyUserProfileCmdlet"> <summary> Updates a user's SSH public key. <para><b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSMyUserProfileCmdlet.SshPublicKey"> <summary> <para> <para>The user's SSH public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSMyUserProfileCmdlet.PassThru"> <summary> Returns the value passed to the SshPublicKey parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSMyUserProfileCmdlet.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.OPS.UpdateOPSRdsDbInstanceCmdlet"> <summary> Updates an Amazon RDS instance. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSRdsDbInstanceCmdlet.DbPassword"> <summary> <para> <para>The database password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSRdsDbInstanceCmdlet.DbUser"> <summary> <para> <para>The master user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSRdsDbInstanceCmdlet.RdsDbInstanceArn"> <summary> <para> <para>The Amazon RDS instance's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSRdsDbInstanceCmdlet.PassThru"> <summary> Returns the value passed to the RdsDbInstanceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSRdsDbInstanceCmdlet.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.OPS.UpdateOPSStackCmdlet"> <summary> Updates a specified stack. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.AgentVersion"> <summary> <para> <para>The default AWS OpsWorks Stacks agent version. You have the following options:</para><ul><li><para>Auto-update - Set this parameter to <code>LATEST</code>. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.</para></li><li><para>Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.</para></li></ul><para>The default setting is <code>LATEST</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2.</para><note><para>You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.Attribute"> <summary> <para> <para>One or more user-defined key-value pairs to be added to the stack attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.ChefConfiguration_BerkshelfVersion"> <summary> <para> <para>The Berkshelf version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomJson"> <summary> <para> <para>A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:</para><para><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></para><para>For more information about custom JSON, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.DefaultAvailabilityZone"> <summary> <para> <para>The stack's default Availability Zone, which must be in the stack's region. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. If you also specify a value for <code>DefaultSubnetId</code>, the subnet must be in the same zone. For more information, see <a>CreateStack</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.DefaultInstanceProfileArn"> <summary> <para> <para>The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.DefaultOs"> <summary> <para> <para>The stack's operating system, which must be set to one of the following:</para><ul><li><para>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2018.03</code>, <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</para></li><li><para>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</para></li><li><para><code>CentOS Linux 7</code></para></li><li><para><code>Red Hat Enterprise Linux 7</code></para></li><li><para>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</para></li><li><para>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</para></li></ul><para>The default option is the stack's current operating system. For more information about supported operating systems, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.DefaultRootDeviceType"> <summary> <para> <para>The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.DefaultSshKeyName"> <summary> <para> <para>A default Amazon EC2 key-pair name. The default value is <code>none</code>. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html"> Using SSH to Communicate with an Instance</a> and <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html"> Managing SSH Access</a>. You can override this setting by specifying a different key pair, or no key pair, when you <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> create an instance</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.DefaultSubnetId"> <summary> <para> <para>The stack's default VPC subnet ID. This parameter is required if you specify a value for the <code>VpcId</code> parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for <code>DefaultAvailabilityZone</code>, the subnet must be in that zone. For information on default values and when this parameter is required, see the <code>VpcId</code> parameter description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.HostnameTheme"> <summary> <para> <para>The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, <code>HostnameTheme</code> is set to <code>Layer_Dependent</code>, which creates host names by appending integers to the layer's short name. The other themes are:</para><ul><li><para><code>Baked_Goods</code></para></li><li><para><code>Clouds</code></para></li><li><para><code>Europe_Cities</code></para></li><li><para><code>Fruits</code></para></li><li><para><code>Greek_Deities_and_Titans</code></para></li><li><para><code>Legendary_creatures_from_Japan</code></para></li><li><para><code>Planets_and_Moons</code></para></li><li><para><code>Roman_Deities</code></para></li><li><para><code>Scottish_Islands</code></para></li><li><para><code>US_Cities</code></para></li><li><para><code>Wild_Cats</code></para></li></ul><para>To obtain a generated host name, call <code>GetHostNameSuggestion</code>, which returns a host name based on the current theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.ChefConfiguration_ManageBerkshelf"> <summary> <para> <para>Whether to enable Berkshelf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.ConfigurationManager_Name"> <summary> <para> <para>The name. This parameter must be set to "Chef".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.Name"> <summary> <para> <para>The stack's new name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomCookbooksSource_Password"> <summary> <para> <para>When included in a request, the parameter depends on the repository type.</para><ul><li><para>For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key.</para></li><li><para>For HTTP bundles and Subversion repositories, set <code>Password</code> to the password.</para></li></ul><para>For more information on how to safely handle IAM credentials, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>.</para><para>In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomCookbooksSource_Revision"> <summary> <para> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.ServiceRoleArn"> <summary> <para> <para>Do not use this parameter. You cannot update a stack's service role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomCookbooksSource_SshKey"> <summary> <para> <para>In requests, the repository's SSH key.</para><para>In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomCookbooksSource_Type"> <summary> <para> <para>The repository type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomCookbooksSource_Url"> <summary> <para> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.UseCustomCookbook"> <summary> <para> <para>Whether the stack uses custom cookbooks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.UseOpsworksSecurityGroup"> <summary> <para> <para>Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.</para><para>AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. <code>UseOpsworksSecurityGroups</code> allows you to provide your own custom security groups instead of using the built-in groups. <code>UseOpsworksSecurityGroups</code> has the following settings: </para><ul><li><para>True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.</para></li><li><para>False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html">Create a New Stack</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomCookbooksSource_Username"> <summary> <para> <para>This parameter depends on the repository type.</para><ul><li><para>For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID.</para></li><li><para>For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.ConfigurationManager_Version"> <summary> <para> <para>The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.PassThru"> <summary> Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.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.OPS.UpdateOPSUserProfileCmdlet"> <summary> Updates a specified user profile. <para><b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSUserProfileCmdlet.AllowSelfManagement"> <summary> <para> <para>Whether users can specify their own SSH public key through the My Settings page. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html">Managing User Permissions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSUserProfileCmdlet.IamUserArn"> <summary> <para> <para>The user IAM ARN. This can also be a federated user's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSUserProfileCmdlet.SshPublicKey"> <summary> <para> <para>The user's new SSH public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSUserProfileCmdlet.SshUsername"> <summary> <para> <para>The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, <code>my.name</code> will be changed to <code>myname</code>. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSUserProfileCmdlet.PassThru"> <summary> Returns the value passed to the IamUserArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSUserProfileCmdlet.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.OPS.UpdateOPSVolumeCmdlet"> <summary> Updates an Amazon EBS volume's name or mount point. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSVolumeCmdlet.MountPoint"> <summary> <para> <para>The new mount point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSVolumeCmdlet.Name"> <summary> <para> <para>The new name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSVolumeCmdlet.VolumeId"> <summary> <para> <para>The volume ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSVolumeCmdlet.PassThru"> <summary> Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSVolumeCmdlet.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> |