Amazonka.OpsWorks.UpdateLayer

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.

Creating a Request

data UpdateLayer

See: newUpdateLayer smart constructor.

Constructors

UpdateLayer'

Fields

• attributes :: Maybe (HashMap LayerAttributesKeys (Maybe Text))

  One or more user-defined key/value pairs to be added to the stack attributes.

• autoAssignElasticIps :: Maybe Bool

  Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

• autoAssignPublicIps :: Maybe Bool

  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.

• cloudWatchLogsConfiguration :: Maybe CloudWatchLogsConfiguration

  Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

• customInstanceProfileArn :: Maybe Text

  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.

• customJson :: Maybe Text

  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.

• customRecipes :: Maybe Recipes

  A LayerCustomRecipes object that specifies the layer's custom recipes.

• customSecurityGroupIds :: Maybe [Text]

  An array containing the layer's custom security group IDs.

• enableAutoHealing :: Maybe Bool

  Whether to disable auto healing for the layer.

• installUpdatesOnBoot :: Maybe Bool

  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.

• lifecycleEventConfiguration :: Maybe LifecycleEventConfiguration
• name :: Maybe Text

  The layer name, which is used by the console.

• packages :: Maybe [Text]

  An array of Package objects that describe the layer's packages.

• shortname :: Maybe Text

  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

• useEbsOptimizedInstances :: Maybe Bool

  Whether to use Amazon EBS-optimized instances.

• volumeConfigurations :: Maybe [VolumeConfiguration]

  A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

• layerId :: Text

  The layer ID.

Instances

ToJSON UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

toJSON :: UpdateLayer -> Value

toEncoding :: UpdateLayer -> Encoding

toJSONList :: [UpdateLayer] -> Value

toEncodingList :: [UpdateLayer] -> Encoding

ToHeaders UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

toHeaders :: UpdateLayer -> [Header]

ToPath UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

toPath :: UpdateLayer -> ByteString

ToQuery UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

toQuery :: UpdateLayer -> QueryString

AWSRequest UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

Associated Types

type AWSResponse UpdateLayer

Methods

request :: (Service -> Service) -> UpdateLayer -> Request UpdateLayer

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateLayer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateLayer)))

Generic UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

Associated Types

type Rep UpdateLayer :: Type -> Type

Methods

from :: UpdateLayer -> Rep UpdateLayer x

to :: Rep UpdateLayer x -> UpdateLayer

Read UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

readsPrec :: Int -> ReadS UpdateLayer

readList :: ReadS [UpdateLayer]

readPrec :: ReadPrec UpdateLayer

readListPrec :: ReadPrec [UpdateLayer]

Show UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

showsPrec :: Int -> UpdateLayer -> ShowS

show :: UpdateLayer -> String

showList :: [UpdateLayer] -> ShowS

NFData UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

rnf :: UpdateLayer -> ()

Eq UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

(==) :: UpdateLayer -> UpdateLayer -> Bool

(/=) :: UpdateLayer -> UpdateLayer -> Bool

Hashable UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

hashWithSalt :: Int -> UpdateLayer -> Int

hash :: UpdateLayer -> Int

type AWSResponse UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

type AWSResponse UpdateLayer = UpdateLayerResponse

type Rep UpdateLayer

Defined in Amazonka.OpsWorks.UpdateLayer

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

newUpdateLayer

Arguments

:: Text

UpdateLayer

-> UpdateLayer

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:

UpdateLayer, updateLayer_attributes - One or more user-defined key/value pairs to be added to the stack attributes.

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.

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.

UpdateLayer, updateLayer_cloudWatchLogsConfiguration - Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

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.

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.

UpdateLayer, updateLayer_customRecipes - A LayerCustomRecipes object that specifies the layer's custom recipes.

UpdateLayer, updateLayer_customSecurityGroupIds - An array containing the layer's custom security group IDs.

UpdateLayer, updateLayer_enableAutoHealing - Whether to disable auto healing for the layer.

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.

UpdateLayer, updateLayer_lifecycleEventConfiguration -

UpdateLayer, updateLayer_name - The layer name, which is used by the console.

UpdateLayer, updateLayer_packages - An array of Package objects that describe the layer's packages.

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

UpdateLayer, updateLayer_useEbsOptimizedInstances - Whether to use Amazon EBS-optimized instances.

UpdateLayer, updateLayer_volumeConfigurations - A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

UpdateLayer, updateLayer_layerId - The layer ID.

Request Lenses

updateLayer_attributes :: Lens' UpdateLayer (Maybe (HashMap LayerAttributesKeys (Maybe Text)))

One or more user-defined key/value pairs to be added to the stack attributes.

updateLayer_autoAssignElasticIps :: Lens' UpdateLayer (Maybe Bool)

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

updateLayer_autoAssignPublicIps :: Lens' UpdateLayer (Maybe Bool)

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_cloudWatchLogsConfiguration :: Lens' UpdateLayer (Maybe CloudWatchLogsConfiguration)

Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

updateLayer_customInstanceProfileArn :: Lens' UpdateLayer (Maybe Text)

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_customJson :: Lens' UpdateLayer (Maybe Text)

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_customRecipes :: Lens' UpdateLayer (Maybe Recipes)

A LayerCustomRecipes object that specifies the layer's custom recipes.

updateLayer_customSecurityGroupIds :: Lens' UpdateLayer (Maybe [Text])

An array containing the layer's custom security group IDs.

updateLayer_enableAutoHealing :: Lens' UpdateLayer (Maybe Bool)

Whether to disable auto healing for the layer.

updateLayer_installUpdatesOnBoot :: Lens' UpdateLayer (Maybe Bool)

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_lifecycleEventConfiguration :: Lens' UpdateLayer (Maybe LifecycleEventConfiguration)

updateLayer_name :: Lens' UpdateLayer (Maybe Text)

The layer name, which is used by the console.

updateLayer_packages :: Lens' UpdateLayer (Maybe [Text])

An array of Package objects that describe the layer's packages.

updateLayer_shortname :: Lens' UpdateLayer (Maybe Text)

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_useEbsOptimizedInstances :: Lens' UpdateLayer (Maybe Bool)

Whether to use Amazon EBS-optimized instances.

updateLayer_volumeConfigurations :: Lens' UpdateLayer (Maybe [VolumeConfiguration])

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

updateLayer_layerId :: Lens' UpdateLayer Text

The layer ID.

Destructuring the Response

data UpdateLayerResponse

See: newUpdateLayerResponse smart constructor.

Constructors

UpdateLayerResponse'

Instances

Generic UpdateLayerResponse

Defined in Amazonka.OpsWorks.UpdateLayer

Associated Types

type Rep UpdateLayerResponse :: Type -> Type

Methods

from :: UpdateLayerResponse -> Rep UpdateLayerResponse x

to :: Rep UpdateLayerResponse x -> UpdateLayerResponse

Read UpdateLayerResponse

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

readsPrec :: Int -> ReadS UpdateLayerResponse

readList :: ReadS [UpdateLayerResponse]

readPrec :: ReadPrec UpdateLayerResponse

readListPrec :: ReadPrec [UpdateLayerResponse]

Show UpdateLayerResponse

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

showsPrec :: Int -> UpdateLayerResponse -> ShowS

show :: UpdateLayerResponse -> String

showList :: [UpdateLayerResponse] -> ShowS

NFData UpdateLayerResponse

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

rnf :: UpdateLayerResponse -> ()

Eq UpdateLayerResponse

Defined in Amazonka.OpsWorks.UpdateLayer

Methods

(==) :: UpdateLayerResponse -> UpdateLayerResponse -> Bool

(/=) :: UpdateLayerResponse -> UpdateLayerResponse -> Bool

type Rep UpdateLayerResponse

Defined in Amazonka.OpsWorks.UpdateLayer

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

newUpdateLayerResponse :: UpdateLayerResponse

Create a value of UpdateLayerResponse with all optional fields omitted.

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