amazonka-opsworks-1.4.5: Amazon OpsWorks SDK.

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

Network.AWS.OpsWorks.CreateLayer

Contents

Description

Creates a layer. For more information, see How to Create a 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

createLayer #

Creates a value of CreateLayer with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • clCustomInstanceProfileARN - The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers .
  • clCustomSecurityGroupIds - An array containing the layer custom security group IDs.
  • clInstallUpdatesOnBoot - 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 by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
  • clLifecycleEventConfiguration - A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
  • clCustomRecipes - A LayerCustomRecipes object that specifies the layer custom recipes.
  • clCustomJSON - 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 . This feature is supported as of version 1.7.42 of the AWS CLI.
  • clVolumeConfigurations - A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
  • clEnableAutoHealing - Whether to disable auto healing for the layer.
  • clPackages - An array of Package objects that describes the layer packages.
  • clAttributes - One or more user-defined key-value pairs to be added to the stack attributes. To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.
  • clAutoAssignPublicIPs - 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 .
  • clUseEBSOptimizedInstances - Whether to use Amazon EBS-optimized instances.
  • clAutoAssignElasticIPs - Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer .
  • clStackId - The layer stack ID.
  • clType - 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.
  • clName - The layer name, which is used by the console.
  • clShortname - For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks 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 .. The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference .

data CreateLayer #

See: createLayer smart constructor.

Instances

Eq CreateLayer # 
Data CreateLayer # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateLayer -> c CreateLayer #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateLayer #

toConstr :: CreateLayer -> Constr #

dataTypeOf :: CreateLayer -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateLayer) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateLayer) #

gmapT :: (forall b. Data b => b -> b) -> CreateLayer -> CreateLayer #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateLayer -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateLayer -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateLayer -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateLayer -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateLayer -> m CreateLayer #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateLayer -> m CreateLayer #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateLayer -> m CreateLayer #

Read CreateLayer # 
Show CreateLayer # 
Generic CreateLayer # 

Associated Types

type Rep CreateLayer :: * -> * #

Hashable CreateLayer # 
ToJSON CreateLayer # 
NFData CreateLayer # 

Methods

rnf :: CreateLayer -> () #

AWSRequest CreateLayer # 
ToQuery CreateLayer # 
ToPath CreateLayer # 
ToHeaders CreateLayer # 

Methods

toHeaders :: CreateLayer -> [Header] #

type Rep CreateLayer # 
type Rep CreateLayer = D1 (MetaData "CreateLayer" "Network.AWS.OpsWorks.CreateLayer" "amazonka-opsworks-1.4.5-JiFrWEFhyqOE1ZKfkjkheh" False) (C1 (MetaCons "CreateLayer'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_clCustomInstanceProfileARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_clCustomSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_clInstallUpdatesOnBoot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_clLifecycleEventConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LifecycleEventConfiguration))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_clCustomRecipes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Recipes))) (S1 (MetaSel (Just Symbol "_clCustomJSON") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_clVolumeConfigurations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [VolumeConfiguration]))) (S1 (MetaSel (Just Symbol "_clEnableAutoHealing") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_clPackages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_clAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map LayerAttributesKeys Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_clAutoAssignPublicIPs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_clUseEBSOptimizedInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_clAutoAssignElasticIPs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_clStackId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_clType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LayerType)) ((:*:) (S1 (MetaSel (Just Symbol "_clName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_clShortname") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))))
type Rs CreateLayer # 

Request Lenses

clCustomInstanceProfileARN :: Lens' CreateLayer (Maybe Text) #

The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers .

clCustomSecurityGroupIds :: Lens' CreateLayer [Text] #

An array containing the layer custom security group IDs.

clInstallUpdatesOnBoot :: Lens' CreateLayer (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 by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

clLifecycleEventConfiguration :: Lens' CreateLayer (Maybe LifecycleEventConfiguration) #

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

clCustomRecipes :: Lens' CreateLayer (Maybe Recipes) #

A LayerCustomRecipes object that specifies the layer custom recipes.

clCustomJSON :: Lens' CreateLayer (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 . This feature is supported as of version 1.7.42 of the AWS CLI.

clVolumeConfigurations :: Lens' CreateLayer [VolumeConfiguration] #

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

clEnableAutoHealing :: Lens' CreateLayer (Maybe Bool) #

Whether to disable auto healing for the layer.

clPackages :: Lens' CreateLayer [Text] #

An array of Package objects that describes the layer packages.

clAttributes :: Lens' CreateLayer (HashMap LayerAttributesKeys Text) #

One or more user-defined key-value pairs to be added to the stack attributes. To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

clAutoAssignPublicIPs :: Lens' CreateLayer (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 .

clUseEBSOptimizedInstances :: Lens' CreateLayer (Maybe Bool) #

Whether to use Amazon EBS-optimized instances.

clAutoAssignElasticIPs :: Lens' CreateLayer (Maybe Bool) #

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

clStackId :: Lens' CreateLayer Text #

The layer stack ID.

clType :: Lens' CreateLayer LayerType #

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.

clName :: Lens' CreateLayer Text #

The layer name, which is used by the console.

clShortname :: Lens' CreateLayer Text #

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks 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 .. The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference .

Destructuring the Response

createLayerResponse #

Creates a value of CreateLayerResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreateLayerResponse #

Contains the response to a CreateLayer request.

See: createLayerResponse smart constructor.

Instances

Eq CreateLayerResponse # 
Data CreateLayerResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateLayerResponse -> c CreateLayerResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateLayerResponse #

toConstr :: CreateLayerResponse -> Constr #

dataTypeOf :: CreateLayerResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateLayerResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateLayerResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateLayerResponse -> CreateLayerResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateLayerResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateLayerResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateLayerResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateLayerResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateLayerResponse -> m CreateLayerResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateLayerResponse -> m CreateLayerResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateLayerResponse -> m CreateLayerResponse #

Read CreateLayerResponse # 
Show CreateLayerResponse # 
Generic CreateLayerResponse # 
NFData CreateLayerResponse # 

Methods

rnf :: CreateLayerResponse -> () #

type Rep CreateLayerResponse # 
type Rep CreateLayerResponse = D1 (MetaData "CreateLayerResponse" "Network.AWS.OpsWorks.CreateLayer" "amazonka-opsworks-1.4.5-JiFrWEFhyqOE1ZKfkjkheh" False) (C1 (MetaCons "CreateLayerResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_clrsLayerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_clrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

clrsResponseStatus :: Lens' CreateLayerResponse Int #

  • - | The response status code.