Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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.
Synopsis
- data UpdateLayer = UpdateLayer' {
- customInstanceProfileArn :: Maybe Text
- customSecurityGroupIds :: Maybe [Text]
- installUpdatesOnBoot :: Maybe Bool
- cloudWatchLogsConfiguration :: Maybe CloudWatchLogsConfiguration
- lifecycleEventConfiguration :: Maybe LifecycleEventConfiguration
- shortname :: Maybe Text
- customRecipes :: Maybe Recipes
- customJson :: Maybe Text
- volumeConfigurations :: Maybe [VolumeConfiguration]
- enableAutoHealing :: Maybe Bool
- packages :: Maybe [Text]
- attributes :: Maybe (HashMap LayerAttributesKeys (Maybe Text))
- name :: Maybe Text
- autoAssignPublicIps :: Maybe Bool
- useEbsOptimizedInstances :: Maybe Bool
- autoAssignElasticIps :: Maybe Bool
- layerId :: Text
- newUpdateLayer :: Text -> UpdateLayer
- updateLayer_customInstanceProfileArn :: Lens' UpdateLayer (Maybe Text)
- updateLayer_customSecurityGroupIds :: Lens' UpdateLayer (Maybe [Text])
- updateLayer_installUpdatesOnBoot :: Lens' UpdateLayer (Maybe Bool)
- updateLayer_cloudWatchLogsConfiguration :: Lens' UpdateLayer (Maybe CloudWatchLogsConfiguration)
- updateLayer_lifecycleEventConfiguration :: Lens' UpdateLayer (Maybe LifecycleEventConfiguration)
- updateLayer_shortname :: Lens' UpdateLayer (Maybe Text)
- updateLayer_customRecipes :: Lens' UpdateLayer (Maybe Recipes)
- updateLayer_customJson :: Lens' UpdateLayer (Maybe Text)
- updateLayer_volumeConfigurations :: Lens' UpdateLayer (Maybe [VolumeConfiguration])
- updateLayer_enableAutoHealing :: Lens' UpdateLayer (Maybe Bool)
- updateLayer_packages :: Lens' UpdateLayer (Maybe [Text])
- updateLayer_attributes :: Lens' UpdateLayer (Maybe (HashMap LayerAttributesKeys (Maybe Text)))
- updateLayer_name :: Lens' UpdateLayer (Maybe Text)
- updateLayer_autoAssignPublicIps :: Lens' UpdateLayer (Maybe Bool)
- updateLayer_useEbsOptimizedInstances :: Lens' UpdateLayer (Maybe Bool)
- updateLayer_autoAssignElasticIps :: Lens' UpdateLayer (Maybe Bool)
- updateLayer_layerId :: Lens' UpdateLayer Text
- data UpdateLayerResponse = UpdateLayerResponse' {
- newUpdateLayerResponse :: UpdateLayerResponse
Creating a Request
data UpdateLayer Source #
See: newUpdateLayer
smart constructor.
UpdateLayer' | |
|
Instances
Create a value of UpdateLayer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customInstanceProfileArn:UpdateLayer'
, updateLayer_customInstanceProfileArn
- 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.
$sel:customSecurityGroupIds:UpdateLayer'
, updateLayer_customSecurityGroupIds
- An array containing the layer's custom security group IDs.
$sel:installUpdatesOnBoot:UpdateLayer'
, updateLayer_installUpdatesOnBoot
- 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.
$sel:cloudWatchLogsConfiguration:UpdateLayer'
, updateLayer_cloudWatchLogsConfiguration
- Specifies CloudWatch Logs configuration options for the layer. For more
information, see CloudWatchLogsLogStream.
$sel:lifecycleEventConfiguration:UpdateLayer'
, updateLayer_lifecycleEventConfiguration
-
$sel:shortname:UpdateLayer'
, updateLayer_shortname
- 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
$sel:customRecipes:UpdateLayer'
, updateLayer_customRecipes
- A LayerCustomRecipes
object that specifies the layer's custom
recipes.
$sel:customJson:UpdateLayer'
, updateLayer_customJson
- 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.
$sel:volumeConfigurations:UpdateLayer'
, updateLayer_volumeConfigurations
- A VolumeConfigurations
object that describes the layer's Amazon EBS
volumes.
$sel:enableAutoHealing:UpdateLayer'
, updateLayer_enableAutoHealing
- Whether to disable auto healing for the layer.
$sel:packages:UpdateLayer'
, updateLayer_packages
- An array of Package
objects that describe the layer's packages.
$sel:attributes:UpdateLayer'
, updateLayer_attributes
- One or more user-defined key/value pairs to be added to the stack
attributes.
$sel:name:UpdateLayer'
, updateLayer_name
- The layer name, which is used by the console.
$sel:autoAssignPublicIps:UpdateLayer'
, updateLayer_autoAssignPublicIps
- 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.
$sel:useEbsOptimizedInstances:UpdateLayer'
, updateLayer_useEbsOptimizedInstances
- Whether to use Amazon EBS-optimized instances.
$sel:autoAssignElasticIps:UpdateLayer'
, updateLayer_autoAssignElasticIps
- Whether to automatically assign an
Elastic IP address
to the layer's instances. For more information, see
How to Edit a Layer.
$sel:layerId:UpdateLayer'
, updateLayer_layerId
- The layer ID.
Request Lenses
updateLayer_customInstanceProfileArn :: Lens' UpdateLayer (Maybe Text) Source #
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.
updateLayer_customSecurityGroupIds :: Lens' UpdateLayer (Maybe [Text]) Source #
An array containing the layer's custom security group IDs.
updateLayer_installUpdatesOnBoot :: Lens' UpdateLayer (Maybe Bool) Source #
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.
updateLayer_cloudWatchLogsConfiguration :: Lens' UpdateLayer (Maybe CloudWatchLogsConfiguration) Source #
Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.
updateLayer_lifecycleEventConfiguration :: Lens' UpdateLayer (Maybe LifecycleEventConfiguration) Source #
updateLayer_shortname :: Lens' UpdateLayer (Maybe Text) Source #
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
updateLayer_customRecipes :: Lens' UpdateLayer (Maybe Recipes) Source #
A LayerCustomRecipes
object that specifies the layer's custom
recipes.
updateLayer_customJson :: Lens' UpdateLayer (Maybe Text) Source #
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.
updateLayer_volumeConfigurations :: Lens' UpdateLayer (Maybe [VolumeConfiguration]) Source #
A VolumeConfigurations
object that describes the layer's Amazon EBS
volumes.
updateLayer_enableAutoHealing :: Lens' UpdateLayer (Maybe Bool) Source #
Whether to disable auto healing for the layer.
updateLayer_packages :: Lens' UpdateLayer (Maybe [Text]) Source #
An array of Package
objects that describe the layer's packages.
updateLayer_attributes :: Lens' UpdateLayer (Maybe (HashMap LayerAttributesKeys (Maybe Text))) Source #
One or more user-defined key/value pairs to be added to the stack attributes.
updateLayer_name :: Lens' UpdateLayer (Maybe Text) Source #
The layer name, which is used by the console.
updateLayer_autoAssignPublicIps :: Lens' UpdateLayer (Maybe Bool) Source #
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.
updateLayer_useEbsOptimizedInstances :: Lens' UpdateLayer (Maybe Bool) Source #
Whether to use Amazon EBS-optimized instances.
updateLayer_autoAssignElasticIps :: Lens' UpdateLayer (Maybe Bool) Source #
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
updateLayer_layerId :: Lens' UpdateLayer Text Source #
The layer ID.
Destructuring the Response
data UpdateLayerResponse Source #
See: newUpdateLayerResponse
smart constructor.
Instances
Eq UpdateLayerResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateLayer (==) :: UpdateLayerResponse -> UpdateLayerResponse -> Bool # (/=) :: UpdateLayerResponse -> UpdateLayerResponse -> Bool # | |
Read UpdateLayerResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateLayer | |
Show UpdateLayerResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateLayer showsPrec :: Int -> UpdateLayerResponse -> ShowS # show :: UpdateLayerResponse -> String # showList :: [UpdateLayerResponse] -> ShowS # | |
Generic UpdateLayerResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateLayer type Rep UpdateLayerResponse :: Type -> Type # from :: UpdateLayerResponse -> Rep UpdateLayerResponse x # to :: Rep UpdateLayerResponse x -> UpdateLayerResponse # | |
NFData UpdateLayerResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateLayer rnf :: UpdateLayerResponse -> () # | |
type Rep UpdateLayerResponse Source # | |
newUpdateLayerResponse :: UpdateLayerResponse Source #
Create a value of UpdateLayerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.