Network.AWS.OpsWorks.CreateLayer

Creates a layer. For more information, see How to Create a Layer.

You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.

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.

See: AWS API Reference for CreateLayer.

Creating a Request

createLayer

Arguments

:: Text

clStackId

-> LayerType

clType

-> Text

clName

-> Text

clShortname

-> 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
• clCustomSecurityGroupIds
• clInstallUpdatesOnBoot
• clLifecycleEventConfiguration
• clCustomRecipes
• clCustomJSON
• clVolumeConfigurations
• clEnableAutoHealing
• clPackages
• clAttributes
• clAutoAssignPublicIPs
• clUseEBSOptimizedInstances
• clAutoAssignElasticIPs
• clStackId
• clType
• clName
• clShortname

data CreateLayer

See: createLayer smart constructor.

Instances

Eq CreateLayer

Data CreateLayer

Read CreateLayer

Show CreateLayer

Generic CreateLayer

ToJSON CreateLayer

AWSRequest CreateLayer

ToPath CreateLayer

ToHeaders CreateLayer

ToQuery CreateLayer

type Rep CreateLayer

type Rs CreateLayer = CreateLayerResponse

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.

To ensure that your instances have the latest security updates, we strongly recommend using the default value of true.

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.

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.

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

Arguments

:: Int

clrsResponseStatus

-> 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:

• clrsLayerId
• clrsResponseStatus

data CreateLayerResponse

Contains the response to a CreateLayer request.

See: createLayerResponse smart constructor.

Instances

Eq CreateLayerResponse

Data CreateLayerResponse

Read CreateLayerResponse

Show CreateLayerResponse

Generic CreateLayerResponse

type Rep CreateLayerResponse

Response Lenses

clrsLayerId :: Lens' CreateLayerResponse (Maybe Text)

The layer ID.

clrsResponseStatus :: Lens' CreateLayerResponse Int

The response status code.