libZSservicesZSamazonka-opsworksZSamazonka-opsworks
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.OpsWorks.UpdateLayer

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.

Synopsis

Creating a Request

data UpdateLayer Source #

See: newUpdateLayer smart constructor.

Constructors

UpdateLayer' 

Fields

Instances

Instances details
Eq UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

Read UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

Show UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

Generic UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

Associated Types

type Rep UpdateLayer :: Type -> Type #

NFData UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

rnf :: UpdateLayer -> () #

Hashable UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

ToJSON UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

AWSRequest UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

Associated Types

type AWSResponse UpdateLayer #

ToHeaders UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

toHeaders :: UpdateLayer -> [Header] #

ToPath UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

ToQuery UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

type Rep UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

type Rep UpdateLayer = D1 ('MetaData "UpdateLayer" "Amazonka.OpsWorks.UpdateLayer" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" 'False) (C1 ('MetaCons "UpdateLayer'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "customInstanceProfileArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "installUpdatesOnBoot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "cloudWatchLogsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLogsConfiguration)))) :*: ((S1 ('MetaSel ('Just "lifecycleEventConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LifecycleEventConfiguration)) :*: S1 ('MetaSel ('Just "shortname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "customRecipes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Recipes)) :*: S1 ('MetaSel ('Just "customJson") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "volumeConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VolumeConfiguration])) :*: S1 ('MetaSel ('Just "enableAutoHealing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "packages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap LayerAttributesKeys (Maybe Text)))))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "autoAssignPublicIps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "useEbsOptimizedInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "autoAssignElasticIps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "layerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))
type AWSResponse UpdateLayer Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

newUpdateLayer Source #

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_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.

Destructuring the Response

data UpdateLayerResponse Source #

See: newUpdateLayerResponse smart constructor.

Constructors

UpdateLayerResponse' 

Instances

Instances details
Eq UpdateLayerResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

Read UpdateLayerResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

Show UpdateLayerResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

Generic UpdateLayerResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

Associated Types

type Rep UpdateLayerResponse :: Type -> Type #

NFData UpdateLayerResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

rnf :: UpdateLayerResponse -> () #

type Rep UpdateLayerResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.UpdateLayer

type Rep UpdateLayerResponse = D1 ('MetaData "UpdateLayerResponse" "Amazonka.OpsWorks.UpdateLayer" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" 'False) (C1 ('MetaCons "UpdateLayerResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateLayerResponse :: UpdateLayerResponse Source #

Create a value of UpdateLayerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.