AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the UpdateLayer operation against AWS OpsWorks.

Syntax

Update-OPSLayer
-LayerId <String>
-Attribute <Hashtable>
-AutoAssignElasticIp <Boolean>
-AutoAssignPublicIp <Boolean>
-CustomRecipes_Configure <String[]>
-CustomInstanceProfileArn <String>
-CustomJson <String>
-CustomSecurityGroupId <String[]>
-Shutdown_DelayUntilElbConnectionsDrained <Boolean>
-CustomRecipes_Deploy <String[]>
-EnableAutoHealing <Boolean>
-CloudWatchLogsConfiguration_Enabled <Boolean>
-Shutdown_ExecutionTimeout <Int32>
-InstallUpdatesOnBoot <Boolean>
-CloudWatchLogsConfiguration_LogStream <CloudWatchLogsLogStream[]>
-Name <String>
-Package <String[]>
-CustomRecipes_Setup <String[]>
-Shortname <String>
-CustomRecipes_Shutdown <String[]>
-CustomRecipes_Undeploy <String[]>
-UseEbsOptimizedInstance <Boolean>
-VolumeConfiguration <VolumeConfiguration[]>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Updates a specified layer. Required Permissions: 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 Managing User Permissions.

Parameters

-Attribute <Hashtable>
One or more user-defined key/value pairs to be added to the stack attributes.
Required?False
Position?Named
Accept pipeline input?False
-AutoAssignElasticIp <Boolean>
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
Required?False
Position?Named
Accept pipeline input?False
-AutoAssignPublicIp <Boolean>
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 How to Edit a Layer.
Required?False
Position?Named
Accept pipeline input?False
-CloudWatchLogsConfiguration_Enabled <Boolean>
Whether CloudWatch Logs is enabled for a layer.
Required?False
Position?Named
Accept pipeline input?False
-CloudWatchLogsConfiguration_LogStream <CloudWatchLogsLogStream[]>
A list of configuration options for CloudWatch Logs.
Required?False
Position?Named
Accept pipeline input?False
-CustomInstanceProfileArn <String>
The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
Required?False
Position?Named
Accept pipeline input?False
-CustomJson <String>
A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON.
Required?False
Position?Named
Accept pipeline input?False
-CustomRecipes_Configure <String[]>
An array of custom recipe names to be run following a configure event.
Required?False
Position?Named
Accept pipeline input?False
-CustomRecipes_Deploy <String[]>
An array of custom recipe names to be run following a deploy event.
Required?False
Position?Named
Accept pipeline input?False
-CustomRecipes_Setup <String[]>
An array of custom recipe names to be run following a setup event.
Required?False
Position?Named
Accept pipeline input?False
-CustomRecipes_Shutdown <String[]>
An array of custom recipe names to be run following a shutdown event.
Required?False
Position?Named
Accept pipeline input?False
-CustomRecipes_Undeploy <String[]>
An array of custom recipe names to be run following a undeploy event.
Required?False
Position?Named
Accept pipeline input?False
-CustomSecurityGroupId <String[]>
An array containing the layer's custom security group IDs.
Required?False
Position?Named
Accept pipeline input?False
-EnableAutoHealing <Boolean>
Whether to disable auto healing for the layer.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-InstallUpdatesOnBoot <Boolean>
Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
Required?False
Position?Named
Accept pipeline input?False
-LayerId <String>
The layer ID.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Name <String>
The layer name, which is used by the console.
Required?False
Position?Named
Accept pipeline input?False
-Package <String[]>
An array of Package objects that describe the layer's packages.
Required?False
Position?Named
Accept pipeline input?False
-PassThru <SwitchParameter>
Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output.
Required?False
Position?Named
Accept pipeline input?False
-Shortname <String>
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/.The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference
Required?False
Position?Named
Accept pipeline input?False
-Shutdown_DelayUntilElbConnectionsDrained <Boolean>
Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
Required?False
Position?Named
Accept pipeline input?False
-Shutdown_ExecutionTimeout <Int32>
The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.
Required?False
Position?Named
Accept pipeline input?False
-UseEbsOptimizedInstance <Boolean>
Whether to use Amazon EBS-optimized instances.
Required?False
Position?Named
Accept pipeline input?False
-VolumeConfiguration <VolumeConfiguration[]>
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the LayerId parameter.

Outputs

None or System.String
When you use the PassThru parameter, this cmdlet outputs the value supplied to the LayerId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UpdateLayerResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z